2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
39 #include "ust-consumer.h"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 3 elements of the key: name, filter and loglevel. */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
151 * Unique add of an ust app event in the given ht. This uses the custom
152 * ht_match_ust_app_event match function and the event name as hash.
154 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
155 struct ust_app_event
*event
)
157 struct cds_lfht_node
*node_ptr
;
158 struct ust_app_ht_key key
;
162 assert(ua_chan
->events
);
165 ht
= ua_chan
->events
;
166 key
.name
= event
->attr
.name
;
167 key
.filter
= event
->filter
;
168 key
.loglevel
= event
->attr
.loglevel
;
170 node_ptr
= cds_lfht_add_unique(ht
->ht
,
171 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
172 ht_match_ust_app_event
, &key
, &event
->node
.node
);
173 assert(node_ptr
== &event
->node
.node
);
177 * Close the notify socket from the given RCU head object. This MUST be called
178 * through a call_rcu().
180 static void close_notify_sock_rcu(struct rcu_head
*head
)
183 struct ust_app_notify_sock_obj
*obj
=
184 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
186 /* Must have a valid fd here. */
187 assert(obj
->fd
>= 0);
189 ret
= close(obj
->fd
);
191 ERR("close notify sock %d RCU", obj
->fd
);
193 lttng_fd_put(LTTNG_FD_APPS
, 1);
199 * Return the session registry according to the buffer type of the given
202 * A registry per UID object MUST exists before calling this function or else
203 * it assert() if not found. RCU read side lock must be acquired.
205 static struct ust_registry_session
*get_session_registry(
206 struct ust_app_session
*ua_sess
)
208 struct ust_registry_session
*registry
= NULL
;
212 switch (ua_sess
->buffer_type
) {
213 case LTTNG_BUFFER_PER_PID
:
215 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
219 registry
= reg_pid
->registry
->reg
.ust
;
222 case LTTNG_BUFFER_PER_UID
:
224 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
225 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
229 registry
= reg_uid
->registry
->reg
.ust
;
241 * Delete ust context safely. RCU read lock must be held before calling
245 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
252 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
253 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
254 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
255 sock
, ua_ctx
->obj
->handle
, ret
);
263 * Delete ust app event safely. RCU read lock must be held before calling
267 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
273 free(ua_event
->filter
);
275 if (ua_event
->obj
!= NULL
) {
276 ret
= ustctl_release_object(sock
, ua_event
->obj
);
277 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
278 ERR("UST app sock %d release event obj failed with ret %d",
287 * Release ust data object of the given stream.
289 * Return 0 on success or else a negative value.
291 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
298 ret
= ustctl_release_object(sock
, stream
->obj
);
299 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
300 ERR("UST app sock %d release stream obj failed with ret %d",
303 lttng_fd_put(LTTNG_FD_APPS
, 2);
311 * Delete ust app stream safely. RCU read lock must be held before calling
315 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 (void) release_ust_app_stream(sock
, stream
);
324 * We need to execute ht_destroy outside of RCU read-side critical
325 * section and outside of call_rcu thread, so we postpone its execution
326 * using ht_cleanup_push. It is simpler than to change the semantic of
327 * the many callers of delete_ust_app_session().
330 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
332 struct ust_app_channel
*ua_chan
=
333 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
335 ht_cleanup_push(ua_chan
->ctx
);
336 ht_cleanup_push(ua_chan
->events
);
341 * Delete ust app channel safely. RCU read lock must be held before calling
345 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
349 struct lttng_ht_iter iter
;
350 struct ust_app_event
*ua_event
;
351 struct ust_app_ctx
*ua_ctx
;
352 struct ust_app_stream
*stream
, *stmp
;
353 struct ust_registry_session
*registry
;
357 DBG3("UST app deleting channel %s", ua_chan
->name
);
360 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
361 cds_list_del(&stream
->list
);
362 delete_ust_app_stream(sock
, stream
);
366 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
367 cds_list_del(&ua_ctx
->list
);
368 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
370 delete_ust_app_ctx(sock
, ua_ctx
);
374 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
376 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
378 delete_ust_app_event(sock
, ua_event
);
381 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
382 /* Wipe and free registry from session registry. */
383 registry
= get_session_registry(ua_chan
->session
);
385 ust_registry_channel_del_free(registry
, ua_chan
->key
);
389 if (ua_chan
->obj
!= NULL
) {
390 /* Remove channel from application UST object descriptor. */
391 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
392 lttng_ht_del(app
->ust_objd
, &iter
);
393 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
394 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
395 ERR("UST app sock %d release channel obj failed with ret %d",
398 lttng_fd_put(LTTNG_FD_APPS
, 1);
401 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
405 * Push metadata to consumer socket.
407 * The socket lock MUST be acquired.
408 * The ust app session lock MUST be acquired.
410 * On success, return the len of metadata pushed or else a negative value.
412 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
413 struct consumer_socket
*socket
, int send_zero_data
)
416 char *metadata_str
= NULL
;
424 * On a push metadata error either the consumer is dead or the metadata
425 * channel has been destroyed because its endpoint might have died (e.g:
426 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
427 * metadata again which is not valid anymore on the consumer side.
429 * The ust app session mutex locked allows us to make this check without
432 if (registry
->metadata_closed
) {
436 pthread_mutex_lock(®istry
->lock
);
438 offset
= registry
->metadata_len_sent
;
439 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
441 DBG3("No metadata to push for metadata key %" PRIu64
,
442 registry
->metadata_key
);
444 if (send_zero_data
) {
445 DBG("No metadata to push");
451 /* Allocate only what we have to send. */
452 metadata_str
= zmalloc(len
);
454 PERROR("zmalloc ust app metadata string");
458 /* Copy what we haven't send out. */
459 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
460 registry
->metadata_len_sent
+= len
;
463 pthread_mutex_unlock(®istry
->lock
);
464 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
465 metadata_str
, len
, offset
);
468 * There is an acceptable race here between the registry metadata key
469 * assignment and the creation on the consumer. The session daemon can
470 * concurrently push metadata for this registry while being created on
471 * the consumer since the metadata key of the registry is assigned
472 * *before* it is setup to avoid the consumer to ask for metadata that
473 * could possibly be not found in the session daemon.
475 * The metadata will get pushed either by the session being stopped or
476 * the consumer requesting metadata if that race is triggered.
478 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
490 pthread_mutex_unlock(®istry
->lock
);
497 * For a given application and session, push metadata to consumer. The session
498 * lock MUST be acquired here before calling this.
499 * Either sock or consumer is required : if sock is NULL, the default
500 * socket to send the metadata is retrieved from consumer, if sock
501 * is not NULL we use it to send the metadata.
503 * Return 0 on success else a negative error.
505 static int push_metadata(struct ust_registry_session
*registry
,
506 struct consumer_output
*consumer
)
510 struct consumer_socket
*socket
;
518 * Means that no metadata was assigned to the session. This can happens if
519 * no start has been done previously.
521 if (!registry
->metadata_key
) {
526 /* Get consumer socket to use to push the metadata.*/
527 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
531 goto error_rcu_unlock
;
535 * TODO: Currently, we hold the socket lock around sampling of the next
536 * metadata segment to ensure we send metadata over the consumer socket in
537 * the correct order. This makes the registry lock nest inside the socket
540 * Please note that this is a temporary measure: we should move this lock
541 * back into ust_consumer_push_metadata() when the consumer gets the
542 * ability to reorder the metadata it receives.
544 pthread_mutex_lock(socket
->lock
);
545 ret
= ust_app_push_metadata(registry
, socket
, 0);
546 pthread_mutex_unlock(socket
->lock
);
549 goto error_rcu_unlock
;
557 * On error, flag the registry that the metadata is closed. We were unable
558 * to push anything and this means that either the consumer is not
559 * responding or the metadata cache has been destroyed on the consumer.
561 registry
->metadata_closed
= 1;
568 * Send to the consumer a close metadata command for the given session. Once
569 * done, the metadata channel is deleted and the session metadata pointer is
570 * nullified. The session lock MUST be acquired here unless the application is
571 * in the destroy path.
573 * Return 0 on success else a negative value.
575 static int close_metadata(struct ust_registry_session
*registry
,
576 struct consumer_output
*consumer
)
579 struct consumer_socket
*socket
;
586 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
591 /* Get consumer socket to use to push the metadata.*/
592 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
599 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
606 * Metadata closed. Even on error this means that the consumer is not
607 * responding or not found so either way a second close should NOT be emit
610 registry
->metadata_closed
= 1;
617 * We need to execute ht_destroy outside of RCU read-side critical
618 * section and outside of call_rcu thread, so we postpone its execution
619 * using ht_cleanup_push. It is simpler than to change the semantic of
620 * the many callers of delete_ust_app_session().
623 void delete_ust_app_session_rcu(struct rcu_head
*head
)
625 struct ust_app_session
*ua_sess
=
626 caa_container_of(head
, struct ust_app_session
, rcu_head
);
628 ht_cleanup_push(ua_sess
->channels
);
633 * Delete ust app session safely. RCU read lock must be held before calling
637 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
641 struct lttng_ht_iter iter
;
642 struct ust_app_channel
*ua_chan
;
643 struct ust_registry_session
*registry
;
647 pthread_mutex_lock(&ua_sess
->lock
);
649 registry
= get_session_registry(ua_sess
);
650 if (registry
&& !registry
->metadata_closed
) {
651 /* Push metadata for application before freeing the application. */
652 (void) push_metadata(registry
, ua_sess
->consumer
);
655 * Don't ask to close metadata for global per UID buffers. Close
656 * metadata only on destroy trace session in this case. Also, the
657 * previous push metadata could have flag the metadata registry to
658 * close so don't send a close command if closed.
660 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
661 !registry
->metadata_closed
) {
662 /* And ask to close it for this session registry. */
663 (void) close_metadata(registry
, ua_sess
->consumer
);
667 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
669 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
671 delete_ust_app_channel(sock
, ua_chan
, app
);
674 /* In case of per PID, the registry is kept in the session. */
675 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
676 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
678 buffer_reg_pid_remove(reg_pid
);
679 buffer_reg_pid_destroy(reg_pid
);
683 if (ua_sess
->handle
!= -1) {
684 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
685 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
686 ERR("UST app sock %d release session handle failed with ret %d",
690 pthread_mutex_unlock(&ua_sess
->lock
);
692 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
696 * Delete a traceable application structure from the global list. Never call
697 * this function outside of a call_rcu call.
699 * RCU read side lock should _NOT_ be held when calling this function.
702 void delete_ust_app(struct ust_app
*app
)
705 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
707 /* Delete ust app sessions info */
712 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
714 /* Free every object in the session and the session. */
716 delete_ust_app_session(sock
, ua_sess
, app
);
720 ht_cleanup_push(app
->sessions
);
721 ht_cleanup_push(app
->ust_objd
);
724 * Wait until we have deleted the application from the sock hash table
725 * before closing this socket, otherwise an application could re-use the
726 * socket ID and race with the teardown, using the same hash table entry.
728 * It's OK to leave the close in call_rcu. We want it to stay unique for
729 * all RCU readers that could run concurrently with unregister app,
730 * therefore we _need_ to only close that socket after a grace period. So
731 * it should stay in this RCU callback.
733 * This close() is a very important step of the synchronization model so
734 * every modification to this function must be carefully reviewed.
740 lttng_fd_put(LTTNG_FD_APPS
, 1);
742 DBG2("UST app pid %d deleted", app
->pid
);
747 * URCU intermediate call to delete an UST app.
750 void delete_ust_app_rcu(struct rcu_head
*head
)
752 struct lttng_ht_node_ulong
*node
=
753 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
754 struct ust_app
*app
=
755 caa_container_of(node
, struct ust_app
, pid_n
);
757 DBG3("Call RCU deleting app PID %d", app
->pid
);
762 * Delete the session from the application ht and delete the data structure by
763 * freeing every object inside and releasing them.
765 static void destroy_app_session(struct ust_app
*app
,
766 struct ust_app_session
*ua_sess
)
769 struct lttng_ht_iter iter
;
774 iter
.iter
.node
= &ua_sess
->node
.node
;
775 ret
= lttng_ht_del(app
->sessions
, &iter
);
777 /* Already scheduled for teardown. */
781 /* Once deleted, free the data structure. */
782 delete_ust_app_session(app
->sock
, ua_sess
, app
);
789 * Alloc new UST app session.
792 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
794 struct ust_app_session
*ua_sess
;
796 /* Init most of the default value by allocating and zeroing */
797 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
798 if (ua_sess
== NULL
) {
803 ua_sess
->handle
= -1;
804 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
805 pthread_mutex_init(&ua_sess
->lock
, NULL
);
814 * Alloc new UST app channel.
817 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
818 struct ust_app_session
*ua_sess
,
819 struct lttng_ust_channel_attr
*attr
)
821 struct ust_app_channel
*ua_chan
;
823 /* Init most of the default value by allocating and zeroing */
824 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
825 if (ua_chan
== NULL
) {
830 /* Setup channel name */
831 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
832 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
834 ua_chan
->enabled
= 1;
835 ua_chan
->handle
= -1;
836 ua_chan
->session
= ua_sess
;
837 ua_chan
->key
= get_next_channel_key();
838 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
839 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
840 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
842 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
843 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
845 /* Copy attributes */
847 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
848 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
849 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
850 ua_chan
->attr
.overwrite
= attr
->overwrite
;
851 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
852 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
853 ua_chan
->attr
.output
= attr
->output
;
855 /* By default, the channel is a per cpu channel. */
856 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
858 DBG3("UST app channel %s allocated", ua_chan
->name
);
867 * Allocate and initialize a UST app stream.
869 * Return newly allocated stream pointer or NULL on error.
871 struct ust_app_stream
*ust_app_alloc_stream(void)
873 struct ust_app_stream
*stream
= NULL
;
875 stream
= zmalloc(sizeof(*stream
));
876 if (stream
== NULL
) {
877 PERROR("zmalloc ust app stream");
881 /* Zero could be a valid value for a handle so flag it to -1. */
889 * Alloc new UST app event.
892 struct ust_app_event
*alloc_ust_app_event(char *name
,
893 struct lttng_ust_event
*attr
)
895 struct ust_app_event
*ua_event
;
897 /* Init most of the default value by allocating and zeroing */
898 ua_event
= zmalloc(sizeof(struct ust_app_event
));
899 if (ua_event
== NULL
) {
904 ua_event
->enabled
= 1;
905 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
906 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
907 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
909 /* Copy attributes */
911 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
914 DBG3("UST app event %s allocated", ua_event
->name
);
923 * Alloc new UST app context.
926 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
928 struct ust_app_ctx
*ua_ctx
;
930 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
931 if (ua_ctx
== NULL
) {
935 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
938 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
941 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
948 * Allocate a filter and copy the given original filter.
950 * Return allocated filter or NULL on error.
952 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
953 struct lttng_ust_filter_bytecode
*orig_f
)
955 struct lttng_ust_filter_bytecode
*filter
= NULL
;
957 /* Copy filter bytecode */
958 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
960 PERROR("zmalloc alloc ust app filter");
964 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
971 * Find an ust_app using the sock and return it. RCU read side lock must be
972 * held before calling this helper function.
975 struct ust_app
*find_app_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
;
1521 switch (ua_sess
->buffer_type
) {
1522 case LTTNG_BUFFER_PER_PID
:
1523 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1524 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1527 case LTTNG_BUFFER_PER_UID
:
1528 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1529 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1536 PERROR("asprintf UST shadow copy session");
1541 /* Iterate over all channels in global domain. */
1542 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1544 struct lttng_ht_iter uiter
;
1546 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1547 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1548 if (ua_chan_node
!= NULL
) {
1549 /* Session exist. Contiuing. */
1553 DBG2("Channel %s not found on shadow session copy, creating it",
1555 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1556 if (ua_chan
== NULL
) {
1557 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1560 shadow_copy_channel(ua_chan
, uchan
);
1562 * The concept of metadata channel does not exist on the tracing
1563 * registry side of the session daemon so this can only be a per CPU
1564 * channel and not metadata.
1566 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1568 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1576 * Lookup sesison wrapper.
1579 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1580 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1582 /* Get right UST app session from app */
1583 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1587 * Return ust app session from the app session hashtable using the UST session
1590 static struct ust_app_session
*lookup_session_by_app(
1591 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1593 struct lttng_ht_iter iter
;
1594 struct lttng_ht_node_u64
*node
;
1596 __lookup_session_by_app(usess
, app
, &iter
);
1597 node
= lttng_ht_iter_get_node_u64(&iter
);
1602 return caa_container_of(node
, struct ust_app_session
, node
);
1609 * Setup buffer registry per PID for the given session and application. If none
1610 * is found, a new one is created, added to the global registry and
1611 * initialized. If regp is valid, it's set with the newly created object.
1613 * Return 0 on success or else a negative value.
1615 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1616 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1619 struct buffer_reg_pid
*reg_pid
;
1626 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1629 * This is the create channel path meaning that if there is NO
1630 * registry available, we have to create one for this session.
1632 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1636 buffer_reg_pid_add(reg_pid
);
1641 /* Initialize registry. */
1642 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1643 app
->bits_per_long
, app
->uint8_t_alignment
,
1644 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1645 app
->uint64_t_alignment
, app
->long_alignment
,
1646 app
->byte_order
, app
->version
.major
,
1647 app
->version
.minor
);
1652 DBG3("UST app buffer registry per PID created successfully");
1664 * Setup buffer registry per UID for the given session and application. If none
1665 * is found, a new one is created, added to the global registry and
1666 * initialized. If regp is valid, it's set with the newly created object.
1668 * Return 0 on success or else a negative value.
1670 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1671 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1674 struct buffer_reg_uid
*reg_uid
;
1681 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1684 * This is the create channel path meaning that if there is NO
1685 * registry available, we have to create one for this session.
1687 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1688 LTTNG_DOMAIN_UST
, ®_uid
);
1692 buffer_reg_uid_add(reg_uid
);
1697 /* Initialize registry. */
1698 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1699 app
->bits_per_long
, app
->uint8_t_alignment
,
1700 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1701 app
->uint64_t_alignment
, app
->long_alignment
,
1702 app
->byte_order
, app
->version
.major
,
1703 app
->version
.minor
);
1707 /* Add node to teardown list of the session. */
1708 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1710 DBG3("UST app buffer registry per UID created successfully");
1722 * Create a session on the tracer side for the given app.
1724 * On success, ua_sess_ptr is populated with the session pointer or else left
1725 * untouched. If the session was created, is_created is set to 1. On error,
1726 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1729 * Returns 0 on success or else a negative code which is either -ENOMEM or
1730 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1732 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1733 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1736 int ret
, created
= 0;
1737 struct ust_app_session
*ua_sess
;
1741 assert(ua_sess_ptr
);
1743 health_code_update();
1745 ua_sess
= lookup_session_by_app(usess
, app
);
1746 if (ua_sess
== NULL
) {
1747 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1748 app
->pid
, usess
->id
);
1749 ua_sess
= alloc_ust_app_session(app
);
1750 if (ua_sess
== NULL
) {
1751 /* Only malloc can failed so something is really wrong */
1755 shadow_copy_session(ua_sess
, usess
, app
);
1759 switch (usess
->buffer_type
) {
1760 case LTTNG_BUFFER_PER_PID
:
1761 /* Init local registry. */
1762 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1767 case LTTNG_BUFFER_PER_UID
:
1768 /* Look for a global registry. If none exists, create one. */
1769 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1780 health_code_update();
1782 if (ua_sess
->handle
== -1) {
1783 ret
= ustctl_create_session(app
->sock
);
1785 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1786 ERR("Creating session for app pid %d with ret %d",
1789 DBG("UST app creating session failed. Application is dead");
1791 * This is normal behavior, an application can die during the
1792 * creation process. Don't report an error so the execution can
1793 * continue normally. This will get flagged ENOTCONN and the
1794 * caller will handle it.
1798 delete_ust_app_session(-1, ua_sess
, app
);
1799 if (ret
!= -ENOMEM
) {
1801 * Tracer is probably gone or got an internal error so let's
1802 * behave like it will soon unregister or not usable.
1809 ua_sess
->handle
= ret
;
1811 /* Add ust app session to app's HT */
1812 lttng_ht_node_init_u64(&ua_sess
->node
,
1813 ua_sess
->tracing_id
);
1814 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1816 DBG2("UST app session created successfully with handle %d", ret
);
1819 *ua_sess_ptr
= ua_sess
;
1821 *is_created
= created
;
1824 /* Everything went well. */
1828 health_code_update();
1833 * Create a context for the channel on the tracer.
1835 * Called with UST app session lock held and a RCU read side lock.
1838 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1839 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1840 struct ust_app
*app
)
1843 struct lttng_ht_iter iter
;
1844 struct lttng_ht_node_ulong
*node
;
1845 struct ust_app_ctx
*ua_ctx
;
1847 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1849 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1850 node
= lttng_ht_iter_get_node_ulong(&iter
);
1856 ua_ctx
= alloc_ust_app_ctx(uctx
);
1857 if (ua_ctx
== NULL
) {
1863 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1864 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1865 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1867 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1877 * Enable on the tracer side a ust app event for the session and channel.
1879 * Called with UST app session lock held.
1882 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1883 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1887 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1892 ua_event
->enabled
= 1;
1899 * Disable on the tracer side a ust app event for the session and channel.
1901 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1902 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1906 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1911 ua_event
->enabled
= 0;
1918 * Lookup ust app channel for session and disable it on the tracer side.
1921 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1922 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1926 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1931 ua_chan
->enabled
= 0;
1938 * Lookup ust app channel for session and enable it on the tracer side. This
1939 * MUST be called with a RCU read side lock acquired.
1941 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1942 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1945 struct lttng_ht_iter iter
;
1946 struct lttng_ht_node_str
*ua_chan_node
;
1947 struct ust_app_channel
*ua_chan
;
1949 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1950 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1951 if (ua_chan_node
== NULL
) {
1952 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1953 uchan
->name
, ua_sess
->tracing_id
);
1957 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1959 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1969 * Ask the consumer to create a channel and get it if successful.
1971 * Return 0 on success or else a negative value.
1973 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1974 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1975 int bitness
, struct ust_registry_session
*registry
)
1978 unsigned int nb_fd
= 0;
1979 struct consumer_socket
*socket
;
1987 health_code_update();
1989 /* Get the right consumer socket for the application. */
1990 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1996 health_code_update();
1998 /* Need one fd for the channel. */
1999 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2001 ERR("Exhausted number of available FD upon create channel");
2006 * Ask consumer to create channel. The consumer will return the number of
2007 * stream we have to expect.
2009 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2016 * Compute the number of fd needed before receiving them. It must be 2 per
2017 * stream (2 being the default value here).
2019 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2021 /* Reserve the amount of file descriptor we need. */
2022 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2024 ERR("Exhausted number of available FD upon create channel");
2025 goto error_fd_get_stream
;
2028 health_code_update();
2031 * Now get the channel from the consumer. This call wil populate the stream
2032 * list of that channel and set the ust objects.
2034 if (usess
->consumer
->enabled
) {
2035 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2045 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2046 error_fd_get_stream
:
2048 * Initiate a destroy channel on the consumer since we had an error
2049 * handling it on our side. The return value is of no importance since we
2050 * already have a ret value set by the previous error that we need to
2053 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2055 lttng_fd_put(LTTNG_FD_APPS
, 1);
2057 health_code_update();
2063 * Duplicate the ust data object of the ust app stream and save it in the
2064 * buffer registry stream.
2066 * Return 0 on success or else a negative value.
2068 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2069 struct ust_app_stream
*stream
)
2076 /* Reserve the amount of file descriptor we need. */
2077 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2079 ERR("Exhausted number of available FD upon duplicate stream");
2083 /* Duplicate object for stream once the original is in the registry. */
2084 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2085 reg_stream
->obj
.ust
);
2087 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2088 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2089 lttng_fd_put(LTTNG_FD_APPS
, 2);
2092 stream
->handle
= stream
->obj
->handle
;
2099 * Duplicate the ust data object of the ust app. channel and save it in the
2100 * buffer registry channel.
2102 * Return 0 on success or else a negative value.
2104 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2105 struct ust_app_channel
*ua_chan
)
2112 /* Need two fds for the channel. */
2113 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2115 ERR("Exhausted number of available FD upon duplicate channel");
2119 /* Duplicate object for stream once the original is in the registry. */
2120 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2122 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2123 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2126 ua_chan
->handle
= ua_chan
->obj
->handle
;
2131 lttng_fd_put(LTTNG_FD_APPS
, 1);
2137 * For a given channel buffer registry, setup all streams of the given ust
2138 * application channel.
2140 * Return 0 on success or else a negative value.
2142 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2143 struct ust_app_channel
*ua_chan
)
2146 struct ust_app_stream
*stream
, *stmp
;
2151 DBG2("UST app setup buffer registry stream");
2153 /* Send all streams to application. */
2154 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2155 struct buffer_reg_stream
*reg_stream
;
2157 ret
= buffer_reg_stream_create(®_stream
);
2163 * Keep original pointer and nullify it in the stream so the delete
2164 * stream call does not release the object.
2166 reg_stream
->obj
.ust
= stream
->obj
;
2168 buffer_reg_stream_add(reg_stream
, reg_chan
);
2170 /* We don't need the streams anymore. */
2171 cds_list_del(&stream
->list
);
2172 delete_ust_app_stream(-1, stream
);
2180 * Create a buffer registry channel for the given session registry and
2181 * application channel object. If regp pointer is valid, it's set with the
2182 * created object. Important, the created object is NOT added to the session
2183 * registry hash table.
2185 * Return 0 on success else a negative value.
2187 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2188 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2191 struct buffer_reg_channel
*reg_chan
= NULL
;
2196 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2198 /* Create buffer registry channel. */
2199 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2204 reg_chan
->consumer_key
= ua_chan
->key
;
2206 /* Create and add a channel registry to session. */
2207 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2208 ua_chan
->tracing_channel_id
);
2212 buffer_reg_channel_add(reg_sess
, reg_chan
);
2221 /* Safe because the registry channel object was not added to any HT. */
2222 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2228 * Setup buffer registry channel for the given session registry and application
2229 * channel object. If regp pointer is valid, it's set with the created object.
2231 * Return 0 on success else a negative value.
2233 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2234 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2241 assert(ua_chan
->obj
);
2243 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2245 /* Setup all streams for the registry. */
2246 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2251 reg_chan
->obj
.ust
= ua_chan
->obj
;
2252 ua_chan
->obj
= NULL
;
2257 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2258 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2263 * Send buffer registry channel to the application.
2265 * Return 0 on success else a negative value.
2267 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2268 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2269 struct ust_app_channel
*ua_chan
)
2272 struct buffer_reg_stream
*reg_stream
;
2279 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2281 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2286 /* Send channel to the application. */
2287 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2292 health_code_update();
2294 /* Send all streams to application. */
2295 pthread_mutex_lock(®_chan
->stream_list_lock
);
2296 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2297 struct ust_app_stream stream
;
2299 ret
= duplicate_stream_object(reg_stream
, &stream
);
2301 goto error_stream_unlock
;
2304 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2306 (void) release_ust_app_stream(-1, &stream
);
2307 goto error_stream_unlock
;
2311 * The return value is not important here. This function will output an
2314 (void) release_ust_app_stream(-1, &stream
);
2316 ua_chan
->is_sent
= 1;
2318 error_stream_unlock
:
2319 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2325 * Create and send to the application the created buffers with per UID buffers.
2327 * Return 0 on success else a negative value.
2329 static int create_channel_per_uid(struct ust_app
*app
,
2330 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2331 struct ust_app_channel
*ua_chan
)
2334 struct buffer_reg_uid
*reg_uid
;
2335 struct buffer_reg_channel
*reg_chan
;
2342 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2344 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2346 * The session creation handles the creation of this global registry
2347 * object. If none can be find, there is a code flow problem or a
2352 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2355 /* Create the buffer registry channel object. */
2356 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2363 * Create the buffers on the consumer side. This call populates the
2364 * ust app channel object with all streams and data object.
2366 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2367 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2370 * Let's remove the previously created buffer registry channel so
2371 * it's not visible anymore in the session registry.
2373 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2374 ua_chan
->tracing_channel_id
);
2375 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2376 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2381 * Setup the streams and add it to the session registry.
2383 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2390 /* Send buffers to the application. */
2391 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2401 * Create and send to the application the created buffers with per PID buffers.
2403 * Return 0 on success else a negative value.
2405 static int create_channel_per_pid(struct ust_app
*app
,
2406 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2407 struct ust_app_channel
*ua_chan
)
2410 struct ust_registry_session
*registry
;
2417 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2421 registry
= get_session_registry(ua_sess
);
2424 /* Create and add a new channel registry to session. */
2425 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2430 /* Create and get channel on the consumer side. */
2431 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2432 app
->bits_per_long
, registry
);
2437 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2448 * From an already allocated ust app channel, create the channel buffers if
2449 * need and send it to the application. This MUST be called with a RCU read
2450 * side lock acquired.
2452 * Return 0 on success or else a negative value.
2454 static int do_create_channel(struct ust_app
*app
,
2455 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2456 struct ust_app_channel
*ua_chan
)
2465 /* Handle buffer type before sending the channel to the application. */
2466 switch (usess
->buffer_type
) {
2467 case LTTNG_BUFFER_PER_UID
:
2469 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2475 case LTTNG_BUFFER_PER_PID
:
2477 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2489 /* Initialize ust objd object using the received handle and add it. */
2490 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2491 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2493 /* If channel is not enabled, disable it on the tracer */
2494 if (!ua_chan
->enabled
) {
2495 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2506 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2507 * newly created channel if not NULL.
2509 * Called with UST app session lock and RCU read-side lock held.
2511 * Return 0 on success or else a negative value.
2513 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2514 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2515 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2516 struct ust_app_channel
**ua_chanp
)
2519 struct lttng_ht_iter iter
;
2520 struct lttng_ht_node_str
*ua_chan_node
;
2521 struct ust_app_channel
*ua_chan
;
2523 /* Lookup channel in the ust app session */
2524 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2525 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2526 if (ua_chan_node
!= NULL
) {
2527 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2531 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2532 if (ua_chan
== NULL
) {
2533 /* Only malloc can fail here */
2537 shadow_copy_channel(ua_chan
, uchan
);
2539 /* Set channel type. */
2540 ua_chan
->attr
.type
= type
;
2542 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2547 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2550 /* Only add the channel if successful on the tracer side. */
2551 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2555 *ua_chanp
= ua_chan
;
2558 /* Everything went well. */
2562 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2568 * Create UST app event and create it on the tracer side.
2570 * Called with ust app session mutex held.
2573 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2574 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2575 struct ust_app
*app
)
2578 struct ust_app_event
*ua_event
;
2580 /* Get event node */
2581 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2582 uevent
->filter
, uevent
->attr
.loglevel
);
2583 if (ua_event
!= NULL
) {
2588 /* Does not exist so create one */
2589 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2590 if (ua_event
== NULL
) {
2591 /* Only malloc can failed so something is really wrong */
2595 shadow_copy_event(ua_event
, uevent
);
2597 /* Create it on the tracer side */
2598 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2600 /* Not found previously means that it does not exist on the tracer */
2601 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2605 add_unique_ust_app_event(ua_chan
, ua_event
);
2607 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2614 /* Valid. Calling here is already in a read side lock */
2615 delete_ust_app_event(-1, ua_event
);
2620 * Create UST metadata and open it on the tracer side.
2622 * Called with UST app session lock held and RCU read side lock.
2624 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2625 struct ust_app
*app
, struct consumer_output
*consumer
,
2626 struct ustctl_consumer_channel_attr
*attr
)
2629 struct ust_app_channel
*metadata
;
2630 struct consumer_socket
*socket
;
2631 struct ust_registry_session
*registry
;
2637 registry
= get_session_registry(ua_sess
);
2640 /* Metadata already exists for this registry or it was closed previously */
2641 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2646 /* Allocate UST metadata */
2647 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2649 /* malloc() failed */
2655 /* Set default attributes for metadata. */
2656 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2657 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2658 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2659 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2660 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2661 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2662 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2664 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2665 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2666 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2669 /* Need one fd for the channel. */
2670 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2672 ERR("Exhausted number of available FD upon create metadata");
2676 /* Get the right consumer socket for the application. */
2677 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2680 goto error_consumer
;
2684 * Keep metadata key so we can identify it on the consumer side. Assign it
2685 * to the registry *before* we ask the consumer so we avoid the race of the
2686 * consumer requesting the metadata and the ask_channel call on our side
2687 * did not returned yet.
2689 registry
->metadata_key
= metadata
->key
;
2692 * Ask the metadata channel creation to the consumer. The metadata object
2693 * will be created by the consumer and kept their. However, the stream is
2694 * never added or monitored until we do a first push metadata to the
2697 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2700 /* Nullify the metadata key so we don't try to close it later on. */
2701 registry
->metadata_key
= 0;
2702 goto error_consumer
;
2706 * The setup command will make the metadata stream be sent to the relayd,
2707 * if applicable, and the thread managing the metadatas. This is important
2708 * because after this point, if an error occurs, the only way the stream
2709 * can be deleted is to be monitored in the consumer.
2711 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2713 /* Nullify the metadata key so we don't try to close it later on. */
2714 registry
->metadata_key
= 0;
2715 goto error_consumer
;
2718 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2719 metadata
->key
, app
->pid
);
2722 lttng_fd_put(LTTNG_FD_APPS
, 1);
2723 delete_ust_app_channel(-1, metadata
, app
);
2729 * Return pointer to traceable apps list.
2731 struct lttng_ht
*ust_app_get_ht(void)
2737 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2738 * acquired before calling this function.
2740 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2742 struct ust_app
*app
= NULL
;
2743 struct lttng_ht_node_ulong
*node
;
2744 struct lttng_ht_iter iter
;
2746 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2747 node
= lttng_ht_iter_get_node_ulong(&iter
);
2749 DBG2("UST app no found with pid %d", pid
);
2753 DBG2("Found UST app by pid %d", pid
);
2755 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2762 * Allocate and init an UST app object using the registration information and
2763 * the command socket. This is called when the command socket connects to the
2766 * The object is returned on success or else NULL.
2768 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2770 struct ust_app
*lta
= NULL
;
2775 DBG3("UST app creating application for socket %d", sock
);
2777 if ((msg
->bits_per_long
== 64 &&
2778 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2779 || (msg
->bits_per_long
== 32 &&
2780 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2781 ERR("Registration failed: application \"%s\" (pid: %d) has "
2782 "%d-bit long, but no consumerd for this size is available.\n",
2783 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2787 lta
= zmalloc(sizeof(struct ust_app
));
2793 lta
->ppid
= msg
->ppid
;
2794 lta
->uid
= msg
->uid
;
2795 lta
->gid
= msg
->gid
;
2797 lta
->bits_per_long
= msg
->bits_per_long
;
2798 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2799 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2800 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2801 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2802 lta
->long_alignment
= msg
->long_alignment
;
2803 lta
->byte_order
= msg
->byte_order
;
2805 lta
->v_major
= msg
->major
;
2806 lta
->v_minor
= msg
->minor
;
2807 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2808 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2809 lta
->notify_sock
= -1;
2811 /* Copy name and make sure it's NULL terminated. */
2812 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2813 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2816 * Before this can be called, when receiving the registration information,
2817 * the application compatibility is checked. So, at this point, the
2818 * application can work with this session daemon.
2820 lta
->compatible
= 1;
2822 lta
->pid
= msg
->pid
;
2823 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2825 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2827 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2834 * For a given application object, add it to every hash table.
2836 void ust_app_add(struct ust_app
*app
)
2839 assert(app
->notify_sock
>= 0);
2844 * On a re-registration, we want to kick out the previous registration of
2847 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2850 * The socket _should_ be unique until _we_ call close. So, a add_unique
2851 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2852 * already in the table.
2854 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2856 /* Add application to the notify socket hash table. */
2857 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2858 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2860 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2861 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2862 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2869 * Set the application version into the object.
2871 * Return 0 on success else a negative value either an errno code or a
2872 * LTTng-UST error code.
2874 int ust_app_version(struct ust_app
*app
)
2880 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2882 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2883 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2885 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2893 * Unregister app by removing it from the global traceable app list and freeing
2896 * The socket is already closed at this point so no close to sock.
2898 void ust_app_unregister(int sock
)
2900 struct ust_app
*lta
;
2901 struct lttng_ht_node_ulong
*node
;
2902 struct lttng_ht_iter iter
;
2903 struct ust_app_session
*ua_sess
;
2908 /* Get the node reference for a call_rcu */
2909 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2910 node
= lttng_ht_iter_get_node_ulong(&iter
);
2913 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2914 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2916 /* Remove application from PID hash table */
2917 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2921 * Remove application from notify hash table. The thread handling the
2922 * notify socket could have deleted the node so ignore on error because
2923 * either way it's valid. The close of that socket is handled by the other
2926 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2927 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2930 * Ignore return value since the node might have been removed before by an
2931 * add replace during app registration because the PID can be reassigned by
2934 iter
.iter
.node
= <a
->pid_n
.node
;
2935 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2937 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2941 /* Remove sessions so they are not visible during deletion.*/
2942 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2944 struct ust_registry_session
*registry
;
2946 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2948 /* The session was already removed so scheduled for teardown. */
2953 * Add session to list for teardown. This is safe since at this point we
2954 * are the only one using this list.
2956 pthread_mutex_lock(&ua_sess
->lock
);
2959 * Normally, this is done in the delete session process which is
2960 * executed in the call rcu below. However, upon registration we can't
2961 * afford to wait for the grace period before pushing data or else the
2962 * data pending feature can race between the unregistration and stop
2963 * command where the data pending command is sent *before* the grace
2966 * The close metadata below nullifies the metadata pointer in the
2967 * session so the delete session will NOT push/close a second time.
2969 registry
= get_session_registry(ua_sess
);
2970 if (registry
&& !registry
->metadata_closed
) {
2971 /* Push metadata for application before freeing the application. */
2972 (void) push_metadata(registry
, ua_sess
->consumer
);
2975 * Don't ask to close metadata for global per UID buffers. Close
2976 * metadata only on destroy trace session in this case. Also, the
2977 * previous push metadata could have flag the metadata registry to
2978 * close so don't send a close command if closed.
2980 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2981 !registry
->metadata_closed
) {
2982 /* And ask to close it for this session registry. */
2983 (void) close_metadata(registry
, ua_sess
->consumer
);
2987 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2988 pthread_mutex_unlock(&ua_sess
->lock
);
2992 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2999 * Return traceable_app_count
3001 unsigned long ust_app_list_count(void)
3003 unsigned long count
;
3006 count
= lttng_ht_get_count(ust_app_ht
);
3013 * Fill events array with all events name of all registered apps.
3015 int ust_app_list_events(struct lttng_event
**events
)
3018 size_t nbmem
, count
= 0;
3019 struct lttng_ht_iter iter
;
3020 struct ust_app
*app
;
3021 struct lttng_event
*tmp_event
;
3023 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3024 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3025 if (tmp_event
== NULL
) {
3026 PERROR("zmalloc ust app events");
3033 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3034 struct lttng_ust_tracepoint_iter uiter
;
3036 health_code_update();
3038 if (!app
->compatible
) {
3040 * TODO: In time, we should notice the caller of this error by
3041 * telling him that this is a version error.
3045 handle
= ustctl_tracepoint_list(app
->sock
);
3047 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3048 ERR("UST app list events getting handle failed for app pid %d",
3054 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3055 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3056 /* Handle ustctl error. */
3059 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3060 ERR("UST app tp list get failed for app %d with ret %d",
3063 DBG3("UST app tp list get failed. Application is dead");
3065 * This is normal behavior, an application can die during the
3066 * creation process. Don't report an error so the execution can
3067 * continue normally. Continue normal execution.
3074 health_code_update();
3075 if (count
>= nbmem
) {
3076 /* In case the realloc fails, we free the memory */
3079 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3082 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3084 PERROR("realloc ust app events");
3091 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3092 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3093 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3094 tmp_event
[count
].pid
= app
->pid
;
3095 tmp_event
[count
].enabled
= -1;
3101 *events
= tmp_event
;
3103 DBG2("UST app list events done (%zu events)", count
);
3108 health_code_update();
3113 * Fill events array with all events name of all registered apps.
3115 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3118 size_t nbmem
, count
= 0;
3119 struct lttng_ht_iter iter
;
3120 struct ust_app
*app
;
3121 struct lttng_event_field
*tmp_event
;
3123 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3124 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3125 if (tmp_event
== NULL
) {
3126 PERROR("zmalloc ust app event fields");
3133 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3134 struct lttng_ust_field_iter uiter
;
3136 health_code_update();
3138 if (!app
->compatible
) {
3140 * TODO: In time, we should notice the caller of this error by
3141 * telling him that this is a version error.
3145 handle
= ustctl_tracepoint_field_list(app
->sock
);
3147 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3148 ERR("UST app list field getting handle failed for app pid %d",
3154 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3155 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3156 /* Handle ustctl error. */
3159 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3160 ERR("UST app tp list field failed for app %d with ret %d",
3163 DBG3("UST app tp list field failed. Application is dead");
3165 * This is normal behavior, an application can die during the
3166 * creation process. Don't report an error so the execution can
3167 * continue normally.
3174 health_code_update();
3175 if (count
>= nbmem
) {
3176 /* In case the realloc fails, we free the memory */
3179 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3182 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3184 PERROR("realloc ust app event fields");
3192 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3193 /* Mapping between these enums matches 1 to 1. */
3194 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3195 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3197 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3198 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3199 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3200 tmp_event
[count
].event
.pid
= app
->pid
;
3201 tmp_event
[count
].event
.enabled
= -1;
3207 *fields
= tmp_event
;
3209 DBG2("UST app list event fields done (%zu events)", count
);
3214 health_code_update();
3219 * Free and clean all traceable apps of the global list.
3221 * Should _NOT_ be called with RCU read-side lock held.
3223 void ust_app_clean_list(void)
3226 struct ust_app
*app
;
3227 struct lttng_ht_iter iter
;
3229 DBG2("UST app cleaning registered apps hash table");
3233 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3234 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3236 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3239 /* Cleanup socket hash table */
3240 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3242 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3246 /* Cleanup notify socket hash table */
3247 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3248 notify_sock_n
.node
) {
3249 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3254 /* Destroy is done only when the ht is empty */
3255 ht_cleanup_push(ust_app_ht
);
3256 ht_cleanup_push(ust_app_ht_by_sock
);
3257 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3261 * Init UST app hash table.
3263 void ust_app_ht_alloc(void)
3265 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3266 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3267 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3271 * For a specific UST session, disable the channel for all registered apps.
3273 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3274 struct ltt_ust_channel
*uchan
)
3277 struct lttng_ht_iter iter
;
3278 struct lttng_ht_node_str
*ua_chan_node
;
3279 struct ust_app
*app
;
3280 struct ust_app_session
*ua_sess
;
3281 struct ust_app_channel
*ua_chan
;
3283 if (usess
== NULL
|| uchan
== NULL
) {
3284 ERR("Disabling UST global channel with NULL values");
3289 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3290 uchan
->name
, usess
->id
);
3294 /* For every registered applications */
3295 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3296 struct lttng_ht_iter uiter
;
3297 if (!app
->compatible
) {
3299 * TODO: In time, we should notice the caller of this error by
3300 * telling him that this is a version error.
3304 ua_sess
= lookup_session_by_app(usess
, app
);
3305 if (ua_sess
== NULL
) {
3310 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3311 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3312 /* If the session if found for the app, the channel must be there */
3313 assert(ua_chan_node
);
3315 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3316 /* The channel must not be already disabled */
3317 assert(ua_chan
->enabled
== 1);
3319 /* Disable channel onto application */
3320 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3322 /* XXX: We might want to report this error at some point... */
3334 * For a specific UST session, enable the channel for all registered apps.
3336 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3337 struct ltt_ust_channel
*uchan
)
3340 struct lttng_ht_iter iter
;
3341 struct ust_app
*app
;
3342 struct ust_app_session
*ua_sess
;
3344 if (usess
== NULL
|| uchan
== NULL
) {
3345 ERR("Adding UST global channel to NULL values");
3350 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3351 uchan
->name
, usess
->id
);
3355 /* For every registered applications */
3356 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3357 if (!app
->compatible
) {
3359 * TODO: In time, we should notice the caller of this error by
3360 * telling him that this is a version error.
3364 ua_sess
= lookup_session_by_app(usess
, app
);
3365 if (ua_sess
== NULL
) {
3369 /* Enable channel onto application */
3370 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3372 /* XXX: We might want to report this error at some point... */
3384 * Disable an event in a channel and for a specific session.
3386 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3387 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3390 struct lttng_ht_iter iter
, uiter
;
3391 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3392 struct ust_app
*app
;
3393 struct ust_app_session
*ua_sess
;
3394 struct ust_app_channel
*ua_chan
;
3395 struct ust_app_event
*ua_event
;
3397 DBG("UST app disabling event %s for all apps in channel "
3398 "%s for session id %" PRIu64
,
3399 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3403 /* For all registered applications */
3404 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3405 if (!app
->compatible
) {
3407 * TODO: In time, we should notice the caller of this error by
3408 * telling him that this is a version error.
3412 ua_sess
= lookup_session_by_app(usess
, app
);
3413 if (ua_sess
== NULL
) {
3418 /* Lookup channel in the ust app session */
3419 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3420 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3421 if (ua_chan_node
== NULL
) {
3422 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3423 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3426 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3428 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3429 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3430 if (ua_event_node
== NULL
) {
3431 DBG2("Event %s not found in channel %s for app pid %d."
3432 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3435 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3437 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3439 /* XXX: Report error someday... */
3450 * For a specific UST session and UST channel, the event for all
3453 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3454 struct ltt_ust_channel
*uchan
)
3457 struct lttng_ht_iter iter
, uiter
;
3458 struct lttng_ht_node_str
*ua_chan_node
;
3459 struct ust_app
*app
;
3460 struct ust_app_session
*ua_sess
;
3461 struct ust_app_channel
*ua_chan
;
3462 struct ust_app_event
*ua_event
;
3464 DBG("UST app disabling all event for all apps in channel "
3465 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3469 /* For all registered applications */
3470 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3471 if (!app
->compatible
) {
3473 * TODO: In time, we should notice the caller of this error by
3474 * telling him that this is a version error.
3478 ua_sess
= lookup_session_by_app(usess
, app
);
3480 /* The application has problem or is probably dead. */
3484 /* Lookup channel in the ust app session */
3485 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3486 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3487 /* If the channel is not found, there is a code flow error */
3488 assert(ua_chan_node
);
3490 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3492 /* Disable each events of channel */
3493 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3495 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3497 /* XXX: Report error someday... */
3509 * For a specific UST session, create the channel for all registered apps.
3511 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3512 struct ltt_ust_channel
*uchan
)
3514 int ret
= 0, created
;
3515 struct lttng_ht_iter iter
;
3516 struct ust_app
*app
;
3517 struct ust_app_session
*ua_sess
= NULL
;
3519 /* Very wrong code flow */
3523 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3524 uchan
->name
, usess
->id
);
3528 /* For every registered applications */
3529 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3530 if (!app
->compatible
) {
3532 * TODO: In time, we should notice the caller of this error by
3533 * telling him that this is a version error.
3538 * Create session on the tracer side and add it to app session HT. Note
3539 * that if session exist, it will simply return a pointer to the ust
3542 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3547 * The application's socket is not valid. Either a bad socket
3548 * or a timeout on it. We can't inform the caller that for a
3549 * specific app, the session failed so lets continue here.
3554 goto error_rcu_unlock
;
3559 pthread_mutex_lock(&ua_sess
->lock
);
3560 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3561 sizeof(uchan
->name
))) {
3562 struct ustctl_consumer_channel_attr attr
;
3563 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3564 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3567 /* Create channel onto application. We don't need the chan ref. */
3568 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3569 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3571 pthread_mutex_unlock(&ua_sess
->lock
);
3573 if (ret
== -ENOMEM
) {
3574 /* No more memory is a fatal error. Stop right now. */
3575 goto error_rcu_unlock
;
3577 /* Cleanup the created session if it's the case. */
3579 destroy_app_session(app
, ua_sess
);
3590 * Enable event for a specific session and channel on the tracer.
3592 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3593 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3596 struct lttng_ht_iter iter
, uiter
;
3597 struct lttng_ht_node_str
*ua_chan_node
;
3598 struct ust_app
*app
;
3599 struct ust_app_session
*ua_sess
;
3600 struct ust_app_channel
*ua_chan
;
3601 struct ust_app_event
*ua_event
;
3603 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3604 uevent
->attr
.name
, usess
->id
);
3607 * NOTE: At this point, this function is called only if the session and
3608 * channel passed are already created for all apps. and enabled on the
3614 /* For all registered applications */
3615 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3616 if (!app
->compatible
) {
3618 * TODO: In time, we should notice the caller of this error by
3619 * telling him that this is a version error.
3623 ua_sess
= lookup_session_by_app(usess
, app
);
3625 /* The application has problem or is probably dead. */
3629 pthread_mutex_lock(&ua_sess
->lock
);
3631 /* Lookup channel in the ust app session */
3632 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3633 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3634 /* If the channel is not found, there is a code flow error */
3635 assert(ua_chan_node
);
3637 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3639 /* Get event node */
3640 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3641 uevent
->filter
, uevent
->attr
.loglevel
);
3642 if (ua_event
== NULL
) {
3643 DBG3("UST app enable event %s not found for app PID %d."
3644 "Skipping app", uevent
->attr
.name
, app
->pid
);
3648 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3650 pthread_mutex_unlock(&ua_sess
->lock
);
3654 pthread_mutex_unlock(&ua_sess
->lock
);
3663 * For a specific existing UST session and UST channel, creates the event for
3664 * all registered apps.
3666 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3667 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3670 struct lttng_ht_iter iter
, uiter
;
3671 struct lttng_ht_node_str
*ua_chan_node
;
3672 struct ust_app
*app
;
3673 struct ust_app_session
*ua_sess
;
3674 struct ust_app_channel
*ua_chan
;
3676 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3677 uevent
->attr
.name
, usess
->id
);
3681 /* For all registered applications */
3682 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3683 if (!app
->compatible
) {
3685 * TODO: In time, we should notice the caller of this error by
3686 * telling him that this is a version error.
3690 ua_sess
= lookup_session_by_app(usess
, app
);
3692 /* The application has problem or is probably dead. */
3696 pthread_mutex_lock(&ua_sess
->lock
);
3697 /* Lookup channel in the ust app session */
3698 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3699 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3700 /* If the channel is not found, there is a code flow error */
3701 assert(ua_chan_node
);
3703 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3705 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3706 pthread_mutex_unlock(&ua_sess
->lock
);
3708 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3709 /* Possible value at this point: -ENOMEM. If so, we stop! */
3712 DBG2("UST app event %s already exist on app PID %d",
3713 uevent
->attr
.name
, app
->pid
);
3724 * Start tracing for a specific UST session and app.
3727 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3730 struct ust_app_session
*ua_sess
;
3732 DBG("Starting tracing for ust app pid %d", app
->pid
);
3736 if (!app
->compatible
) {
3740 ua_sess
= lookup_session_by_app(usess
, app
);
3741 if (ua_sess
== NULL
) {
3742 /* The session is in teardown process. Ignore and continue. */
3746 pthread_mutex_lock(&ua_sess
->lock
);
3748 /* Upon restart, we skip the setup, already done */
3749 if (ua_sess
->started
) {
3753 /* Create directories if consumer is LOCAL and has a path defined. */
3754 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3755 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3756 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3757 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3759 if (ret
!= -EEXIST
) {
3760 ERR("Trace directory creation error");
3767 * Create the metadata for the application. This returns gracefully if a
3768 * metadata was already set for the session.
3770 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3775 health_code_update();
3778 /* This start the UST tracing */
3779 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3781 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3782 ERR("Error starting tracing for app pid: %d (ret: %d)",
3785 DBG("UST app start session failed. Application is dead.");
3787 * This is normal behavior, an application can die during the
3788 * creation process. Don't report an error so the execution can
3789 * continue normally.
3791 pthread_mutex_unlock(&ua_sess
->lock
);
3797 /* Indicate that the session has been started once */
3798 ua_sess
->started
= 1;
3800 pthread_mutex_unlock(&ua_sess
->lock
);
3802 health_code_update();
3804 /* Quiescent wait after starting trace */
3805 ret
= ustctl_wait_quiescent(app
->sock
);
3806 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3807 ERR("UST app wait quiescent failed for app pid %d ret %d",
3813 health_code_update();
3817 pthread_mutex_unlock(&ua_sess
->lock
);
3819 health_code_update();
3824 * Stop tracing for a specific UST session and app.
3827 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3830 struct ust_app_session
*ua_sess
;
3831 struct ust_registry_session
*registry
;
3833 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3837 if (!app
->compatible
) {
3838 goto end_no_session
;
3841 ua_sess
= lookup_session_by_app(usess
, app
);
3842 if (ua_sess
== NULL
) {
3843 goto end_no_session
;
3846 pthread_mutex_lock(&ua_sess
->lock
);
3849 * If started = 0, it means that stop trace has been called for a session
3850 * that was never started. It's possible since we can have a fail start
3851 * from either the application manager thread or the command thread. Simply
3852 * indicate that this is a stop error.
3854 if (!ua_sess
->started
) {
3855 goto error_rcu_unlock
;
3858 health_code_update();
3860 /* This inhibits UST tracing */
3861 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3863 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3864 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3867 DBG("UST app stop session failed. Application is dead.");
3869 * This is normal behavior, an application can die during the
3870 * creation process. Don't report an error so the execution can
3871 * continue normally.
3875 goto error_rcu_unlock
;
3878 health_code_update();
3880 /* Quiescent wait after stopping trace */
3881 ret
= ustctl_wait_quiescent(app
->sock
);
3882 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3883 ERR("UST app wait quiescent failed for app pid %d ret %d",
3887 health_code_update();
3889 registry
= get_session_registry(ua_sess
);
3892 if (!registry
->metadata_closed
) {
3893 /* Push metadata for application before freeing the application. */
3894 (void) push_metadata(registry
, ua_sess
->consumer
);
3898 pthread_mutex_unlock(&ua_sess
->lock
);
3901 health_code_update();
3905 pthread_mutex_unlock(&ua_sess
->lock
);
3907 health_code_update();
3912 * Flush buffers for a specific UST session and app.
3915 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3918 struct lttng_ht_iter iter
;
3919 struct ust_app_session
*ua_sess
;
3920 struct ust_app_channel
*ua_chan
;
3922 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3926 if (!app
->compatible
) {
3927 goto end_no_session
;
3930 ua_sess
= lookup_session_by_app(usess
, app
);
3931 if (ua_sess
== NULL
) {
3932 goto end_no_session
;
3935 pthread_mutex_lock(&ua_sess
->lock
);
3937 health_code_update();
3939 /* Flushing buffers */
3940 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3942 health_code_update();
3943 assert(ua_chan
->is_sent
);
3944 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3946 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3947 ERR("UST app PID %d channel %s flush failed with ret %d",
3948 app
->pid
, ua_chan
->name
, ret
);
3950 DBG3("UST app failed to flush %s. Application is dead.",
3953 * This is normal behavior, an application can die during the
3954 * creation process. Don't report an error so the execution can
3955 * continue normally.
3958 /* Continuing flushing all buffers */
3963 health_code_update();
3965 pthread_mutex_unlock(&ua_sess
->lock
);
3968 health_code_update();
3973 * Destroy a specific UST session in apps.
3975 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3978 struct ust_app_session
*ua_sess
;
3979 struct lttng_ht_iter iter
;
3980 struct lttng_ht_node_u64
*node
;
3982 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3986 if (!app
->compatible
) {
3990 __lookup_session_by_app(usess
, app
, &iter
);
3991 node
= lttng_ht_iter_get_node_u64(&iter
);
3993 /* Session is being or is deleted. */
3996 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3998 health_code_update();
3999 destroy_app_session(app
, ua_sess
);
4001 health_code_update();
4003 /* Quiescent wait after stopping trace */
4004 ret
= ustctl_wait_quiescent(app
->sock
);
4005 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4006 ERR("UST app wait quiescent failed for app pid %d ret %d",
4011 health_code_update();
4016 * Start tracing for the UST session.
4018 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4021 struct lttng_ht_iter iter
;
4022 struct ust_app
*app
;
4024 DBG("Starting all UST traces");
4028 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4029 ret
= ust_app_start_trace(usess
, app
);
4031 /* Continue to next apps even on error */
4042 * Start tracing for the UST session.
4044 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4047 struct lttng_ht_iter iter
;
4048 struct ust_app
*app
;
4050 DBG("Stopping all UST traces");
4054 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4055 ret
= ust_app_stop_trace(usess
, app
);
4057 /* Continue to next apps even on error */
4062 /* Flush buffers and push metadata (for UID buffers). */
4063 switch (usess
->buffer_type
) {
4064 case LTTNG_BUFFER_PER_UID
:
4066 struct buffer_reg_uid
*reg
;
4068 /* Flush all per UID buffers associated to that session. */
4069 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4070 struct ust_registry_session
*ust_session_reg
;
4071 struct buffer_reg_channel
*reg_chan
;
4072 struct consumer_socket
*socket
;
4074 /* Get consumer socket to use to push the metadata.*/
4075 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4078 /* Ignore request if no consumer is found for the session. */
4082 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4083 reg_chan
, node
.node
) {
4085 * The following call will print error values so the return
4086 * code is of little importance because whatever happens, we
4087 * have to try them all.
4089 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4092 ust_session_reg
= reg
->registry
->reg
.ust
;
4093 if (!ust_session_reg
->metadata_closed
) {
4094 /* Push metadata. */
4095 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4101 case LTTNG_BUFFER_PER_PID
:
4102 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4103 ret
= ust_app_flush_trace(usess
, app
);
4105 /* Continue to next apps even on error */
4121 * Destroy app UST session.
4123 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4126 struct lttng_ht_iter iter
;
4127 struct ust_app
*app
;
4129 DBG("Destroy all UST traces");
4133 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4134 ret
= destroy_trace(usess
, app
);
4136 /* Continue to next apps even on error */
4147 * Add channels/events from UST global domain to registered apps at sock.
4149 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4152 struct lttng_ht_iter iter
, uiter
;
4153 struct ust_app
*app
;
4154 struct ust_app_session
*ua_sess
= NULL
;
4155 struct ust_app_channel
*ua_chan
;
4156 struct ust_app_event
*ua_event
;
4157 struct ust_app_ctx
*ua_ctx
;
4162 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4167 app
= find_app_by_sock(sock
);
4170 * Application can be unregistered before so this is possible hence
4171 * simply stopping the update.
4173 DBG3("UST app update failed to find app sock %d", sock
);
4177 if (!app
->compatible
) {
4181 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4183 /* Tracer is probably gone or ENOMEM. */
4188 pthread_mutex_lock(&ua_sess
->lock
);
4191 * We can iterate safely here over all UST app session since the create ust
4192 * app session above made a shadow copy of the UST global domain from the
4195 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4198 * For a metadata channel, handle it differently.
4200 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4201 sizeof(ua_chan
->name
))) {
4202 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4207 /* Remove it from the hash table and continue!. */
4208 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4210 delete_ust_app_channel(-1, ua_chan
, app
);
4213 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4216 * Stop everything. On error, the application failed, no more
4217 * file descriptor are available or ENOMEM so stopping here is
4218 * the only thing we can do for now.
4225 * Add context using the list so they are enabled in the same order the
4228 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4229 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4236 /* For each events */
4237 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4239 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4246 pthread_mutex_unlock(&ua_sess
->lock
);
4248 if (usess
->start_trace
) {
4249 ret
= ust_app_start_trace(usess
, app
);
4254 DBG2("UST trace started for app pid %d", app
->pid
);
4257 /* Everything went well at this point. */
4262 pthread_mutex_unlock(&ua_sess
->lock
);
4265 destroy_app_session(app
, ua_sess
);
4272 * Add context to a specific channel for global UST domain.
4274 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4275 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4278 struct lttng_ht_node_str
*ua_chan_node
;
4279 struct lttng_ht_iter iter
, uiter
;
4280 struct ust_app_channel
*ua_chan
= NULL
;
4281 struct ust_app_session
*ua_sess
;
4282 struct ust_app
*app
;
4286 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4287 if (!app
->compatible
) {
4289 * TODO: In time, we should notice the caller of this error by
4290 * telling him that this is a version error.
4294 ua_sess
= lookup_session_by_app(usess
, app
);
4295 if (ua_sess
== NULL
) {
4299 pthread_mutex_lock(&ua_sess
->lock
);
4300 /* Lookup channel in the ust app session */
4301 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4302 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4303 if (ua_chan_node
== NULL
) {
4306 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4308 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4313 pthread_mutex_unlock(&ua_sess
->lock
);
4321 * Enable event for a channel from a UST session for a specific PID.
4323 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4324 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4327 struct lttng_ht_iter iter
;
4328 struct lttng_ht_node_str
*ua_chan_node
;
4329 struct ust_app
*app
;
4330 struct ust_app_session
*ua_sess
;
4331 struct ust_app_channel
*ua_chan
;
4332 struct ust_app_event
*ua_event
;
4334 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4338 app
= ust_app_find_by_pid(pid
);
4340 ERR("UST app enable event per PID %d not found", pid
);
4345 if (!app
->compatible
) {
4350 ua_sess
= lookup_session_by_app(usess
, app
);
4352 /* The application has problem or is probably dead. */
4357 pthread_mutex_lock(&ua_sess
->lock
);
4358 /* Lookup channel in the ust app session */
4359 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4360 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4361 /* If the channel is not found, there is a code flow error */
4362 assert(ua_chan_node
);
4364 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4366 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4367 uevent
->filter
, uevent
->attr
.loglevel
);
4368 if (ua_event
== NULL
) {
4369 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4374 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4381 pthread_mutex_unlock(&ua_sess
->lock
);
4388 * Disable event for a channel from a UST session for a specific PID.
4390 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4391 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4394 struct lttng_ht_iter iter
;
4395 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4396 struct ust_app
*app
;
4397 struct ust_app_session
*ua_sess
;
4398 struct ust_app_channel
*ua_chan
;
4399 struct ust_app_event
*ua_event
;
4401 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4405 app
= ust_app_find_by_pid(pid
);
4407 ERR("UST app disable event per PID %d not found", pid
);
4412 if (!app
->compatible
) {
4417 ua_sess
= lookup_session_by_app(usess
, app
);
4419 /* The application has problem or is probably dead. */
4423 /* Lookup channel in the ust app session */
4424 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4425 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4426 if (ua_chan_node
== NULL
) {
4427 /* Channel does not exist, skip disabling */
4430 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4432 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4433 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4434 if (ua_event_node
== NULL
) {
4435 /* Event does not exist, skip disabling */
4438 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4440 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4451 * Calibrate registered applications.
4453 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4456 struct lttng_ht_iter iter
;
4457 struct ust_app
*app
;
4461 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4462 if (!app
->compatible
) {
4464 * TODO: In time, we should notice the caller of this error by
4465 * telling him that this is a version error.
4470 health_code_update();
4472 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4476 /* Means that it's not implemented on the tracer side. */
4480 DBG2("Calibrate app PID %d returned with error %d",
4487 DBG("UST app global domain calibration finished");
4491 health_code_update();
4497 * Receive registration and populate the given msg structure.
4499 * On success return 0 else a negative value returned by the ustctl call.
4501 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4504 uint32_t pid
, ppid
, uid
, gid
;
4508 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4509 &pid
, &ppid
, &uid
, &gid
,
4510 &msg
->bits_per_long
,
4511 &msg
->uint8_t_alignment
,
4512 &msg
->uint16_t_alignment
,
4513 &msg
->uint32_t_alignment
,
4514 &msg
->uint64_t_alignment
,
4515 &msg
->long_alignment
,
4522 case LTTNG_UST_ERR_EXITING
:
4523 DBG3("UST app recv reg message failed. Application died");
4525 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4526 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4527 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4528 LTTNG_UST_ABI_MINOR_VERSION
);
4531 ERR("UST app recv reg message failed with ret %d", ret
);
4536 msg
->pid
= (pid_t
) pid
;
4537 msg
->ppid
= (pid_t
) ppid
;
4538 msg
->uid
= (uid_t
) uid
;
4539 msg
->gid
= (gid_t
) gid
;
4546 * Return a ust app channel object using the application object and the channel
4547 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4548 * lock MUST be acquired before calling this function.
4550 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4553 struct lttng_ht_node_ulong
*node
;
4554 struct lttng_ht_iter iter
;
4555 struct ust_app_channel
*ua_chan
= NULL
;
4559 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4560 node
= lttng_ht_iter_get_node_ulong(&iter
);
4562 DBG2("UST app channel find by objd %d not found", objd
);
4566 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4573 * Reply to a register channel notification from an application on the notify
4574 * socket. The channel metadata is also created.
4576 * The session UST registry lock is acquired in this function.
4578 * On success 0 is returned else a negative value.
4580 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4581 size_t nr_fields
, struct ustctl_field
*fields
)
4583 int ret
, ret_code
= 0;
4584 uint32_t chan_id
, reg_count
;
4585 uint64_t chan_reg_key
;
4586 enum ustctl_channel_header type
;
4587 struct ust_app
*app
;
4588 struct ust_app_channel
*ua_chan
;
4589 struct ust_app_session
*ua_sess
;
4590 struct ust_registry_session
*registry
;
4591 struct ust_registry_channel
*chan_reg
;
4595 /* Lookup application. If not found, there is a code flow error. */
4596 app
= find_app_by_notify_sock(sock
);
4598 DBG("Application socket %d is being teardown. Abort event notify",
4602 goto error_rcu_unlock
;
4605 /* Lookup channel by UST object descriptor. */
4606 ua_chan
= find_channel_by_objd(app
, cobjd
);
4608 DBG("Application channel is being teardown. Abort event notify");
4611 goto error_rcu_unlock
;
4614 assert(ua_chan
->session
);
4615 ua_sess
= ua_chan
->session
;
4617 /* Get right session registry depending on the session buffer type. */
4618 registry
= get_session_registry(ua_sess
);
4621 /* Depending on the buffer type, a different channel key is used. */
4622 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4623 chan_reg_key
= ua_chan
->tracing_channel_id
;
4625 chan_reg_key
= ua_chan
->key
;
4628 pthread_mutex_lock(®istry
->lock
);
4630 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4633 if (!chan_reg
->register_done
) {
4634 reg_count
= ust_registry_get_event_count(chan_reg
);
4635 if (reg_count
< 31) {
4636 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4638 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4641 chan_reg
->nr_ctx_fields
= nr_fields
;
4642 chan_reg
->ctx_fields
= fields
;
4643 chan_reg
->header_type
= type
;
4645 /* Get current already assigned values. */
4646 type
= chan_reg
->header_type
;
4648 /* Set to NULL so the error path does not do a double free. */
4651 /* Channel id is set during the object creation. */
4652 chan_id
= chan_reg
->chan_id
;
4654 /* Append to metadata */
4655 if (!chan_reg
->metadata_dumped
) {
4656 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4658 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4664 DBG3("UST app replying to register channel key %" PRIu64
4665 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4668 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4670 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4671 ERR("UST app reply channel failed with ret %d", ret
);
4673 DBG3("UST app reply channel failed. Application died");
4678 /* This channel registry registration is completed. */
4679 chan_reg
->register_done
= 1;
4682 pthread_mutex_unlock(®istry
->lock
);
4692 * Add event to the UST channel registry. When the event is added to the
4693 * registry, the metadata is also created. Once done, this replies to the
4694 * application with the appropriate error code.
4696 * The session UST registry lock is acquired in the function.
4698 * On success 0 is returned else a negative value.
4700 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4701 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4702 char *model_emf_uri
)
4705 uint32_t event_id
= 0;
4706 uint64_t chan_reg_key
;
4707 struct ust_app
*app
;
4708 struct ust_app_channel
*ua_chan
;
4709 struct ust_app_session
*ua_sess
;
4710 struct ust_registry_session
*registry
;
4714 /* Lookup application. If not found, there is a code flow error. */
4715 app
= find_app_by_notify_sock(sock
);
4717 DBG("Application socket %d is being teardown. Abort event notify",
4722 free(model_emf_uri
);
4723 goto error_rcu_unlock
;
4726 /* Lookup channel by UST object descriptor. */
4727 ua_chan
= find_channel_by_objd(app
, cobjd
);
4729 DBG("Application channel is being teardown. Abort event notify");
4733 free(model_emf_uri
);
4734 goto error_rcu_unlock
;
4737 assert(ua_chan
->session
);
4738 ua_sess
= ua_chan
->session
;
4740 registry
= get_session_registry(ua_sess
);
4743 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4744 chan_reg_key
= ua_chan
->tracing_channel_id
;
4746 chan_reg_key
= ua_chan
->key
;
4749 pthread_mutex_lock(®istry
->lock
);
4752 * From this point on, this call acquires the ownership of the sig, fields
4753 * and model_emf_uri meaning any free are done inside it if needed. These
4754 * three variables MUST NOT be read/write after this.
4756 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4757 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4758 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4762 * The return value is returned to ustctl so in case of an error, the
4763 * application can be notified. In case of an error, it's important not to
4764 * return a negative error or else the application will get closed.
4766 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4768 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4769 ERR("UST app reply event failed with ret %d", ret
);
4771 DBG3("UST app reply event failed. Application died");
4774 * No need to wipe the create event since the application socket will
4775 * get close on error hence cleaning up everything by itself.
4780 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4784 pthread_mutex_unlock(®istry
->lock
);
4791 * Handle application notification through the given notify socket.
4793 * Return 0 on success or else a negative value.
4795 int ust_app_recv_notify(int sock
)
4798 enum ustctl_notify_cmd cmd
;
4800 DBG3("UST app receiving notify from sock %d", sock
);
4802 ret
= ustctl_recv_notify(sock
, &cmd
);
4804 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4805 ERR("UST app recv notify failed with ret %d", ret
);
4807 DBG3("UST app recv notify failed. Application died");
4813 case USTCTL_NOTIFY_CMD_EVENT
:
4815 int sobjd
, cobjd
, loglevel
;
4816 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4818 struct ustctl_field
*fields
;
4820 DBG2("UST app ustctl register event received");
4822 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4823 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4825 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4826 ERR("UST app recv event failed with ret %d", ret
);
4828 DBG3("UST app recv event failed. Application died");
4834 * Add event to the UST registry coming from the notify socket. This
4835 * call will free if needed the sig, fields and model_emf_uri. This
4836 * code path loses the ownsership of these variables and transfer them
4837 * to the this function.
4839 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4840 fields
, loglevel
, model_emf_uri
);
4847 case USTCTL_NOTIFY_CMD_CHANNEL
:
4851 struct ustctl_field
*fields
;
4853 DBG2("UST app ustctl register channel received");
4855 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4858 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4859 ERR("UST app recv channel failed with ret %d", ret
);
4861 DBG3("UST app recv channel failed. Application died");
4867 * The fields ownership are transfered to this function call meaning
4868 * that if needed it will be freed. After this, it's invalid to access
4869 * fields or clean it up.
4871 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4880 /* Should NEVER happen. */
4889 * Once the notify socket hangs up, this is called. First, it tries to find the
4890 * corresponding application. On failure, the call_rcu to close the socket is
4891 * executed. If an application is found, it tries to delete it from the notify
4892 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4894 * Note that an object needs to be allocated here so on ENOMEM failure, the
4895 * call RCU is not done but the rest of the cleanup is.
4897 void ust_app_notify_sock_unregister(int sock
)
4900 struct lttng_ht_iter iter
;
4901 struct ust_app
*app
;
4902 struct ust_app_notify_sock_obj
*obj
;
4908 obj
= zmalloc(sizeof(*obj
));
4911 * An ENOMEM is kind of uncool. If this strikes we continue the
4912 * procedure but the call_rcu will not be called. In this case, we
4913 * accept the fd leak rather than possibly creating an unsynchronized
4914 * state between threads.
4916 * TODO: The notify object should be created once the notify socket is
4917 * registered and stored independantely from the ust app object. The
4918 * tricky part is to synchronize the teardown of the application and
4919 * this notify object. Let's keep that in mind so we can avoid this
4920 * kind of shenanigans with ENOMEM in the teardown path.
4927 DBG("UST app notify socket unregister %d", sock
);
4930 * Lookup application by notify socket. If this fails, this means that the
4931 * hash table delete has already been done by the application
4932 * unregistration process so we can safely close the notify socket in a
4935 app
= find_app_by_notify_sock(sock
);
4940 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4943 * Whatever happens here either we fail or succeed, in both cases we have
4944 * to close the socket after a grace period to continue to the call RCU
4945 * here. If the deletion is successful, the application is not visible
4946 * anymore by other threads and is it fails it means that it was already
4947 * deleted from the hash table so either way we just have to close the
4950 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4956 * Close socket after a grace period to avoid for the socket to be reused
4957 * before the application object is freed creating potential race between
4958 * threads trying to add unique in the global hash table.
4961 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4966 * Destroy a ust app data structure and free its memory.
4968 void ust_app_destroy(struct ust_app
*app
)
4974 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);