2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
143 /* One of the exclusions is NULL, fail. */
144 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
148 if (key
->exclusion
&& event
->exclusion
) {
149 /* Both exclusions exists, check count followed by the names. */
150 if (event
->exclusion
->count
!= key
->exclusion
->count
||
151 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
152 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
166 * Unique add of an ust app event in the given ht. This uses the custom
167 * ht_match_ust_app_event match function and the event name as hash.
169 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
170 struct ust_app_event
*event
)
172 struct cds_lfht_node
*node_ptr
;
173 struct ust_app_ht_key key
;
177 assert(ua_chan
->events
);
180 ht
= ua_chan
->events
;
181 key
.name
= event
->attr
.name
;
182 key
.filter
= event
->filter
;
183 key
.loglevel
= event
->attr
.loglevel
;
185 node_ptr
= cds_lfht_add_unique(ht
->ht
,
186 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
187 ht_match_ust_app_event
, &key
, &event
->node
.node
);
188 assert(node_ptr
== &event
->node
.node
);
192 * Close the notify socket from the given RCU head object. This MUST be called
193 * through a call_rcu().
195 static void close_notify_sock_rcu(struct rcu_head
*head
)
198 struct ust_app_notify_sock_obj
*obj
=
199 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
201 /* Must have a valid fd here. */
202 assert(obj
->fd
>= 0);
204 ret
= close(obj
->fd
);
206 ERR("close notify sock %d RCU", obj
->fd
);
208 lttng_fd_put(LTTNG_FD_APPS
, 1);
214 * Return the session registry according to the buffer type of the given
217 * A registry per UID object MUST exists before calling this function or else
218 * it assert() if not found. RCU read side lock must be acquired.
220 static struct ust_registry_session
*get_session_registry(
221 struct ust_app_session
*ua_sess
)
223 struct ust_registry_session
*registry
= NULL
;
227 switch (ua_sess
->buffer_type
) {
228 case LTTNG_BUFFER_PER_PID
:
230 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
234 registry
= reg_pid
->registry
->reg
.ust
;
237 case LTTNG_BUFFER_PER_UID
:
239 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
240 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
244 registry
= reg_uid
->registry
->reg
.ust
;
256 * Delete ust context safely. RCU read lock must be held before calling
260 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
267 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
268 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
269 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
270 sock
, ua_ctx
->obj
->handle
, ret
);
278 * Delete ust app event safely. RCU read lock must be held before calling
282 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
288 free(ua_event
->filter
);
290 if (ua_event
->obj
!= NULL
) {
291 ret
= ustctl_release_object(sock
, ua_event
->obj
);
292 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
293 ERR("UST app sock %d release event obj failed with ret %d",
302 * Release ust data object of the given stream.
304 * Return 0 on success or else a negative value.
306 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
313 ret
= ustctl_release_object(sock
, stream
->obj
);
314 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
315 ERR("UST app sock %d release stream obj failed with ret %d",
318 lttng_fd_put(LTTNG_FD_APPS
, 2);
326 * Delete ust app stream safely. RCU read lock must be held before calling
330 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
334 (void) release_ust_app_stream(sock
, stream
);
339 * We need to execute ht_destroy outside of RCU read-side critical
340 * section and outside of call_rcu thread, so we postpone its execution
341 * using ht_cleanup_push. It is simpler than to change the semantic of
342 * the many callers of delete_ust_app_session().
345 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
347 struct ust_app_channel
*ua_chan
=
348 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
350 ht_cleanup_push(ua_chan
->ctx
);
351 ht_cleanup_push(ua_chan
->events
);
356 * Delete ust app channel safely. RCU read lock must be held before calling
360 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
364 struct lttng_ht_iter iter
;
365 struct ust_app_event
*ua_event
;
366 struct ust_app_ctx
*ua_ctx
;
367 struct ust_app_stream
*stream
, *stmp
;
368 struct ust_registry_session
*registry
;
372 DBG3("UST app deleting channel %s", ua_chan
->name
);
375 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
376 cds_list_del(&stream
->list
);
377 delete_ust_app_stream(sock
, stream
);
381 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
382 cds_list_del(&ua_ctx
->list
);
383 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
385 delete_ust_app_ctx(sock
, ua_ctx
);
389 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
391 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
393 delete_ust_app_event(sock
, ua_event
);
396 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
397 /* Wipe and free registry from session registry. */
398 registry
= get_session_registry(ua_chan
->session
);
400 ust_registry_channel_del_free(registry
, ua_chan
->key
);
404 if (ua_chan
->obj
!= NULL
) {
405 /* Remove channel from application UST object descriptor. */
406 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
407 lttng_ht_del(app
->ust_objd
, &iter
);
408 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
409 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
410 ERR("UST app sock %d release channel obj failed with ret %d",
413 lttng_fd_put(LTTNG_FD_APPS
, 1);
416 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
420 * Push metadata to consumer socket.
422 * The socket lock MUST be acquired.
423 * The ust app session lock MUST be acquired.
425 * On success, return the len of metadata pushed or else a negative value.
427 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
428 struct consumer_socket
*socket
, int send_zero_data
)
431 char *metadata_str
= NULL
;
439 * On a push metadata error either the consumer is dead or the metadata
440 * channel has been destroyed because its endpoint might have died (e.g:
441 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
442 * metadata again which is not valid anymore on the consumer side.
444 * The ust app session mutex locked allows us to make this check without
447 if (registry
->metadata_closed
) {
451 pthread_mutex_lock(®istry
->lock
);
453 offset
= registry
->metadata_len_sent
;
454 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
456 DBG3("No metadata to push for metadata key %" PRIu64
,
457 registry
->metadata_key
);
459 if (send_zero_data
) {
460 DBG("No metadata to push");
466 /* Allocate only what we have to send. */
467 metadata_str
= zmalloc(len
);
469 PERROR("zmalloc ust app metadata string");
473 /* Copy what we haven't send out. */
474 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
475 registry
->metadata_len_sent
+= len
;
478 pthread_mutex_unlock(®istry
->lock
);
479 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
480 metadata_str
, len
, offset
);
491 pthread_mutex_unlock(®istry
->lock
);
498 * For a given application and session, push metadata to consumer. The session
499 * lock MUST be acquired here before calling this.
500 * Either sock or consumer is required : if sock is NULL, the default
501 * socket to send the metadata is retrieved from consumer, if sock
502 * is not NULL we use it to send the metadata.
504 * Return 0 on success else a negative error.
506 static int push_metadata(struct ust_registry_session
*registry
,
507 struct consumer_output
*consumer
)
511 struct consumer_socket
*socket
;
519 * Means that no metadata was assigned to the session. This can happens if
520 * no start has been done previously.
522 if (!registry
->metadata_key
) {
527 /* Get consumer socket to use to push the metadata.*/
528 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
532 goto error_rcu_unlock
;
536 * TODO: Currently, we hold the socket lock around sampling of the next
537 * metadata segment to ensure we send metadata over the consumer socket in
538 * the correct order. This makes the registry lock nest inside the socket
541 * Please note that this is a temporary measure: we should move this lock
542 * back into ust_consumer_push_metadata() when the consumer gets the
543 * ability to reorder the metadata it receives.
545 pthread_mutex_lock(socket
->lock
);
546 ret
= ust_app_push_metadata(registry
, socket
, 0);
547 pthread_mutex_unlock(socket
->lock
);
550 goto error_rcu_unlock
;
558 * On error, flag the registry that the metadata is closed. We were unable
559 * to push anything and this means that either the consumer is not
560 * responding or the metadata cache has been destroyed on the consumer.
562 registry
->metadata_closed
= 1;
569 * Send to the consumer a close metadata command for the given session. Once
570 * done, the metadata channel is deleted and the session metadata pointer is
571 * nullified. The session lock MUST be acquired here unless the application is
572 * in the destroy path.
574 * Return 0 on success else a negative value.
576 static int close_metadata(struct ust_registry_session
*registry
,
577 struct consumer_output
*consumer
)
580 struct consumer_socket
*socket
;
587 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
592 /* Get consumer socket to use to push the metadata.*/
593 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
600 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
607 * Metadata closed. Even on error this means that the consumer is not
608 * responding or not found so either way a second close should NOT be emit
611 registry
->metadata_closed
= 1;
618 * We need to execute ht_destroy outside of RCU read-side critical
619 * section and outside of call_rcu thread, so we postpone its execution
620 * using ht_cleanup_push. It is simpler than to change the semantic of
621 * the many callers of delete_ust_app_session().
624 void delete_ust_app_session_rcu(struct rcu_head
*head
)
626 struct ust_app_session
*ua_sess
=
627 caa_container_of(head
, struct ust_app_session
, rcu_head
);
629 ht_cleanup_push(ua_sess
->channels
);
634 * Delete ust app session safely. RCU read lock must be held before calling
638 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
642 struct lttng_ht_iter iter
;
643 struct ust_app_channel
*ua_chan
;
644 struct ust_registry_session
*registry
;
648 pthread_mutex_lock(&ua_sess
->lock
);
650 registry
= get_session_registry(ua_sess
);
651 if (registry
&& !registry
->metadata_closed
) {
652 /* Push metadata for application before freeing the application. */
653 (void) push_metadata(registry
, ua_sess
->consumer
);
656 * Don't ask to close metadata for global per UID buffers. Close
657 * metadata only on destroy trace session in this case. Also, the
658 * previous push metadata could have flag the metadata registry to
659 * close so don't send a close command if closed.
661 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
662 !registry
->metadata_closed
) {
663 /* And ask to close it for this session registry. */
664 (void) close_metadata(registry
, ua_sess
->consumer
);
668 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
670 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
672 delete_ust_app_channel(sock
, ua_chan
, app
);
675 /* In case of per PID, the registry is kept in the session. */
676 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
677 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
679 buffer_reg_pid_remove(reg_pid
);
680 buffer_reg_pid_destroy(reg_pid
);
684 if (ua_sess
->handle
!= -1) {
685 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
686 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
687 ERR("UST app sock %d release session handle failed with ret %d",
691 pthread_mutex_unlock(&ua_sess
->lock
);
693 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
697 * Delete a traceable application structure from the global list. Never call
698 * this function outside of a call_rcu call.
700 * RCU read side lock should _NOT_ be held when calling this function.
703 void delete_ust_app(struct ust_app
*app
)
706 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
708 /* Delete ust app sessions info */
713 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
715 /* Free every object in the session and the session. */
717 delete_ust_app_session(sock
, ua_sess
, app
);
721 ht_cleanup_push(app
->sessions
);
722 ht_cleanup_push(app
->ust_objd
);
725 * Wait until we have deleted the application from the sock hash table
726 * before closing this socket, otherwise an application could re-use the
727 * socket ID and race with the teardown, using the same hash table entry.
729 * It's OK to leave the close in call_rcu. We want it to stay unique for
730 * all RCU readers that could run concurrently with unregister app,
731 * therefore we _need_ to only close that socket after a grace period. So
732 * it should stay in this RCU callback.
734 * This close() is a very important step of the synchronization model so
735 * every modification to this function must be carefully reviewed.
741 lttng_fd_put(LTTNG_FD_APPS
, 1);
743 DBG2("UST app pid %d deleted", app
->pid
);
748 * URCU intermediate call to delete an UST app.
751 void delete_ust_app_rcu(struct rcu_head
*head
)
753 struct lttng_ht_node_ulong
*node
=
754 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
755 struct ust_app
*app
=
756 caa_container_of(node
, struct ust_app
, pid_n
);
758 DBG3("Call RCU deleting app PID %d", app
->pid
);
763 * Delete the session from the application ht and delete the data structure by
764 * freeing every object inside and releasing them.
766 static void destroy_app_session(struct ust_app
*app
,
767 struct ust_app_session
*ua_sess
)
770 struct lttng_ht_iter iter
;
775 iter
.iter
.node
= &ua_sess
->node
.node
;
776 ret
= lttng_ht_del(app
->sessions
, &iter
);
778 /* Already scheduled for teardown. */
782 /* Once deleted, free the data structure. */
783 delete_ust_app_session(app
->sock
, ua_sess
, app
);
790 * Alloc new UST app session.
793 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
795 struct ust_app_session
*ua_sess
;
797 /* Init most of the default value by allocating and zeroing */
798 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
799 if (ua_sess
== NULL
) {
804 ua_sess
->handle
= -1;
805 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
806 pthread_mutex_init(&ua_sess
->lock
, NULL
);
815 * Alloc new UST app channel.
818 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
819 struct ust_app_session
*ua_sess
,
820 struct lttng_ust_channel_attr
*attr
)
822 struct ust_app_channel
*ua_chan
;
824 /* Init most of the default value by allocating and zeroing */
825 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
826 if (ua_chan
== NULL
) {
831 /* Setup channel name */
832 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
833 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
835 ua_chan
->enabled
= 1;
836 ua_chan
->handle
= -1;
837 ua_chan
->session
= ua_sess
;
838 ua_chan
->key
= get_next_channel_key();
839 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
840 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
841 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
843 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
844 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
846 /* Copy attributes */
848 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
849 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
850 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
851 ua_chan
->attr
.overwrite
= attr
->overwrite
;
852 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
853 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
854 ua_chan
->attr
.output
= attr
->output
;
856 /* By default, the channel is a per cpu channel. */
857 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
859 DBG3("UST app channel %s allocated", ua_chan
->name
);
868 * Allocate and initialize a UST app stream.
870 * Return newly allocated stream pointer or NULL on error.
872 struct ust_app_stream
*ust_app_alloc_stream(void)
874 struct ust_app_stream
*stream
= NULL
;
876 stream
= zmalloc(sizeof(*stream
));
877 if (stream
== NULL
) {
878 PERROR("zmalloc ust app stream");
882 /* Zero could be a valid value for a handle so flag it to -1. */
890 * Alloc new UST app event.
893 struct ust_app_event
*alloc_ust_app_event(char *name
,
894 struct lttng_ust_event
*attr
)
896 struct ust_app_event
*ua_event
;
898 /* Init most of the default value by allocating and zeroing */
899 ua_event
= zmalloc(sizeof(struct ust_app_event
));
900 if (ua_event
== NULL
) {
905 ua_event
->enabled
= 1;
906 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
907 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
908 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
910 /* Copy attributes */
912 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
915 DBG3("UST app event %s allocated", ua_event
->name
);
924 * Alloc new UST app context.
927 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
929 struct ust_app_ctx
*ua_ctx
;
931 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
932 if (ua_ctx
== NULL
) {
936 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
939 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
942 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
949 * Allocate a filter and copy the given original filter.
951 * Return allocated filter or NULL on error.
953 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
954 struct lttng_ust_filter_bytecode
*orig_f
)
956 struct lttng_ust_filter_bytecode
*filter
= NULL
;
958 /* Copy filter bytecode */
959 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
961 PERROR("zmalloc alloc ust app filter");
965 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
972 * Find an ust_app using the sock and return it. RCU read side lock must be
973 * held before calling this helper function.
975 struct ust_app
*ust_app_find_by_sock(int sock
)
977 struct lttng_ht_node_ulong
*node
;
978 struct lttng_ht_iter iter
;
980 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
981 node
= lttng_ht_iter_get_node_ulong(&iter
);
983 DBG2("UST app find by sock %d not found", sock
);
987 return caa_container_of(node
, struct ust_app
, sock_n
);
994 * Find an ust_app using the notify sock and return it. RCU read side lock must
995 * be held before calling this helper function.
997 static struct ust_app
*find_app_by_notify_sock(int sock
)
999 struct lttng_ht_node_ulong
*node
;
1000 struct lttng_ht_iter iter
;
1002 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1004 node
= lttng_ht_iter_get_node_ulong(&iter
);
1006 DBG2("UST app find by notify sock %d not found", sock
);
1010 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1017 * Lookup for an ust app event based on event name, filter bytecode and the
1020 * Return an ust_app_event object or NULL on error.
1022 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1023 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1025 struct lttng_ht_iter iter
;
1026 struct lttng_ht_node_str
*node
;
1027 struct ust_app_event
*event
= NULL
;
1028 struct ust_app_ht_key key
;
1033 /* Setup key for event lookup. */
1035 key
.filter
= filter
;
1036 key
.loglevel
= loglevel
;
1038 /* Lookup using the event name as hash and a custom match fct. */
1039 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1040 ht_match_ust_app_event
, &key
, &iter
.iter
);
1041 node
= lttng_ht_iter_get_node_str(&iter
);
1046 event
= caa_container_of(node
, struct ust_app_event
, node
);
1053 * Create the channel context on the tracer.
1055 * Called with UST app session lock held.
1058 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1059 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1063 health_code_update();
1065 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1066 ua_chan
->obj
, &ua_ctx
->obj
);
1068 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1069 ERR("UST app create channel context failed for app (pid: %d) "
1070 "with ret %d", app
->pid
, ret
);
1073 * This is normal behavior, an application can die during the
1074 * creation process. Don't report an error so the execution can
1075 * continue normally.
1078 DBG3("UST app disable event failed. Application is dead.");
1083 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1085 DBG2("UST app context handle %d created successfully for channel %s",
1086 ua_ctx
->handle
, ua_chan
->name
);
1089 health_code_update();
1094 * Set the filter on the tracer.
1097 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1098 struct ust_app
*app
)
1102 health_code_update();
1104 if (!ua_event
->filter
) {
1109 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1112 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1113 ERR("UST app event %s filter failed for app (pid: %d) "
1114 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1117 * This is normal behavior, an application can die during the
1118 * creation process. Don't report an error so the execution can
1119 * continue normally.
1122 DBG3("UST app filter event failed. Application is dead.");
1127 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1130 health_code_update();
1135 * Disable the specified event on to UST tracer for the UST session.
1137 static int disable_ust_event(struct ust_app
*app
,
1138 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1142 health_code_update();
1144 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1146 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1147 ERR("UST app event %s disable failed for app (pid: %d) "
1148 "and session handle %d with ret %d",
1149 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1152 * This is normal behavior, an application can die during the
1153 * creation process. Don't report an error so the execution can
1154 * continue normally.
1157 DBG3("UST app disable event failed. Application is dead.");
1162 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1163 ua_event
->attr
.name
, app
->pid
);
1166 health_code_update();
1171 * Disable the specified channel on to UST tracer for the UST session.
1173 static int disable_ust_channel(struct ust_app
*app
,
1174 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1178 health_code_update();
1180 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1182 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1183 ERR("UST app channel %s disable failed for app (pid: %d) "
1184 "and session handle %d with ret %d",
1185 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1188 * This is normal behavior, an application can die during the
1189 * creation process. Don't report an error so the execution can
1190 * continue normally.
1193 DBG3("UST app disable channel failed. Application is dead.");
1198 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1199 ua_chan
->name
, app
->pid
);
1202 health_code_update();
1207 * Enable the specified channel on to UST tracer for the UST session.
1209 static int enable_ust_channel(struct ust_app
*app
,
1210 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1214 health_code_update();
1216 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1218 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1219 ERR("UST app channel %s enable failed for app (pid: %d) "
1220 "and session handle %d with ret %d",
1221 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1224 * This is normal behavior, an application can die during the
1225 * creation process. Don't report an error so the execution can
1226 * continue normally.
1229 DBG3("UST app enable channel failed. Application is dead.");
1234 ua_chan
->enabled
= 1;
1236 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1237 ua_chan
->name
, app
->pid
);
1240 health_code_update();
1245 * Enable the specified event on to UST tracer for the UST session.
1247 static int enable_ust_event(struct ust_app
*app
,
1248 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1252 health_code_update();
1254 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1256 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1257 ERR("UST app event %s enable failed for app (pid: %d) "
1258 "and session handle %d with ret %d",
1259 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1262 * This is normal behavior, an application can die during the
1263 * creation process. Don't report an error so the execution can
1264 * continue normally.
1267 DBG3("UST app enable event failed. Application is dead.");
1272 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1273 ua_event
->attr
.name
, app
->pid
);
1276 health_code_update();
1281 * Send channel and stream buffer to application.
1283 * Return 0 on success. On error, a negative value is returned.
1285 static int send_channel_pid_to_ust(struct ust_app
*app
,
1286 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1289 struct ust_app_stream
*stream
, *stmp
;
1295 health_code_update();
1297 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1300 /* Send channel to the application. */
1301 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1306 health_code_update();
1308 /* Send all streams to application. */
1309 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1310 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1314 /* We don't need the stream anymore once sent to the tracer. */
1315 cds_list_del(&stream
->list
);
1316 delete_ust_app_stream(-1, stream
);
1318 /* Flag the channel that it is sent to the application. */
1319 ua_chan
->is_sent
= 1;
1322 health_code_update();
1327 * Create the specified event onto the UST tracer for a UST session.
1329 * Should be called with session mutex held.
1332 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1333 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1337 health_code_update();
1339 /* Create UST event on tracer */
1340 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1343 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1344 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1345 ua_event
->attr
.name
, app
->pid
, ret
);
1348 * This is normal behavior, an application can die during the
1349 * creation process. Don't report an error so the execution can
1350 * continue normally.
1353 DBG3("UST app create event failed. Application is dead.");
1358 ua_event
->handle
= ua_event
->obj
->handle
;
1360 DBG2("UST app event %s created successfully for pid:%d",
1361 ua_event
->attr
.name
, app
->pid
);
1363 health_code_update();
1365 /* Set filter if one is present. */
1366 if (ua_event
->filter
) {
1367 ret
= set_ust_event_filter(ua_event
, app
);
1373 /* If event not enabled, disable it on the tracer */
1374 if (ua_event
->enabled
== 0) {
1375 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1378 * If we hit an EPERM, something is wrong with our disable call. If
1379 * we get an EEXIST, there is a problem on the tracer side since we
1383 case -LTTNG_UST_ERR_PERM
:
1384 /* Code flow problem */
1386 case -LTTNG_UST_ERR_EXIST
:
1387 /* It's OK for our use case. */
1398 health_code_update();
1403 * Copy data between an UST app event and a LTT event.
1405 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1406 struct ltt_ust_event
*uevent
)
1408 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1409 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1411 ua_event
->enabled
= uevent
->enabled
;
1413 /* Copy event attributes */
1414 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1416 /* Copy filter bytecode */
1417 if (uevent
->filter
) {
1418 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1419 /* Filter might be NULL here in case of ENONEM. */
1424 * Copy data between an UST app channel and a LTT channel.
1426 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1427 struct ltt_ust_channel
*uchan
)
1429 struct lttng_ht_iter iter
;
1430 struct ltt_ust_event
*uevent
;
1431 struct ltt_ust_context
*uctx
;
1432 struct ust_app_event
*ua_event
;
1433 struct ust_app_ctx
*ua_ctx
;
1435 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1437 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1438 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1440 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1441 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1443 /* Copy event attributes since the layout is different. */
1444 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1445 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1446 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1447 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1448 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1449 ua_chan
->attr
.output
= uchan
->attr
.output
;
1451 * Note that the attribute channel type is not set since the channel on the
1452 * tracing registry side does not have this information.
1455 ua_chan
->enabled
= uchan
->enabled
;
1456 ua_chan
->tracing_channel_id
= uchan
->id
;
1458 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1459 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1460 if (ua_ctx
== NULL
) {
1463 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1464 (unsigned long) ua_ctx
->ctx
.ctx
);
1465 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1466 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1469 /* Copy all events from ltt ust channel to ust app channel */
1470 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1471 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1472 uevent
->filter
, uevent
->attr
.loglevel
);
1473 if (ua_event
== NULL
) {
1474 DBG2("UST event %s not found on shadow copy channel",
1476 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1477 if (ua_event
== NULL
) {
1480 shadow_copy_event(ua_event
, uevent
);
1481 add_unique_ust_app_event(ua_chan
, ua_event
);
1485 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1489 * Copy data between a UST app session and a regular LTT session.
1491 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1492 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1494 struct lttng_ht_node_str
*ua_chan_node
;
1495 struct lttng_ht_iter iter
;
1496 struct ltt_ust_channel
*uchan
;
1497 struct ust_app_channel
*ua_chan
;
1499 struct tm
*timeinfo
;
1503 /* Get date and time for unique app path */
1505 timeinfo
= localtime(&rawtime
);
1506 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1508 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1510 ua_sess
->tracing_id
= usess
->id
;
1511 ua_sess
->id
= get_next_session_id();
1512 ua_sess
->uid
= app
->uid
;
1513 ua_sess
->gid
= app
->gid
;
1514 ua_sess
->euid
= usess
->uid
;
1515 ua_sess
->egid
= usess
->gid
;
1516 ua_sess
->buffer_type
= usess
->buffer_type
;
1517 ua_sess
->bits_per_long
= app
->bits_per_long
;
1518 /* There is only one consumer object per session possible. */
1519 ua_sess
->consumer
= usess
->consumer
;
1520 ua_sess
->output_traces
= usess
->output_traces
;
1521 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1523 switch (ua_sess
->buffer_type
) {
1524 case LTTNG_BUFFER_PER_PID
:
1525 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1526 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1529 case LTTNG_BUFFER_PER_UID
:
1530 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1531 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1538 PERROR("asprintf UST shadow copy session");
1543 /* Iterate over all channels in global domain. */
1544 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1546 struct lttng_ht_iter uiter
;
1548 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1549 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1550 if (ua_chan_node
!= NULL
) {
1551 /* Session exist. Contiuing. */
1555 DBG2("Channel %s not found on shadow session copy, creating it",
1557 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1558 if (ua_chan
== NULL
) {
1559 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1562 shadow_copy_channel(ua_chan
, uchan
);
1564 * The concept of metadata channel does not exist on the tracing
1565 * registry side of the session daemon so this can only be a per CPU
1566 * channel and not metadata.
1568 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1570 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1578 * Lookup sesison wrapper.
1581 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1582 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1584 /* Get right UST app session from app */
1585 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1589 * Return ust app session from the app session hashtable using the UST session
1592 static struct ust_app_session
*lookup_session_by_app(
1593 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1595 struct lttng_ht_iter iter
;
1596 struct lttng_ht_node_u64
*node
;
1598 __lookup_session_by_app(usess
, app
, &iter
);
1599 node
= lttng_ht_iter_get_node_u64(&iter
);
1604 return caa_container_of(node
, struct ust_app_session
, node
);
1611 * Setup buffer registry per PID for the given session and application. If none
1612 * is found, a new one is created, added to the global registry and
1613 * initialized. If regp is valid, it's set with the newly created object.
1615 * Return 0 on success or else a negative value.
1617 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1618 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1621 struct buffer_reg_pid
*reg_pid
;
1628 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1631 * This is the create channel path meaning that if there is NO
1632 * registry available, we have to create one for this session.
1634 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1638 buffer_reg_pid_add(reg_pid
);
1643 /* Initialize registry. */
1644 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1645 app
->bits_per_long
, app
->uint8_t_alignment
,
1646 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1647 app
->uint64_t_alignment
, app
->long_alignment
,
1648 app
->byte_order
, app
->version
.major
,
1649 app
->version
.minor
);
1654 DBG3("UST app buffer registry per PID created successfully");
1666 * Setup buffer registry per UID for the given session and application. If none
1667 * is found, a new one is created, added to the global registry and
1668 * initialized. If regp is valid, it's set with the newly created object.
1670 * Return 0 on success or else a negative value.
1672 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1673 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1676 struct buffer_reg_uid
*reg_uid
;
1683 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1686 * This is the create channel path meaning that if there is NO
1687 * registry available, we have to create one for this session.
1689 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1690 LTTNG_DOMAIN_UST
, ®_uid
);
1694 buffer_reg_uid_add(reg_uid
);
1699 /* Initialize registry. */
1700 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1701 app
->bits_per_long
, app
->uint8_t_alignment
,
1702 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1703 app
->uint64_t_alignment
, app
->long_alignment
,
1704 app
->byte_order
, app
->version
.major
,
1705 app
->version
.minor
);
1709 /* Add node to teardown list of the session. */
1710 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1712 DBG3("UST app buffer registry per UID created successfully");
1724 * Create a session on the tracer side for the given app.
1726 * On success, ua_sess_ptr is populated with the session pointer or else left
1727 * untouched. If the session was created, is_created is set to 1. On error,
1728 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1731 * Returns 0 on success or else a negative code which is either -ENOMEM or
1732 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1734 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1735 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1738 int ret
, created
= 0;
1739 struct ust_app_session
*ua_sess
;
1743 assert(ua_sess_ptr
);
1745 health_code_update();
1747 ua_sess
= lookup_session_by_app(usess
, app
);
1748 if (ua_sess
== NULL
) {
1749 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1750 app
->pid
, usess
->id
);
1751 ua_sess
= alloc_ust_app_session(app
);
1752 if (ua_sess
== NULL
) {
1753 /* Only malloc can failed so something is really wrong */
1757 shadow_copy_session(ua_sess
, usess
, app
);
1761 switch (usess
->buffer_type
) {
1762 case LTTNG_BUFFER_PER_PID
:
1763 /* Init local registry. */
1764 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1769 case LTTNG_BUFFER_PER_UID
:
1770 /* Look for a global registry. If none exists, create one. */
1771 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1782 health_code_update();
1784 if (ua_sess
->handle
== -1) {
1785 ret
= ustctl_create_session(app
->sock
);
1787 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1788 ERR("Creating session for app pid %d with ret %d",
1791 DBG("UST app creating session failed. Application is dead");
1793 * This is normal behavior, an application can die during the
1794 * creation process. Don't report an error so the execution can
1795 * continue normally. This will get flagged ENOTCONN and the
1796 * caller will handle it.
1800 delete_ust_app_session(-1, ua_sess
, app
);
1801 if (ret
!= -ENOMEM
) {
1803 * Tracer is probably gone or got an internal error so let's
1804 * behave like it will soon unregister or not usable.
1811 ua_sess
->handle
= ret
;
1813 /* Add ust app session to app's HT */
1814 lttng_ht_node_init_u64(&ua_sess
->node
,
1815 ua_sess
->tracing_id
);
1816 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1818 DBG2("UST app session created successfully with handle %d", ret
);
1821 *ua_sess_ptr
= ua_sess
;
1823 *is_created
= created
;
1826 /* Everything went well. */
1830 health_code_update();
1835 * Create a context for the channel on the tracer.
1837 * Called with UST app session lock held and a RCU read side lock.
1840 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1841 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1842 struct ust_app
*app
)
1845 struct lttng_ht_iter iter
;
1846 struct lttng_ht_node_ulong
*node
;
1847 struct ust_app_ctx
*ua_ctx
;
1849 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1851 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1852 node
= lttng_ht_iter_get_node_ulong(&iter
);
1858 ua_ctx
= alloc_ust_app_ctx(uctx
);
1859 if (ua_ctx
== NULL
) {
1865 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1866 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1867 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1869 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1879 * Enable on the tracer side a ust app event for the session and channel.
1881 * Called with UST app session lock held.
1884 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1885 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1889 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1894 ua_event
->enabled
= 1;
1901 * Disable on the tracer side a ust app event for the session and channel.
1903 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1904 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1908 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1913 ua_event
->enabled
= 0;
1920 * Lookup ust app channel for session and disable it on the tracer side.
1923 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1924 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1928 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1933 ua_chan
->enabled
= 0;
1940 * Lookup ust app channel for session and enable it on the tracer side. This
1941 * MUST be called with a RCU read side lock acquired.
1943 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1944 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1947 struct lttng_ht_iter iter
;
1948 struct lttng_ht_node_str
*ua_chan_node
;
1949 struct ust_app_channel
*ua_chan
;
1951 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1952 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1953 if (ua_chan_node
== NULL
) {
1954 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1955 uchan
->name
, ua_sess
->tracing_id
);
1959 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1961 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1971 * Ask the consumer to create a channel and get it if successful.
1973 * Return 0 on success or else a negative value.
1975 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1976 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1977 int bitness
, struct ust_registry_session
*registry
)
1980 unsigned int nb_fd
= 0;
1981 struct consumer_socket
*socket
;
1989 health_code_update();
1991 /* Get the right consumer socket for the application. */
1992 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1998 health_code_update();
2000 /* Need one fd for the channel. */
2001 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2003 ERR("Exhausted number of available FD upon create channel");
2008 * Ask consumer to create channel. The consumer will return the number of
2009 * stream we have to expect.
2011 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2018 * Compute the number of fd needed before receiving them. It must be 2 per
2019 * stream (2 being the default value here).
2021 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2023 /* Reserve the amount of file descriptor we need. */
2024 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2026 ERR("Exhausted number of available FD upon create channel");
2027 goto error_fd_get_stream
;
2030 health_code_update();
2033 * Now get the channel from the consumer. This call wil populate the stream
2034 * list of that channel and set the ust objects.
2036 if (usess
->consumer
->enabled
) {
2037 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2047 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2048 error_fd_get_stream
:
2050 * Initiate a destroy channel on the consumer since we had an error
2051 * handling it on our side. The return value is of no importance since we
2052 * already have a ret value set by the previous error that we need to
2055 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2057 lttng_fd_put(LTTNG_FD_APPS
, 1);
2059 health_code_update();
2065 * Duplicate the ust data object of the ust app stream and save it in the
2066 * buffer registry stream.
2068 * Return 0 on success or else a negative value.
2070 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2071 struct ust_app_stream
*stream
)
2078 /* Reserve the amount of file descriptor we need. */
2079 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2081 ERR("Exhausted number of available FD upon duplicate stream");
2085 /* Duplicate object for stream once the original is in the registry. */
2086 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2087 reg_stream
->obj
.ust
);
2089 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2090 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2091 lttng_fd_put(LTTNG_FD_APPS
, 2);
2094 stream
->handle
= stream
->obj
->handle
;
2101 * Duplicate the ust data object of the ust app. channel and save it in the
2102 * buffer registry channel.
2104 * Return 0 on success or else a negative value.
2106 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2107 struct ust_app_channel
*ua_chan
)
2114 /* Need two fds for the channel. */
2115 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2117 ERR("Exhausted number of available FD upon duplicate channel");
2121 /* Duplicate object for stream once the original is in the registry. */
2122 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2124 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2125 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2128 ua_chan
->handle
= ua_chan
->obj
->handle
;
2133 lttng_fd_put(LTTNG_FD_APPS
, 1);
2139 * For a given channel buffer registry, setup all streams of the given ust
2140 * application channel.
2142 * Return 0 on success or else a negative value.
2144 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2145 struct ust_app_channel
*ua_chan
)
2148 struct ust_app_stream
*stream
, *stmp
;
2153 DBG2("UST app setup buffer registry stream");
2155 /* Send all streams to application. */
2156 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2157 struct buffer_reg_stream
*reg_stream
;
2159 ret
= buffer_reg_stream_create(®_stream
);
2165 * Keep original pointer and nullify it in the stream so the delete
2166 * stream call does not release the object.
2168 reg_stream
->obj
.ust
= stream
->obj
;
2170 buffer_reg_stream_add(reg_stream
, reg_chan
);
2172 /* We don't need the streams anymore. */
2173 cds_list_del(&stream
->list
);
2174 delete_ust_app_stream(-1, stream
);
2182 * Create a buffer registry channel for the given session registry and
2183 * application channel object. If regp pointer is valid, it's set with the
2184 * created object. Important, the created object is NOT added to the session
2185 * registry hash table.
2187 * Return 0 on success else a negative value.
2189 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2190 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2193 struct buffer_reg_channel
*reg_chan
= NULL
;
2198 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2200 /* Create buffer registry channel. */
2201 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2206 reg_chan
->consumer_key
= ua_chan
->key
;
2207 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2209 /* Create and add a channel registry to session. */
2210 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2211 ua_chan
->tracing_channel_id
);
2215 buffer_reg_channel_add(reg_sess
, reg_chan
);
2224 /* Safe because the registry channel object was not added to any HT. */
2225 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2231 * Setup buffer registry channel for the given session registry and application
2232 * channel object. If regp pointer is valid, it's set with the created object.
2234 * Return 0 on success else a negative value.
2236 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2237 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2244 assert(ua_chan
->obj
);
2246 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2248 /* Setup all streams for the registry. */
2249 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2254 reg_chan
->obj
.ust
= ua_chan
->obj
;
2255 ua_chan
->obj
= NULL
;
2260 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2261 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2266 * Send buffer registry channel to the application.
2268 * Return 0 on success else a negative value.
2270 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2271 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2272 struct ust_app_channel
*ua_chan
)
2275 struct buffer_reg_stream
*reg_stream
;
2282 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2284 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2289 /* Send channel to the application. */
2290 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2295 health_code_update();
2297 /* Send all streams to application. */
2298 pthread_mutex_lock(®_chan
->stream_list_lock
);
2299 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2300 struct ust_app_stream stream
;
2302 ret
= duplicate_stream_object(reg_stream
, &stream
);
2304 goto error_stream_unlock
;
2307 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2309 (void) release_ust_app_stream(-1, &stream
);
2310 goto error_stream_unlock
;
2314 * The return value is not important here. This function will output an
2317 (void) release_ust_app_stream(-1, &stream
);
2319 ua_chan
->is_sent
= 1;
2321 error_stream_unlock
:
2322 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2328 * Create and send to the application the created buffers with per UID buffers.
2330 * Return 0 on success else a negative value.
2332 static int create_channel_per_uid(struct ust_app
*app
,
2333 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2334 struct ust_app_channel
*ua_chan
)
2337 struct buffer_reg_uid
*reg_uid
;
2338 struct buffer_reg_channel
*reg_chan
;
2345 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2347 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2349 * The session creation handles the creation of this global registry
2350 * object. If none can be find, there is a code flow problem or a
2355 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2358 /* Create the buffer registry channel object. */
2359 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2366 * Create the buffers on the consumer side. This call populates the
2367 * ust app channel object with all streams and data object.
2369 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2370 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2373 * Let's remove the previously created buffer registry channel so
2374 * it's not visible anymore in the session registry.
2376 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2377 ua_chan
->tracing_channel_id
);
2378 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2379 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2384 * Setup the streams and add it to the session registry.
2386 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2393 /* Send buffers to the application. */
2394 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2404 * Create and send to the application the created buffers with per PID buffers.
2406 * Return 0 on success else a negative value.
2408 static int create_channel_per_pid(struct ust_app
*app
,
2409 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2410 struct ust_app_channel
*ua_chan
)
2413 struct ust_registry_session
*registry
;
2420 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2424 registry
= get_session_registry(ua_sess
);
2427 /* Create and add a new channel registry to session. */
2428 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2433 /* Create and get channel on the consumer side. */
2434 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2435 app
->bits_per_long
, registry
);
2440 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2451 * From an already allocated ust app channel, create the channel buffers if
2452 * need and send it to the application. This MUST be called with a RCU read
2453 * side lock acquired.
2455 * Return 0 on success or else a negative value.
2457 static int do_create_channel(struct ust_app
*app
,
2458 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2459 struct ust_app_channel
*ua_chan
)
2468 /* Handle buffer type before sending the channel to the application. */
2469 switch (usess
->buffer_type
) {
2470 case LTTNG_BUFFER_PER_UID
:
2472 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2478 case LTTNG_BUFFER_PER_PID
:
2480 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2492 /* Initialize ust objd object using the received handle and add it. */
2493 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2494 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2496 /* If channel is not enabled, disable it on the tracer */
2497 if (!ua_chan
->enabled
) {
2498 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2509 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2510 * newly created channel if not NULL.
2512 * Called with UST app session lock and RCU read-side lock held.
2514 * Return 0 on success or else a negative value.
2516 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2517 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2518 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2519 struct ust_app_channel
**ua_chanp
)
2522 struct lttng_ht_iter iter
;
2523 struct lttng_ht_node_str
*ua_chan_node
;
2524 struct ust_app_channel
*ua_chan
;
2526 /* Lookup channel in the ust app session */
2527 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2528 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2529 if (ua_chan_node
!= NULL
) {
2530 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2534 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2535 if (ua_chan
== NULL
) {
2536 /* Only malloc can fail here */
2540 shadow_copy_channel(ua_chan
, uchan
);
2542 /* Set channel type. */
2543 ua_chan
->attr
.type
= type
;
2545 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2550 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2553 /* Only add the channel if successful on the tracer side. */
2554 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2558 *ua_chanp
= ua_chan
;
2561 /* Everything went well. */
2565 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2571 * Create UST app event and create it on the tracer side.
2573 * Called with ust app session mutex held.
2576 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2577 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2578 struct ust_app
*app
)
2581 struct ust_app_event
*ua_event
;
2583 /* Get event node */
2584 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2585 uevent
->filter
, uevent
->attr
.loglevel
);
2586 if (ua_event
!= NULL
) {
2591 /* Does not exist so create one */
2592 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2593 if (ua_event
== NULL
) {
2594 /* Only malloc can failed so something is really wrong */
2598 shadow_copy_event(ua_event
, uevent
);
2600 /* Create it on the tracer side */
2601 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2603 /* Not found previously means that it does not exist on the tracer */
2604 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2608 add_unique_ust_app_event(ua_chan
, ua_event
);
2610 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2617 /* Valid. Calling here is already in a read side lock */
2618 delete_ust_app_event(-1, ua_event
);
2623 * Create UST metadata and open it on the tracer side.
2625 * Called with UST app session lock held and RCU read side lock.
2627 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2628 struct ust_app
*app
, struct consumer_output
*consumer
,
2629 struct ustctl_consumer_channel_attr
*attr
)
2632 struct ust_app_channel
*metadata
;
2633 struct consumer_socket
*socket
;
2634 struct ust_registry_session
*registry
;
2640 registry
= get_session_registry(ua_sess
);
2643 /* Metadata already exists for this registry or it was closed previously */
2644 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2649 /* Allocate UST metadata */
2650 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2652 /* malloc() failed */
2658 /* Set default attributes for metadata. */
2659 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2660 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2661 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2662 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2663 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2664 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2665 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2667 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2668 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2669 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2672 /* Need one fd for the channel. */
2673 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2675 ERR("Exhausted number of available FD upon create metadata");
2679 /* Get the right consumer socket for the application. */
2680 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2683 goto error_consumer
;
2687 * Keep metadata key so we can identify it on the consumer side. Assign it
2688 * to the registry *before* we ask the consumer so we avoid the race of the
2689 * consumer requesting the metadata and the ask_channel call on our side
2690 * did not returned yet.
2692 registry
->metadata_key
= metadata
->key
;
2695 * Ask the metadata channel creation to the consumer. The metadata object
2696 * will be created by the consumer and kept their. However, the stream is
2697 * never added or monitored until we do a first push metadata to the
2700 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2703 /* Nullify the metadata key so we don't try to close it later on. */
2704 registry
->metadata_key
= 0;
2705 goto error_consumer
;
2709 * The setup command will make the metadata stream be sent to the relayd,
2710 * if applicable, and the thread managing the metadatas. This is important
2711 * because after this point, if an error occurs, the only way the stream
2712 * can be deleted is to be monitored in the consumer.
2714 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2716 /* Nullify the metadata key so we don't try to close it later on. */
2717 registry
->metadata_key
= 0;
2718 goto error_consumer
;
2721 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2722 metadata
->key
, app
->pid
);
2725 lttng_fd_put(LTTNG_FD_APPS
, 1);
2726 delete_ust_app_channel(-1, metadata
, app
);
2732 * Return pointer to traceable apps list.
2734 struct lttng_ht
*ust_app_get_ht(void)
2740 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2741 * acquired before calling this function.
2743 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2745 struct ust_app
*app
= NULL
;
2746 struct lttng_ht_node_ulong
*node
;
2747 struct lttng_ht_iter iter
;
2749 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2750 node
= lttng_ht_iter_get_node_ulong(&iter
);
2752 DBG2("UST app no found with pid %d", pid
);
2756 DBG2("Found UST app by pid %d", pid
);
2758 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2765 * Allocate and init an UST app object using the registration information and
2766 * the command socket. This is called when the command socket connects to the
2769 * The object is returned on success or else NULL.
2771 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2773 struct ust_app
*lta
= NULL
;
2778 DBG3("UST app creating application for socket %d", sock
);
2780 if ((msg
->bits_per_long
== 64 &&
2781 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2782 || (msg
->bits_per_long
== 32 &&
2783 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2784 ERR("Registration failed: application \"%s\" (pid: %d) has "
2785 "%d-bit long, but no consumerd for this size is available.\n",
2786 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2790 lta
= zmalloc(sizeof(struct ust_app
));
2796 lta
->ppid
= msg
->ppid
;
2797 lta
->uid
= msg
->uid
;
2798 lta
->gid
= msg
->gid
;
2800 lta
->bits_per_long
= msg
->bits_per_long
;
2801 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2802 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2803 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2804 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2805 lta
->long_alignment
= msg
->long_alignment
;
2806 lta
->byte_order
= msg
->byte_order
;
2808 lta
->v_major
= msg
->major
;
2809 lta
->v_minor
= msg
->minor
;
2810 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2811 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2812 lta
->notify_sock
= -1;
2814 /* Copy name and make sure it's NULL terminated. */
2815 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2816 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2819 * Before this can be called, when receiving the registration information,
2820 * the application compatibility is checked. So, at this point, the
2821 * application can work with this session daemon.
2823 lta
->compatible
= 1;
2825 lta
->pid
= msg
->pid
;
2826 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2828 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2830 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2837 * For a given application object, add it to every hash table.
2839 void ust_app_add(struct ust_app
*app
)
2842 assert(app
->notify_sock
>= 0);
2847 * On a re-registration, we want to kick out the previous registration of
2850 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2853 * The socket _should_ be unique until _we_ call close. So, a add_unique
2854 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2855 * already in the table.
2857 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2859 /* Add application to the notify socket hash table. */
2860 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2861 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2863 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2864 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2865 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2872 * Set the application version into the object.
2874 * Return 0 on success else a negative value either an errno code or a
2875 * LTTng-UST error code.
2877 int ust_app_version(struct ust_app
*app
)
2883 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2885 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2886 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2888 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2896 * Unregister app by removing it from the global traceable app list and freeing
2899 * The socket is already closed at this point so no close to sock.
2901 void ust_app_unregister(int sock
)
2903 struct ust_app
*lta
;
2904 struct lttng_ht_node_ulong
*node
;
2905 struct lttng_ht_iter iter
;
2906 struct ust_app_session
*ua_sess
;
2911 /* Get the node reference for a call_rcu */
2912 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2913 node
= lttng_ht_iter_get_node_ulong(&iter
);
2916 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2917 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2919 /* Remove application from PID hash table */
2920 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2924 * Remove application from notify hash table. The thread handling the
2925 * notify socket could have deleted the node so ignore on error because
2926 * either way it's valid. The close of that socket is handled by the other
2929 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2930 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2933 * Ignore return value since the node might have been removed before by an
2934 * add replace during app registration because the PID can be reassigned by
2937 iter
.iter
.node
= <a
->pid_n
.node
;
2938 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2940 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2944 /* Remove sessions so they are not visible during deletion.*/
2945 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2947 struct ust_registry_session
*registry
;
2949 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2951 /* The session was already removed so scheduled for teardown. */
2956 * Add session to list for teardown. This is safe since at this point we
2957 * are the only one using this list.
2959 pthread_mutex_lock(&ua_sess
->lock
);
2962 * Normally, this is done in the delete session process which is
2963 * executed in the call rcu below. However, upon registration we can't
2964 * afford to wait for the grace period before pushing data or else the
2965 * data pending feature can race between the unregistration and stop
2966 * command where the data pending command is sent *before* the grace
2969 * The close metadata below nullifies the metadata pointer in the
2970 * session so the delete session will NOT push/close a second time.
2972 registry
= get_session_registry(ua_sess
);
2973 if (registry
&& !registry
->metadata_closed
) {
2974 /* Push metadata for application before freeing the application. */
2975 (void) push_metadata(registry
, ua_sess
->consumer
);
2978 * Don't ask to close metadata for global per UID buffers. Close
2979 * metadata only on destroy trace session in this case. Also, the
2980 * previous push metadata could have flag the metadata registry to
2981 * close so don't send a close command if closed.
2983 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2984 !registry
->metadata_closed
) {
2985 /* And ask to close it for this session registry. */
2986 (void) close_metadata(registry
, ua_sess
->consumer
);
2990 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2991 pthread_mutex_unlock(&ua_sess
->lock
);
2995 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3002 * Return traceable_app_count
3004 unsigned long ust_app_list_count(void)
3006 unsigned long count
;
3009 count
= lttng_ht_get_count(ust_app_ht
);
3016 * Fill events array with all events name of all registered apps.
3018 int ust_app_list_events(struct lttng_event
**events
)
3021 size_t nbmem
, count
= 0;
3022 struct lttng_ht_iter iter
;
3023 struct ust_app
*app
;
3024 struct lttng_event
*tmp_event
;
3026 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3027 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3028 if (tmp_event
== NULL
) {
3029 PERROR("zmalloc ust app events");
3036 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3037 struct lttng_ust_tracepoint_iter uiter
;
3039 health_code_update();
3041 if (!app
->compatible
) {
3043 * TODO: In time, we should notice the caller of this error by
3044 * telling him that this is a version error.
3048 handle
= ustctl_tracepoint_list(app
->sock
);
3050 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3051 ERR("UST app list events getting handle failed for app pid %d",
3057 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3058 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3059 /* Handle ustctl error. */
3062 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3063 ERR("UST app tp list get failed for app %d with ret %d",
3066 DBG3("UST app tp list get failed. Application is dead");
3068 * This is normal behavior, an application can die during the
3069 * creation process. Don't report an error so the execution can
3070 * continue normally. Continue normal execution.
3077 health_code_update();
3078 if (count
>= nbmem
) {
3079 /* In case the realloc fails, we free the memory */
3082 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3085 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3087 PERROR("realloc ust app events");
3094 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3095 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3096 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3097 tmp_event
[count
].pid
= app
->pid
;
3098 tmp_event
[count
].enabled
= -1;
3104 *events
= tmp_event
;
3106 DBG2("UST app list events done (%zu events)", count
);
3111 health_code_update();
3116 * Fill events array with all events name of all registered apps.
3118 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3121 size_t nbmem
, count
= 0;
3122 struct lttng_ht_iter iter
;
3123 struct ust_app
*app
;
3124 struct lttng_event_field
*tmp_event
;
3126 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3127 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3128 if (tmp_event
== NULL
) {
3129 PERROR("zmalloc ust app event fields");
3136 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3137 struct lttng_ust_field_iter uiter
;
3139 health_code_update();
3141 if (!app
->compatible
) {
3143 * TODO: In time, we should notice the caller of this error by
3144 * telling him that this is a version error.
3148 handle
= ustctl_tracepoint_field_list(app
->sock
);
3150 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3151 ERR("UST app list field getting handle failed for app pid %d",
3157 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3158 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3159 /* Handle ustctl error. */
3162 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3163 ERR("UST app tp list field failed for app %d with ret %d",
3166 DBG3("UST app tp list field failed. Application is dead");
3168 * This is normal behavior, an application can die during the
3169 * creation process. Don't report an error so the execution can
3170 * continue normally.
3177 health_code_update();
3178 if (count
>= nbmem
) {
3179 /* In case the realloc fails, we free the memory */
3182 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3185 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3187 PERROR("realloc ust app event fields");
3195 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3196 tmp_event
[count
].type
= uiter
.type
;
3197 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3199 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3200 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3201 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3202 tmp_event
[count
].event
.pid
= app
->pid
;
3203 tmp_event
[count
].event
.enabled
= -1;
3209 *fields
= tmp_event
;
3211 DBG2("UST app list event fields done (%zu events)", count
);
3216 health_code_update();
3221 * Free and clean all traceable apps of the global list.
3223 * Should _NOT_ be called with RCU read-side lock held.
3225 void ust_app_clean_list(void)
3228 struct ust_app
*app
;
3229 struct lttng_ht_iter iter
;
3231 DBG2("UST app cleaning registered apps hash table");
3235 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3236 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3238 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3241 /* Cleanup socket hash table */
3242 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3244 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3248 /* Cleanup notify socket hash table */
3249 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3250 notify_sock_n
.node
) {
3251 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3256 /* Destroy is done only when the ht is empty */
3257 ht_cleanup_push(ust_app_ht
);
3258 ht_cleanup_push(ust_app_ht_by_sock
);
3259 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3263 * Init UST app hash table.
3265 void ust_app_ht_alloc(void)
3267 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3268 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3269 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3273 * For a specific UST session, disable the channel for all registered apps.
3275 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3276 struct ltt_ust_channel
*uchan
)
3279 struct lttng_ht_iter iter
;
3280 struct lttng_ht_node_str
*ua_chan_node
;
3281 struct ust_app
*app
;
3282 struct ust_app_session
*ua_sess
;
3283 struct ust_app_channel
*ua_chan
;
3285 if (usess
== NULL
|| uchan
== NULL
) {
3286 ERR("Disabling UST global channel with NULL values");
3291 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3292 uchan
->name
, usess
->id
);
3296 /* For every registered applications */
3297 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3298 struct lttng_ht_iter uiter
;
3299 if (!app
->compatible
) {
3301 * TODO: In time, we should notice the caller of this error by
3302 * telling him that this is a version error.
3306 ua_sess
= lookup_session_by_app(usess
, app
);
3307 if (ua_sess
== NULL
) {
3312 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3313 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3314 /* If the session if found for the app, the channel must be there */
3315 assert(ua_chan_node
);
3317 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3318 /* The channel must not be already disabled */
3319 assert(ua_chan
->enabled
== 1);
3321 /* Disable channel onto application */
3322 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3324 /* XXX: We might want to report this error at some point... */
3336 * For a specific UST session, enable the channel for all registered apps.
3338 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3339 struct ltt_ust_channel
*uchan
)
3342 struct lttng_ht_iter iter
;
3343 struct ust_app
*app
;
3344 struct ust_app_session
*ua_sess
;
3346 if (usess
== NULL
|| uchan
== NULL
) {
3347 ERR("Adding UST global channel to NULL values");
3352 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3353 uchan
->name
, usess
->id
);
3357 /* For every registered applications */
3358 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3359 if (!app
->compatible
) {
3361 * TODO: In time, we should notice the caller of this error by
3362 * telling him that this is a version error.
3366 ua_sess
= lookup_session_by_app(usess
, app
);
3367 if (ua_sess
== NULL
) {
3371 /* Enable channel onto application */
3372 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3374 /* XXX: We might want to report this error at some point... */
3386 * Disable an event in a channel and for a specific session.
3388 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3389 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3392 struct lttng_ht_iter iter
, uiter
;
3393 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3394 struct ust_app
*app
;
3395 struct ust_app_session
*ua_sess
;
3396 struct ust_app_channel
*ua_chan
;
3397 struct ust_app_event
*ua_event
;
3399 DBG("UST app disabling event %s for all apps in channel "
3400 "%s for session id %" PRIu64
,
3401 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3405 /* For all registered applications */
3406 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3407 if (!app
->compatible
) {
3409 * TODO: In time, we should notice the caller of this error by
3410 * telling him that this is a version error.
3414 ua_sess
= lookup_session_by_app(usess
, app
);
3415 if (ua_sess
== NULL
) {
3420 /* Lookup channel in the ust app session */
3421 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3422 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3423 if (ua_chan_node
== NULL
) {
3424 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3425 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3428 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3430 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3431 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3432 if (ua_event_node
== NULL
) {
3433 DBG2("Event %s not found in channel %s for app pid %d."
3434 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3437 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3439 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3441 /* XXX: Report error someday... */
3452 * For a specific UST session and UST channel, the event for all
3455 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3456 struct ltt_ust_channel
*uchan
)
3459 struct lttng_ht_iter iter
, uiter
;
3460 struct lttng_ht_node_str
*ua_chan_node
;
3461 struct ust_app
*app
;
3462 struct ust_app_session
*ua_sess
;
3463 struct ust_app_channel
*ua_chan
;
3464 struct ust_app_event
*ua_event
;
3466 DBG("UST app disabling all event for all apps in channel "
3467 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3471 /* For all registered applications */
3472 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3473 if (!app
->compatible
) {
3475 * TODO: In time, we should notice the caller of this error by
3476 * telling him that this is a version error.
3480 ua_sess
= lookup_session_by_app(usess
, app
);
3482 /* The application has problem or is probably dead. */
3486 /* Lookup channel in the ust app session */
3487 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3488 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3489 /* If the channel is not found, there is a code flow error */
3490 assert(ua_chan_node
);
3492 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3494 /* Disable each events of channel */
3495 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3497 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3499 /* XXX: Report error someday... */
3511 * For a specific UST session, create the channel for all registered apps.
3513 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3514 struct ltt_ust_channel
*uchan
)
3516 int ret
= 0, created
;
3517 struct lttng_ht_iter iter
;
3518 struct ust_app
*app
;
3519 struct ust_app_session
*ua_sess
= NULL
;
3521 /* Very wrong code flow */
3525 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3526 uchan
->name
, usess
->id
);
3530 /* For every 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.
3540 * Create session on the tracer side and add it to app session HT. Note
3541 * that if session exist, it will simply return a pointer to the ust
3544 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3549 * The application's socket is not valid. Either a bad socket
3550 * or a timeout on it. We can't inform the caller that for a
3551 * specific app, the session failed so lets continue here.
3556 goto error_rcu_unlock
;
3561 pthread_mutex_lock(&ua_sess
->lock
);
3562 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3563 sizeof(uchan
->name
))) {
3564 struct ustctl_consumer_channel_attr attr
;
3565 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3566 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3569 /* Create channel onto application. We don't need the chan ref. */
3570 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3571 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3573 pthread_mutex_unlock(&ua_sess
->lock
);
3575 if (ret
== -ENOMEM
) {
3576 /* No more memory is a fatal error. Stop right now. */
3577 goto error_rcu_unlock
;
3579 /* Cleanup the created session if it's the case. */
3581 destroy_app_session(app
, ua_sess
);
3592 * Enable event for a specific session and channel on the tracer.
3594 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3595 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3598 struct lttng_ht_iter iter
, uiter
;
3599 struct lttng_ht_node_str
*ua_chan_node
;
3600 struct ust_app
*app
;
3601 struct ust_app_session
*ua_sess
;
3602 struct ust_app_channel
*ua_chan
;
3603 struct ust_app_event
*ua_event
;
3605 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3606 uevent
->attr
.name
, usess
->id
);
3609 * NOTE: At this point, this function is called only if the session and
3610 * channel passed are already created for all apps. and enabled on the
3616 /* For all registered applications */
3617 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3618 if (!app
->compatible
) {
3620 * TODO: In time, we should notice the caller of this error by
3621 * telling him that this is a version error.
3625 ua_sess
= lookup_session_by_app(usess
, app
);
3627 /* The application has problem or is probably dead. */
3631 pthread_mutex_lock(&ua_sess
->lock
);
3633 /* Lookup channel in the ust app session */
3634 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3635 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3636 /* If the channel is not found, there is a code flow error */
3637 assert(ua_chan_node
);
3639 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3641 /* Get event node */
3642 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3643 uevent
->filter
, uevent
->attr
.loglevel
);
3644 if (ua_event
== NULL
) {
3645 DBG3("UST app enable event %s not found for app PID %d."
3646 "Skipping app", uevent
->attr
.name
, app
->pid
);
3650 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3652 pthread_mutex_unlock(&ua_sess
->lock
);
3656 pthread_mutex_unlock(&ua_sess
->lock
);
3665 * For a specific existing UST session and UST channel, creates the event for
3666 * all registered apps.
3668 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3669 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3672 struct lttng_ht_iter iter
, uiter
;
3673 struct lttng_ht_node_str
*ua_chan_node
;
3674 struct ust_app
*app
;
3675 struct ust_app_session
*ua_sess
;
3676 struct ust_app_channel
*ua_chan
;
3678 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3679 uevent
->attr
.name
, usess
->id
);
3683 /* For all registered applications */
3684 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3685 if (!app
->compatible
) {
3687 * TODO: In time, we should notice the caller of this error by
3688 * telling him that this is a version error.
3692 ua_sess
= lookup_session_by_app(usess
, app
);
3694 /* The application has problem or is probably dead. */
3698 pthread_mutex_lock(&ua_sess
->lock
);
3699 /* Lookup channel in the ust app session */
3700 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3701 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3702 /* If the channel is not found, there is a code flow error */
3703 assert(ua_chan_node
);
3705 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3707 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3708 pthread_mutex_unlock(&ua_sess
->lock
);
3710 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3711 /* Possible value at this point: -ENOMEM. If so, we stop! */
3714 DBG2("UST app event %s already exist on app PID %d",
3715 uevent
->attr
.name
, app
->pid
);
3726 * Start tracing for a specific UST session and app.
3729 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3732 struct ust_app_session
*ua_sess
;
3734 DBG("Starting tracing for ust app pid %d", app
->pid
);
3738 if (!app
->compatible
) {
3742 ua_sess
= lookup_session_by_app(usess
, app
);
3743 if (ua_sess
== NULL
) {
3744 /* The session is in teardown process. Ignore and continue. */
3748 pthread_mutex_lock(&ua_sess
->lock
);
3750 /* Upon restart, we skip the setup, already done */
3751 if (ua_sess
->started
) {
3755 /* Create directories if consumer is LOCAL and has a path defined. */
3756 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3757 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3758 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3759 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3761 if (ret
!= -EEXIST
) {
3762 ERR("Trace directory creation error");
3769 * Create the metadata for the application. This returns gracefully if a
3770 * metadata was already set for the session.
3772 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3777 health_code_update();
3780 /* This start the UST tracing */
3781 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3783 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3784 ERR("Error starting tracing for app pid: %d (ret: %d)",
3787 DBG("UST app start session failed. Application is dead.");
3789 * This is normal behavior, an application can die during the
3790 * creation process. Don't report an error so the execution can
3791 * continue normally.
3793 pthread_mutex_unlock(&ua_sess
->lock
);
3799 /* Indicate that the session has been started once */
3800 ua_sess
->started
= 1;
3802 pthread_mutex_unlock(&ua_sess
->lock
);
3804 health_code_update();
3806 /* Quiescent wait after starting trace */
3807 ret
= ustctl_wait_quiescent(app
->sock
);
3808 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3809 ERR("UST app wait quiescent failed for app pid %d ret %d",
3815 health_code_update();
3819 pthread_mutex_unlock(&ua_sess
->lock
);
3821 health_code_update();
3826 * Stop tracing for a specific UST session and app.
3829 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3832 struct ust_app_session
*ua_sess
;
3833 struct ust_registry_session
*registry
;
3835 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3839 if (!app
->compatible
) {
3840 goto end_no_session
;
3843 ua_sess
= lookup_session_by_app(usess
, app
);
3844 if (ua_sess
== NULL
) {
3845 goto end_no_session
;
3848 pthread_mutex_lock(&ua_sess
->lock
);
3851 * If started = 0, it means that stop trace has been called for a session
3852 * that was never started. It's possible since we can have a fail start
3853 * from either the application manager thread or the command thread. Simply
3854 * indicate that this is a stop error.
3856 if (!ua_sess
->started
) {
3857 goto error_rcu_unlock
;
3860 health_code_update();
3862 /* This inhibits UST tracing */
3863 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3865 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3866 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3869 DBG("UST app stop session failed. Application is dead.");
3871 * This is normal behavior, an application can die during the
3872 * creation process. Don't report an error so the execution can
3873 * continue normally.
3877 goto error_rcu_unlock
;
3880 health_code_update();
3882 /* Quiescent wait after stopping trace */
3883 ret
= ustctl_wait_quiescent(app
->sock
);
3884 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3885 ERR("UST app wait quiescent failed for app pid %d ret %d",
3889 health_code_update();
3891 registry
= get_session_registry(ua_sess
);
3894 if (!registry
->metadata_closed
) {
3895 /* Push metadata for application before freeing the application. */
3896 (void) push_metadata(registry
, ua_sess
->consumer
);
3900 pthread_mutex_unlock(&ua_sess
->lock
);
3903 health_code_update();
3907 pthread_mutex_unlock(&ua_sess
->lock
);
3909 health_code_update();
3914 * Flush buffers for a specific UST session and app.
3917 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3920 struct lttng_ht_iter iter
;
3921 struct ust_app_session
*ua_sess
;
3922 struct ust_app_channel
*ua_chan
;
3924 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3928 if (!app
->compatible
) {
3929 goto end_no_session
;
3932 ua_sess
= lookup_session_by_app(usess
, app
);
3933 if (ua_sess
== NULL
) {
3934 goto end_no_session
;
3937 pthread_mutex_lock(&ua_sess
->lock
);
3939 health_code_update();
3941 /* Flushing buffers */
3942 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3944 health_code_update();
3945 assert(ua_chan
->is_sent
);
3946 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3948 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3949 ERR("UST app PID %d channel %s flush failed with ret %d",
3950 app
->pid
, ua_chan
->name
, ret
);
3952 DBG3("UST app failed to flush %s. Application is dead.",
3955 * This is normal behavior, an application can die during the
3956 * creation process. Don't report an error so the execution can
3957 * continue normally.
3960 /* Continuing flushing all buffers */
3965 health_code_update();
3967 pthread_mutex_unlock(&ua_sess
->lock
);
3970 health_code_update();
3975 * Destroy a specific UST session in apps.
3977 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3980 struct ust_app_session
*ua_sess
;
3981 struct lttng_ht_iter iter
;
3982 struct lttng_ht_node_u64
*node
;
3984 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3988 if (!app
->compatible
) {
3992 __lookup_session_by_app(usess
, app
, &iter
);
3993 node
= lttng_ht_iter_get_node_u64(&iter
);
3995 /* Session is being or is deleted. */
3998 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4000 health_code_update();
4001 destroy_app_session(app
, ua_sess
);
4003 health_code_update();
4005 /* Quiescent wait after stopping trace */
4006 ret
= ustctl_wait_quiescent(app
->sock
);
4007 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4008 ERR("UST app wait quiescent failed for app pid %d ret %d",
4013 health_code_update();
4018 * Start tracing for the UST session.
4020 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4023 struct lttng_ht_iter iter
;
4024 struct ust_app
*app
;
4026 DBG("Starting all UST traces");
4030 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4031 ret
= ust_app_start_trace(usess
, app
);
4033 /* Continue to next apps even on error */
4044 * Start tracing for the UST session.
4046 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4049 struct lttng_ht_iter iter
;
4050 struct ust_app
*app
;
4052 DBG("Stopping all UST traces");
4056 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4057 ret
= ust_app_stop_trace(usess
, app
);
4059 /* Continue to next apps even on error */
4064 /* Flush buffers and push metadata (for UID buffers). */
4065 switch (usess
->buffer_type
) {
4066 case LTTNG_BUFFER_PER_UID
:
4068 struct buffer_reg_uid
*reg
;
4070 /* Flush all per UID buffers associated to that session. */
4071 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4072 struct ust_registry_session
*ust_session_reg
;
4073 struct buffer_reg_channel
*reg_chan
;
4074 struct consumer_socket
*socket
;
4076 /* Get consumer socket to use to push the metadata.*/
4077 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4080 /* Ignore request if no consumer is found for the session. */
4084 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4085 reg_chan
, node
.node
) {
4087 * The following call will print error values so the return
4088 * code is of little importance because whatever happens, we
4089 * have to try them all.
4091 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4094 ust_session_reg
= reg
->registry
->reg
.ust
;
4095 if (!ust_session_reg
->metadata_closed
) {
4096 /* Push metadata. */
4097 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4103 case LTTNG_BUFFER_PER_PID
:
4104 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4105 ret
= ust_app_flush_trace(usess
, app
);
4107 /* Continue to next apps even on error */
4123 * Destroy app UST session.
4125 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4128 struct lttng_ht_iter iter
;
4129 struct ust_app
*app
;
4131 DBG("Destroy all UST traces");
4135 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4136 ret
= destroy_trace(usess
, app
);
4138 /* Continue to next apps even on error */
4149 * Add channels/events from UST global domain to registered apps at sock.
4151 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4154 struct lttng_ht_iter iter
, uiter
;
4155 struct ust_app
*app
;
4156 struct ust_app_session
*ua_sess
= NULL
;
4157 struct ust_app_channel
*ua_chan
;
4158 struct ust_app_event
*ua_event
;
4159 struct ust_app_ctx
*ua_ctx
;
4164 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4169 app
= ust_app_find_by_sock(sock
);
4172 * Application can be unregistered before so this is possible hence
4173 * simply stopping the update.
4175 DBG3("UST app update failed to find app sock %d", sock
);
4179 if (!app
->compatible
) {
4183 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4185 /* Tracer is probably gone or ENOMEM. */
4190 pthread_mutex_lock(&ua_sess
->lock
);
4193 * We can iterate safely here over all UST app session since the create ust
4194 * app session above made a shadow copy of the UST global domain from the
4197 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4200 * For a metadata channel, handle it differently.
4202 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4203 sizeof(ua_chan
->name
))) {
4204 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4209 /* Remove it from the hash table and continue!. */
4210 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4212 delete_ust_app_channel(-1, ua_chan
, app
);
4215 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4218 * Stop everything. On error, the application failed, no more
4219 * file descriptor are available or ENOMEM so stopping here is
4220 * the only thing we can do for now.
4227 * Add context using the list so they are enabled in the same order the
4230 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4231 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4238 /* For each events */
4239 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4241 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4248 pthread_mutex_unlock(&ua_sess
->lock
);
4250 if (usess
->start_trace
) {
4251 ret
= ust_app_start_trace(usess
, app
);
4256 DBG2("UST trace started for app pid %d", app
->pid
);
4259 /* Everything went well at this point. */
4264 pthread_mutex_unlock(&ua_sess
->lock
);
4267 destroy_app_session(app
, ua_sess
);
4274 * Add context to a specific channel for global UST domain.
4276 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4277 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4280 struct lttng_ht_node_str
*ua_chan_node
;
4281 struct lttng_ht_iter iter
, uiter
;
4282 struct ust_app_channel
*ua_chan
= NULL
;
4283 struct ust_app_session
*ua_sess
;
4284 struct ust_app
*app
;
4288 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4289 if (!app
->compatible
) {
4291 * TODO: In time, we should notice the caller of this error by
4292 * telling him that this is a version error.
4296 ua_sess
= lookup_session_by_app(usess
, app
);
4297 if (ua_sess
== NULL
) {
4301 pthread_mutex_lock(&ua_sess
->lock
);
4302 /* Lookup channel in the ust app session */
4303 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4304 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4305 if (ua_chan_node
== NULL
) {
4308 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4310 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4315 pthread_mutex_unlock(&ua_sess
->lock
);
4323 * Enable event for a channel from a UST session for a specific PID.
4325 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4326 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4329 struct lttng_ht_iter iter
;
4330 struct lttng_ht_node_str
*ua_chan_node
;
4331 struct ust_app
*app
;
4332 struct ust_app_session
*ua_sess
;
4333 struct ust_app_channel
*ua_chan
;
4334 struct ust_app_event
*ua_event
;
4336 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4340 app
= ust_app_find_by_pid(pid
);
4342 ERR("UST app enable event per PID %d not found", pid
);
4347 if (!app
->compatible
) {
4352 ua_sess
= lookup_session_by_app(usess
, app
);
4354 /* The application has problem or is probably dead. */
4359 pthread_mutex_lock(&ua_sess
->lock
);
4360 /* Lookup channel in the ust app session */
4361 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4362 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4363 /* If the channel is not found, there is a code flow error */
4364 assert(ua_chan_node
);
4366 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4368 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4369 uevent
->filter
, uevent
->attr
.loglevel
);
4370 if (ua_event
== NULL
) {
4371 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4376 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4383 pthread_mutex_unlock(&ua_sess
->lock
);
4390 * Disable event for a channel from a UST session for a specific PID.
4392 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4393 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4396 struct lttng_ht_iter iter
;
4397 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4398 struct ust_app
*app
;
4399 struct ust_app_session
*ua_sess
;
4400 struct ust_app_channel
*ua_chan
;
4401 struct ust_app_event
*ua_event
;
4403 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4407 app
= ust_app_find_by_pid(pid
);
4409 ERR("UST app disable event per PID %d not found", pid
);
4414 if (!app
->compatible
) {
4419 ua_sess
= lookup_session_by_app(usess
, app
);
4421 /* The application has problem or is probably dead. */
4425 /* Lookup channel in the ust app session */
4426 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4427 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4428 if (ua_chan_node
== NULL
) {
4429 /* Channel does not exist, skip disabling */
4432 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4434 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4435 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4436 if (ua_event_node
== NULL
) {
4437 /* Event does not exist, skip disabling */
4440 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4442 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4453 * Calibrate registered applications.
4455 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4458 struct lttng_ht_iter iter
;
4459 struct ust_app
*app
;
4463 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4464 if (!app
->compatible
) {
4466 * TODO: In time, we should notice the caller of this error by
4467 * telling him that this is a version error.
4472 health_code_update();
4474 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4478 /* Means that it's not implemented on the tracer side. */
4482 DBG2("Calibrate app PID %d returned with error %d",
4489 DBG("UST app global domain calibration finished");
4493 health_code_update();
4499 * Receive registration and populate the given msg structure.
4501 * On success return 0 else a negative value returned by the ustctl call.
4503 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4506 uint32_t pid
, ppid
, uid
, gid
;
4510 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4511 &pid
, &ppid
, &uid
, &gid
,
4512 &msg
->bits_per_long
,
4513 &msg
->uint8_t_alignment
,
4514 &msg
->uint16_t_alignment
,
4515 &msg
->uint32_t_alignment
,
4516 &msg
->uint64_t_alignment
,
4517 &msg
->long_alignment
,
4524 case LTTNG_UST_ERR_EXITING
:
4525 DBG3("UST app recv reg message failed. Application died");
4527 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4528 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4529 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4530 LTTNG_UST_ABI_MINOR_VERSION
);
4533 ERR("UST app recv reg message failed with ret %d", ret
);
4538 msg
->pid
= (pid_t
) pid
;
4539 msg
->ppid
= (pid_t
) ppid
;
4540 msg
->uid
= (uid_t
) uid
;
4541 msg
->gid
= (gid_t
) gid
;
4548 * Return a ust app channel object using the application object and the channel
4549 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4550 * lock MUST be acquired before calling this function.
4552 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4555 struct lttng_ht_node_ulong
*node
;
4556 struct lttng_ht_iter iter
;
4557 struct ust_app_channel
*ua_chan
= NULL
;
4561 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4562 node
= lttng_ht_iter_get_node_ulong(&iter
);
4564 DBG2("UST app channel find by objd %d not found", objd
);
4568 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4575 * Reply to a register channel notification from an application on the notify
4576 * socket. The channel metadata is also created.
4578 * The session UST registry lock is acquired in this function.
4580 * On success 0 is returned else a negative value.
4582 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4583 size_t nr_fields
, struct ustctl_field
*fields
)
4585 int ret
, ret_code
= 0;
4586 uint32_t chan_id
, reg_count
;
4587 uint64_t chan_reg_key
;
4588 enum ustctl_channel_header type
;
4589 struct ust_app
*app
;
4590 struct ust_app_channel
*ua_chan
;
4591 struct ust_app_session
*ua_sess
;
4592 struct ust_registry_session
*registry
;
4593 struct ust_registry_channel
*chan_reg
;
4597 /* Lookup application. If not found, there is a code flow error. */
4598 app
= find_app_by_notify_sock(sock
);
4600 DBG("Application socket %d is being teardown. Abort event notify",
4604 goto error_rcu_unlock
;
4607 /* Lookup channel by UST object descriptor. */
4608 ua_chan
= find_channel_by_objd(app
, cobjd
);
4610 DBG("Application channel is being teardown. Abort event notify");
4613 goto error_rcu_unlock
;
4616 assert(ua_chan
->session
);
4617 ua_sess
= ua_chan
->session
;
4619 /* Get right session registry depending on the session buffer type. */
4620 registry
= get_session_registry(ua_sess
);
4623 /* Depending on the buffer type, a different channel key is used. */
4624 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4625 chan_reg_key
= ua_chan
->tracing_channel_id
;
4627 chan_reg_key
= ua_chan
->key
;
4630 pthread_mutex_lock(®istry
->lock
);
4632 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4635 if (!chan_reg
->register_done
) {
4636 reg_count
= ust_registry_get_event_count(chan_reg
);
4637 if (reg_count
< 31) {
4638 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4640 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4643 chan_reg
->nr_ctx_fields
= nr_fields
;
4644 chan_reg
->ctx_fields
= fields
;
4645 chan_reg
->header_type
= type
;
4647 /* Get current already assigned values. */
4648 type
= chan_reg
->header_type
;
4650 /* Set to NULL so the error path does not do a double free. */
4653 /* Channel id is set during the object creation. */
4654 chan_id
= chan_reg
->chan_id
;
4656 /* Append to metadata */
4657 if (!chan_reg
->metadata_dumped
) {
4658 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4660 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4666 DBG3("UST app replying to register channel key %" PRIu64
4667 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4670 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4672 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4673 ERR("UST app reply channel failed with ret %d", ret
);
4675 DBG3("UST app reply channel failed. Application died");
4680 /* This channel registry registration is completed. */
4681 chan_reg
->register_done
= 1;
4684 pthread_mutex_unlock(®istry
->lock
);
4694 * Add event to the UST channel registry. When the event is added to the
4695 * registry, the metadata is also created. Once done, this replies to the
4696 * application with the appropriate error code.
4698 * The session UST registry lock is acquired in the function.
4700 * On success 0 is returned else a negative value.
4702 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4703 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4704 char *model_emf_uri
)
4707 uint32_t event_id
= 0;
4708 uint64_t chan_reg_key
;
4709 struct ust_app
*app
;
4710 struct ust_app_channel
*ua_chan
;
4711 struct ust_app_session
*ua_sess
;
4712 struct ust_registry_session
*registry
;
4716 /* Lookup application. If not found, there is a code flow error. */
4717 app
= find_app_by_notify_sock(sock
);
4719 DBG("Application socket %d is being teardown. Abort event notify",
4724 free(model_emf_uri
);
4725 goto error_rcu_unlock
;
4728 /* Lookup channel by UST object descriptor. */
4729 ua_chan
= find_channel_by_objd(app
, cobjd
);
4731 DBG("Application channel is being teardown. Abort event notify");
4735 free(model_emf_uri
);
4736 goto error_rcu_unlock
;
4739 assert(ua_chan
->session
);
4740 ua_sess
= ua_chan
->session
;
4742 registry
= get_session_registry(ua_sess
);
4745 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4746 chan_reg_key
= ua_chan
->tracing_channel_id
;
4748 chan_reg_key
= ua_chan
->key
;
4751 pthread_mutex_lock(®istry
->lock
);
4754 * From this point on, this call acquires the ownership of the sig, fields
4755 * and model_emf_uri meaning any free are done inside it if needed. These
4756 * three variables MUST NOT be read/write after this.
4758 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4759 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4760 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4764 * The return value is returned to ustctl so in case of an error, the
4765 * application can be notified. In case of an error, it's important not to
4766 * return a negative error or else the application will get closed.
4768 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4770 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4771 ERR("UST app reply event failed with ret %d", ret
);
4773 DBG3("UST app reply event failed. Application died");
4776 * No need to wipe the create event since the application socket will
4777 * get close on error hence cleaning up everything by itself.
4782 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4786 pthread_mutex_unlock(®istry
->lock
);
4793 * Handle application notification through the given notify socket.
4795 * Return 0 on success or else a negative value.
4797 int ust_app_recv_notify(int sock
)
4800 enum ustctl_notify_cmd cmd
;
4802 DBG3("UST app receiving notify from sock %d", sock
);
4804 ret
= ustctl_recv_notify(sock
, &cmd
);
4806 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4807 ERR("UST app recv notify failed with ret %d", ret
);
4809 DBG3("UST app recv notify failed. Application died");
4815 case USTCTL_NOTIFY_CMD_EVENT
:
4817 int sobjd
, cobjd
, loglevel
;
4818 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4820 struct ustctl_field
*fields
;
4822 DBG2("UST app ustctl register event received");
4824 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4825 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4827 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4828 ERR("UST app recv event failed with ret %d", ret
);
4830 DBG3("UST app recv event failed. Application died");
4836 * Add event to the UST registry coming from the notify socket. This
4837 * call will free if needed the sig, fields and model_emf_uri. This
4838 * code path loses the ownsership of these variables and transfer them
4839 * to the this function.
4841 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4842 fields
, loglevel
, model_emf_uri
);
4849 case USTCTL_NOTIFY_CMD_CHANNEL
:
4853 struct ustctl_field
*fields
;
4855 DBG2("UST app ustctl register channel received");
4857 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4860 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4861 ERR("UST app recv channel failed with ret %d", ret
);
4863 DBG3("UST app recv channel failed. Application died");
4869 * The fields ownership are transfered to this function call meaning
4870 * that if needed it will be freed. After this, it's invalid to access
4871 * fields or clean it up.
4873 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4882 /* Should NEVER happen. */
4891 * Once the notify socket hangs up, this is called. First, it tries to find the
4892 * corresponding application. On failure, the call_rcu to close the socket is
4893 * executed. If an application is found, it tries to delete it from the notify
4894 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4896 * Note that an object needs to be allocated here so on ENOMEM failure, the
4897 * call RCU is not done but the rest of the cleanup is.
4899 void ust_app_notify_sock_unregister(int sock
)
4902 struct lttng_ht_iter iter
;
4903 struct ust_app
*app
;
4904 struct ust_app_notify_sock_obj
*obj
;
4910 obj
= zmalloc(sizeof(*obj
));
4913 * An ENOMEM is kind of uncool. If this strikes we continue the
4914 * procedure but the call_rcu will not be called. In this case, we
4915 * accept the fd leak rather than possibly creating an unsynchronized
4916 * state between threads.
4918 * TODO: The notify object should be created once the notify socket is
4919 * registered and stored independantely from the ust app object. The
4920 * tricky part is to synchronize the teardown of the application and
4921 * this notify object. Let's keep that in mind so we can avoid this
4922 * kind of shenanigans with ENOMEM in the teardown path.
4929 DBG("UST app notify socket unregister %d", sock
);
4932 * Lookup application by notify socket. If this fails, this means that the
4933 * hash table delete has already been done by the application
4934 * unregistration process so we can safely close the notify socket in a
4937 app
= find_app_by_notify_sock(sock
);
4942 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4945 * Whatever happens here either we fail or succeed, in both cases we have
4946 * to close the socket after a grace period to continue to the call RCU
4947 * here. If the deletion is successful, the application is not visible
4948 * anymore by other threads and is it fails it means that it was already
4949 * deleted from the hash table so either way we just have to close the
4952 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4958 * Close socket after a grace period to avoid for the socket to be reused
4959 * before the application object is freed creating potential race between
4960 * threads trying to add unique in the global hash table.
4963 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4968 * Destroy a ust app data structure and free its memory.
4970 void ust_app_destroy(struct ust_app
*app
)
4976 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4980 * Take a snapshot for a given UST session. The snapshot is sent to the given
4983 * Return 0 on success or else a negative value.
4985 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4986 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4989 struct lttng_ht_iter iter
;
4990 struct ust_app
*app
;
4991 char pathname
[PATH_MAX
];
4992 uint64_t max_stream_size
= 0;
5000 * Compute the maximum size of a single stream if a max size is asked by
5003 if (output
->max_size
> 0 && nb_streams
> 0) {
5004 max_stream_size
= output
->max_size
/ nb_streams
;
5007 switch (usess
->buffer_type
) {
5008 case LTTNG_BUFFER_PER_UID
:
5010 struct buffer_reg_uid
*reg
;
5012 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5013 struct buffer_reg_channel
*reg_chan
;
5014 struct consumer_socket
*socket
;
5016 /* Get consumer socket to use to push the metadata.*/
5017 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5024 memset(pathname
, 0, sizeof(pathname
));
5025 ret
= snprintf(pathname
, sizeof(pathname
),
5026 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5027 reg
->uid
, reg
->bits_per_long
);
5029 PERROR("snprintf snapshot path");
5033 /* Add the UST default trace dir to path. */
5034 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5035 reg_chan
, node
.node
) {
5038 * Make sure the maximum stream size is not lower than the
5039 * subbuffer size or else it's an error since we won't be able to
5040 * snapshot anything.
5042 if (max_stream_size
&&
5043 reg_chan
->subbuf_size
> max_stream_size
) {
5045 DBG3("UST app snapshot record maximum stream size %" PRIu64
5046 " is smaller than subbuffer size of %zu",
5047 max_stream_size
, reg_chan
->subbuf_size
);
5050 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5051 usess
->uid
, usess
->gid
, pathname
, wait
,
5057 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5058 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5066 case LTTNG_BUFFER_PER_PID
:
5068 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5069 struct consumer_socket
*socket
;
5070 struct lttng_ht_iter chan_iter
;
5071 struct ust_app_channel
*ua_chan
;
5072 struct ust_app_session
*ua_sess
;
5073 struct ust_registry_session
*registry
;
5075 ua_sess
= lookup_session_by_app(usess
, app
);
5077 /* Session not associated with this app. */
5081 /* Get the right consumer socket for the application. */
5082 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5089 /* Add the UST default trace dir to path. */
5090 memset(pathname
, 0, sizeof(pathname
));
5091 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5094 PERROR("snprintf snapshot path");
5098 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5099 ua_chan
, node
.node
) {
5101 * Make sure the maximum stream size is not lower than the
5102 * subbuffer size or else it's an error since we won't be able to
5103 * snapshot anything.
5105 if (max_stream_size
&&
5106 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5108 DBG3("UST app snapshot record maximum stream size %" PRIu64
5109 " is smaller than subbuffer size of %" PRIu64
,
5110 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5114 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5115 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5122 registry
= get_session_registry(ua_sess
);
5124 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5125 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5144 * Return the number of streams for a UST session.
5146 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5148 unsigned int ret
= 0;
5149 struct ust_app
*app
;
5150 struct lttng_ht_iter iter
;
5154 switch (usess
->buffer_type
) {
5155 case LTTNG_BUFFER_PER_UID
:
5157 struct buffer_reg_uid
*reg
;
5159 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5160 struct buffer_reg_channel
*reg_chan
;
5162 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5163 reg_chan
, node
.node
) {
5164 ret
+= reg_chan
->stream_count
;
5169 case LTTNG_BUFFER_PER_PID
:
5172 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5173 struct ust_app_channel
*ua_chan
;
5174 struct ust_app_session
*ua_sess
;
5175 struct lttng_ht_iter chan_iter
;
5177 ua_sess
= lookup_session_by_app(usess
, app
);
5179 /* Session not associated with this app. */
5183 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5184 ua_chan
, node
.node
) {
5185 ret
+= ua_chan
->streams
.count
;