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 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
394 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
395 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
396 ERR("UST app sock %d release channel obj failed with ret %d",
399 lttng_fd_put(LTTNG_FD_APPS
, 1);
402 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
406 * Push metadata to consumer socket.
408 * The socket lock MUST be acquired.
409 * The ust app session lock MUST be acquired.
411 * On success, return the len of metadata pushed or else a negative value.
413 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
414 struct consumer_socket
*socket
, int send_zero_data
)
417 char *metadata_str
= NULL
;
425 * On a push metadata error either the consumer is dead or the metadata
426 * channel has been destroyed because its endpoint might have died (e.g:
427 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
428 * metadata again which is not valid anymore on the consumer side.
430 * The ust app session mutex locked allows us to make this check without
433 if (registry
->metadata_closed
) {
437 pthread_mutex_lock(®istry
->lock
);
439 offset
= registry
->metadata_len_sent
;
440 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
442 DBG3("No metadata to push for metadata key %" PRIu64
,
443 registry
->metadata_key
);
445 if (send_zero_data
) {
446 DBG("No metadata to push");
452 /* Allocate only what we have to send. */
453 metadata_str
= zmalloc(len
);
455 PERROR("zmalloc ust app metadata string");
459 /* Copy what we haven't send out. */
460 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
461 registry
->metadata_len_sent
+= len
;
464 pthread_mutex_unlock(®istry
->lock
);
465 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
466 metadata_str
, len
, offset
);
469 * There is an acceptable race here between the registry metadata key
470 * assignment and the creation on the consumer. The session daemon can
471 * concurrently push metadata for this registry while being created on
472 * the consumer since the metadata key of the registry is assigned
473 * *before* it is setup to avoid the consumer to ask for metadata that
474 * could possibly be not found in the session daemon.
476 * The metadata will get pushed either by the session being stopped or
477 * the consumer requesting metadata if that race is triggered.
479 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
483 /* Update back the actual metadata len sent since it failed here. */
484 pthread_mutex_lock(®istry
->lock
);
485 registry
->metadata_len_sent
-= len
;
486 pthread_mutex_unlock(®istry
->lock
);
496 pthread_mutex_unlock(®istry
->lock
);
503 * For a given application and session, push metadata to consumer. The session
504 * lock MUST be acquired here before calling this.
505 * Either sock or consumer is required : if sock is NULL, the default
506 * socket to send the metadata is retrieved from consumer, if sock
507 * is not NULL we use it to send the metadata.
509 * Return 0 on success else a negative error.
511 static int push_metadata(struct ust_registry_session
*registry
,
512 struct consumer_output
*consumer
)
516 struct consumer_socket
*socket
;
524 * Means that no metadata was assigned to the session. This can happens if
525 * no start has been done previously.
527 if (!registry
->metadata_key
) {
532 /* Get consumer socket to use to push the metadata.*/
533 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
537 goto error_rcu_unlock
;
541 * TODO: Currently, we hold the socket lock around sampling of the next
542 * metadata segment to ensure we send metadata over the consumer socket in
543 * the correct order. This makes the registry lock nest inside the socket
546 * Please note that this is a temporary measure: we should move this lock
547 * back into ust_consumer_push_metadata() when the consumer gets the
548 * ability to reorder the metadata it receives.
550 pthread_mutex_lock(socket
->lock
);
551 ret
= ust_app_push_metadata(registry
, socket
, 0);
552 pthread_mutex_unlock(socket
->lock
);
555 goto error_rcu_unlock
;
563 * On error, flag the registry that the metadata is closed. We were unable
564 * to push anything and this means that either the consumer is not
565 * responding or the metadata cache has been destroyed on the consumer.
567 registry
->metadata_closed
= 1;
574 * Send to the consumer a close metadata command for the given session. Once
575 * done, the metadata channel is deleted and the session metadata pointer is
576 * nullified. The session lock MUST be acquired here unless the application is
577 * in the destroy path.
579 * Return 0 on success else a negative value.
581 static int close_metadata(struct ust_registry_session
*registry
,
582 struct consumer_output
*consumer
)
585 struct consumer_socket
*socket
;
592 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
597 /* Get consumer socket to use to push the metadata.*/
598 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
605 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
612 * Metadata closed. Even on error this means that the consumer is not
613 * responding or not found so either way a second close should NOT be emit
616 registry
->metadata_closed
= 1;
623 * We need to execute ht_destroy outside of RCU read-side critical
624 * section and outside of call_rcu thread, so we postpone its execution
625 * using ht_cleanup_push. It is simpler than to change the semantic of
626 * the many callers of delete_ust_app_session().
629 void delete_ust_app_session_rcu(struct rcu_head
*head
)
631 struct ust_app_session
*ua_sess
=
632 caa_container_of(head
, struct ust_app_session
, rcu_head
);
634 ht_cleanup_push(ua_sess
->channels
);
639 * Delete ust app session safely. RCU read lock must be held before calling
643 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
647 struct lttng_ht_iter iter
;
648 struct ust_app_channel
*ua_chan
;
649 struct ust_registry_session
*registry
;
653 pthread_mutex_lock(&ua_sess
->lock
);
655 registry
= get_session_registry(ua_sess
);
656 if (registry
&& !registry
->metadata_closed
) {
657 /* Push metadata for application before freeing the application. */
658 (void) push_metadata(registry
, ua_sess
->consumer
);
661 * Don't ask to close metadata for global per UID buffers. Close
662 * metadata only on destroy trace session in this case. Also, the
663 * previous push metadata could have flag the metadata registry to
664 * close so don't send a close command if closed.
666 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
667 !registry
->metadata_closed
) {
668 /* And ask to close it for this session registry. */
669 (void) close_metadata(registry
, ua_sess
->consumer
);
673 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
675 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
677 delete_ust_app_channel(sock
, ua_chan
, app
);
680 /* In case of per PID, the registry is kept in the session. */
681 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
682 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
684 buffer_reg_pid_remove(reg_pid
);
685 buffer_reg_pid_destroy(reg_pid
);
689 if (ua_sess
->handle
!= -1) {
690 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
691 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
692 ERR("UST app sock %d release session handle failed with ret %d",
696 pthread_mutex_unlock(&ua_sess
->lock
);
698 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
702 * Delete a traceable application structure from the global list. Never call
703 * this function outside of a call_rcu call.
705 * RCU read side lock should _NOT_ be held when calling this function.
708 void delete_ust_app(struct ust_app
*app
)
711 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
713 /* Delete ust app sessions info */
718 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
720 /* Free every object in the session and the session. */
722 delete_ust_app_session(sock
, ua_sess
, app
);
726 ht_cleanup_push(app
->sessions
);
727 ht_cleanup_push(app
->ust_objd
);
730 * Wait until we have deleted the application from the sock hash table
731 * before closing this socket, otherwise an application could re-use the
732 * socket ID and race with the teardown, using the same hash table entry.
734 * It's OK to leave the close in call_rcu. We want it to stay unique for
735 * all RCU readers that could run concurrently with unregister app,
736 * therefore we _need_ to only close that socket after a grace period. So
737 * it should stay in this RCU callback.
739 * This close() is a very important step of the synchronization model so
740 * every modification to this function must be carefully reviewed.
746 lttng_fd_put(LTTNG_FD_APPS
, 1);
748 DBG2("UST app pid %d deleted", app
->pid
);
753 * URCU intermediate call to delete an UST app.
756 void delete_ust_app_rcu(struct rcu_head
*head
)
758 struct lttng_ht_node_ulong
*node
=
759 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
760 struct ust_app
*app
=
761 caa_container_of(node
, struct ust_app
, pid_n
);
763 DBG3("Call RCU deleting app PID %d", app
->pid
);
768 * Delete the session from the application ht and delete the data structure by
769 * freeing every object inside and releasing them.
771 static void destroy_app_session(struct ust_app
*app
,
772 struct ust_app_session
*ua_sess
)
775 struct lttng_ht_iter iter
;
780 iter
.iter
.node
= &ua_sess
->node
.node
;
781 ret
= lttng_ht_del(app
->sessions
, &iter
);
783 /* Already scheduled for teardown. */
787 /* Once deleted, free the data structure. */
788 delete_ust_app_session(app
->sock
, ua_sess
, app
);
795 * Alloc new UST app session.
798 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
800 struct ust_app_session
*ua_sess
;
802 /* Init most of the default value by allocating and zeroing */
803 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
804 if (ua_sess
== NULL
) {
809 ua_sess
->handle
= -1;
810 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
811 pthread_mutex_init(&ua_sess
->lock
, NULL
);
820 * Alloc new UST app channel.
823 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
824 struct ust_app_session
*ua_sess
,
825 struct lttng_ust_channel_attr
*attr
)
827 struct ust_app_channel
*ua_chan
;
829 /* Init most of the default value by allocating and zeroing */
830 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
831 if (ua_chan
== NULL
) {
836 /* Setup channel name */
837 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
838 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
840 ua_chan
->enabled
= 1;
841 ua_chan
->handle
= -1;
842 ua_chan
->session
= ua_sess
;
843 ua_chan
->key
= get_next_channel_key();
844 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
845 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
846 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
848 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
849 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
851 /* Copy attributes */
853 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
854 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
855 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
856 ua_chan
->attr
.overwrite
= attr
->overwrite
;
857 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
858 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
859 ua_chan
->attr
.output
= attr
->output
;
861 /* By default, the channel is a per cpu channel. */
862 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
864 DBG3("UST app channel %s allocated", ua_chan
->name
);
873 * Allocate and initialize a UST app stream.
875 * Return newly allocated stream pointer or NULL on error.
877 struct ust_app_stream
*ust_app_alloc_stream(void)
879 struct ust_app_stream
*stream
= NULL
;
881 stream
= zmalloc(sizeof(*stream
));
882 if (stream
== NULL
) {
883 PERROR("zmalloc ust app stream");
887 /* Zero could be a valid value for a handle so flag it to -1. */
895 * Alloc new UST app event.
898 struct ust_app_event
*alloc_ust_app_event(char *name
,
899 struct lttng_ust_event
*attr
)
901 struct ust_app_event
*ua_event
;
903 /* Init most of the default value by allocating and zeroing */
904 ua_event
= zmalloc(sizeof(struct ust_app_event
));
905 if (ua_event
== NULL
) {
910 ua_event
->enabled
= 1;
911 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
912 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
913 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
915 /* Copy attributes */
917 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
920 DBG3("UST app event %s allocated", ua_event
->name
);
929 * Alloc new UST app context.
932 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
934 struct ust_app_ctx
*ua_ctx
;
936 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
937 if (ua_ctx
== NULL
) {
941 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
944 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
947 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
954 * Allocate a filter and copy the given original filter.
956 * Return allocated filter or NULL on error.
958 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
959 struct lttng_ust_filter_bytecode
*orig_f
)
961 struct lttng_ust_filter_bytecode
*filter
= NULL
;
963 /* Copy filter bytecode */
964 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
966 PERROR("zmalloc alloc ust app filter");
970 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
977 * Find an ust_app using the sock and return it. RCU read side lock must be
978 * held before calling this helper function.
981 struct ust_app
*find_app_by_sock(int sock
)
983 struct lttng_ht_node_ulong
*node
;
984 struct lttng_ht_iter iter
;
986 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
987 node
= lttng_ht_iter_get_node_ulong(&iter
);
989 DBG2("UST app find by sock %d not found", sock
);
993 return caa_container_of(node
, struct ust_app
, sock_n
);
1000 * Find an ust_app using the notify sock and return it. RCU read side lock must
1001 * be held before calling this helper function.
1003 static struct ust_app
*find_app_by_notify_sock(int sock
)
1005 struct lttng_ht_node_ulong
*node
;
1006 struct lttng_ht_iter iter
;
1008 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1010 node
= lttng_ht_iter_get_node_ulong(&iter
);
1012 DBG2("UST app find by notify sock %d not found", sock
);
1016 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1023 * Lookup for an ust app event based on event name, filter bytecode and the
1026 * Return an ust_app_event object or NULL on error.
1028 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1029 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1031 struct lttng_ht_iter iter
;
1032 struct lttng_ht_node_str
*node
;
1033 struct ust_app_event
*event
= NULL
;
1034 struct ust_app_ht_key key
;
1039 /* Setup key for event lookup. */
1041 key
.filter
= filter
;
1042 key
.loglevel
= loglevel
;
1044 /* Lookup using the event name as hash and a custom match fct. */
1045 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1046 ht_match_ust_app_event
, &key
, &iter
.iter
);
1047 node
= lttng_ht_iter_get_node_str(&iter
);
1052 event
= caa_container_of(node
, struct ust_app_event
, node
);
1059 * Create the channel context on the tracer.
1061 * Called with UST app session lock held.
1064 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1065 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1069 health_code_update();
1071 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1072 ua_chan
->obj
, &ua_ctx
->obj
);
1074 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1075 ERR("UST app create channel context failed for app (pid: %d) "
1076 "with ret %d", app
->pid
, ret
);
1079 * This is normal behavior, an application can die during the
1080 * creation process. Don't report an error so the execution can
1081 * continue normally.
1084 DBG3("UST app disable event failed. Application is dead.");
1089 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1091 DBG2("UST app context handle %d created successfully for channel %s",
1092 ua_ctx
->handle
, ua_chan
->name
);
1095 health_code_update();
1100 * Set the filter on the tracer.
1103 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1104 struct ust_app
*app
)
1108 health_code_update();
1110 if (!ua_event
->filter
) {
1115 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1118 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1119 ERR("UST app event %s filter failed for app (pid: %d) "
1120 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1123 * This is normal behavior, an application can die during the
1124 * creation process. Don't report an error so the execution can
1125 * continue normally.
1128 DBG3("UST app filter event failed. Application is dead.");
1133 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1136 health_code_update();
1141 * Disable the specified event on to UST tracer for the UST session.
1143 static int disable_ust_event(struct ust_app
*app
,
1144 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1148 health_code_update();
1150 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1152 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1153 ERR("UST app event %s disable failed for app (pid: %d) "
1154 "and session handle %d with ret %d",
1155 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1158 * This is normal behavior, an application can die during the
1159 * creation process. Don't report an error so the execution can
1160 * continue normally.
1163 DBG3("UST app disable event failed. Application is dead.");
1168 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1169 ua_event
->attr
.name
, app
->pid
);
1172 health_code_update();
1177 * Disable the specified channel on to UST tracer for the UST session.
1179 static int disable_ust_channel(struct ust_app
*app
,
1180 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1184 health_code_update();
1186 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1188 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1189 ERR("UST app channel %s disable failed for app (pid: %d) "
1190 "and session handle %d with ret %d",
1191 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1194 * This is normal behavior, an application can die during the
1195 * creation process. Don't report an error so the execution can
1196 * continue normally.
1199 DBG3("UST app disable channel failed. Application is dead.");
1204 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1205 ua_chan
->name
, app
->pid
);
1208 health_code_update();
1213 * Enable the specified channel on to UST tracer for the UST session.
1215 static int enable_ust_channel(struct ust_app
*app
,
1216 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1220 health_code_update();
1222 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1224 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1225 ERR("UST app channel %s enable failed for app (pid: %d) "
1226 "and session handle %d with ret %d",
1227 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1230 * This is normal behavior, an application can die during the
1231 * creation process. Don't report an error so the execution can
1232 * continue normally.
1235 DBG3("UST app enable channel failed. Application is dead.");
1240 ua_chan
->enabled
= 1;
1242 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1243 ua_chan
->name
, app
->pid
);
1246 health_code_update();
1251 * Enable the specified event on to UST tracer for the UST session.
1253 static int enable_ust_event(struct ust_app
*app
,
1254 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1258 health_code_update();
1260 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1262 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1263 ERR("UST app event %s enable failed for app (pid: %d) "
1264 "and session handle %d with ret %d",
1265 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1268 * This is normal behavior, an application can die during the
1269 * creation process. Don't report an error so the execution can
1270 * continue normally.
1273 DBG3("UST app enable event failed. Application is dead.");
1278 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1279 ua_event
->attr
.name
, app
->pid
);
1282 health_code_update();
1287 * Send channel and stream buffer to application.
1289 * Return 0 on success. On error, a negative value is returned.
1291 static int send_channel_pid_to_ust(struct ust_app
*app
,
1292 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1295 struct ust_app_stream
*stream
, *stmp
;
1301 health_code_update();
1303 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1306 /* Send channel to the application. */
1307 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1312 health_code_update();
1314 /* Send all streams to application. */
1315 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1316 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1320 /* We don't need the stream anymore once sent to the tracer. */
1321 cds_list_del(&stream
->list
);
1322 delete_ust_app_stream(-1, stream
);
1324 /* Flag the channel that it is sent to the application. */
1325 ua_chan
->is_sent
= 1;
1328 health_code_update();
1333 * Create the specified event onto the UST tracer for a UST session.
1335 * Should be called with session mutex held.
1338 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1339 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1343 health_code_update();
1345 /* Create UST event on tracer */
1346 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1349 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1350 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1351 ua_event
->attr
.name
, app
->pid
, ret
);
1354 * This is normal behavior, an application can die during the
1355 * creation process. Don't report an error so the execution can
1356 * continue normally.
1359 DBG3("UST app create event failed. Application is dead.");
1364 ua_event
->handle
= ua_event
->obj
->handle
;
1366 DBG2("UST app event %s created successfully for pid:%d",
1367 ua_event
->attr
.name
, app
->pid
);
1369 health_code_update();
1371 /* Set filter if one is present. */
1372 if (ua_event
->filter
) {
1373 ret
= set_ust_event_filter(ua_event
, app
);
1379 /* If event not enabled, disable it on the tracer */
1380 if (ua_event
->enabled
== 0) {
1381 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1384 * If we hit an EPERM, something is wrong with our disable call. If
1385 * we get an EEXIST, there is a problem on the tracer side since we
1389 case -LTTNG_UST_ERR_PERM
:
1390 /* Code flow problem */
1392 case -LTTNG_UST_ERR_EXIST
:
1393 /* It's OK for our use case. */
1404 health_code_update();
1409 * Copy data between an UST app event and a LTT event.
1411 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1412 struct ltt_ust_event
*uevent
)
1414 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1415 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1417 ua_event
->enabled
= uevent
->enabled
;
1419 /* Copy event attributes */
1420 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1422 /* Copy filter bytecode */
1423 if (uevent
->filter
) {
1424 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1425 /* Filter might be NULL here in case of ENONEM. */
1430 * Copy data between an UST app channel and a LTT channel.
1432 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1433 struct ltt_ust_channel
*uchan
)
1435 struct lttng_ht_iter iter
;
1436 struct ltt_ust_event
*uevent
;
1437 struct ltt_ust_context
*uctx
;
1438 struct ust_app_event
*ua_event
;
1439 struct ust_app_ctx
*ua_ctx
;
1441 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1443 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1444 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1446 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1447 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1449 /* Copy event attributes since the layout is different. */
1450 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1451 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1452 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1453 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1454 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1455 ua_chan
->attr
.output
= uchan
->attr
.output
;
1457 * Note that the attribute channel type is not set since the channel on the
1458 * tracing registry side does not have this information.
1461 ua_chan
->enabled
= uchan
->enabled
;
1462 ua_chan
->tracing_channel_id
= uchan
->id
;
1464 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1465 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1466 if (ua_ctx
== NULL
) {
1469 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1470 (unsigned long) ua_ctx
->ctx
.ctx
);
1471 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1472 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1475 /* Copy all events from ltt ust channel to ust app channel */
1476 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1477 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1478 uevent
->filter
, uevent
->attr
.loglevel
);
1479 if (ua_event
== NULL
) {
1480 DBG2("UST event %s not found on shadow copy channel",
1482 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1483 if (ua_event
== NULL
) {
1486 shadow_copy_event(ua_event
, uevent
);
1487 add_unique_ust_app_event(ua_chan
, ua_event
);
1491 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1495 * Copy data between a UST app session and a regular LTT session.
1497 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1498 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1500 struct lttng_ht_node_str
*ua_chan_node
;
1501 struct lttng_ht_iter iter
;
1502 struct ltt_ust_channel
*uchan
;
1503 struct ust_app_channel
*ua_chan
;
1505 struct tm
*timeinfo
;
1509 /* Get date and time for unique app path */
1511 timeinfo
= localtime(&rawtime
);
1512 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1514 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1516 ua_sess
->tracing_id
= usess
->id
;
1517 ua_sess
->id
= get_next_session_id();
1518 ua_sess
->uid
= app
->uid
;
1519 ua_sess
->gid
= app
->gid
;
1520 ua_sess
->euid
= usess
->uid
;
1521 ua_sess
->egid
= usess
->gid
;
1522 ua_sess
->buffer_type
= usess
->buffer_type
;
1523 ua_sess
->bits_per_long
= app
->bits_per_long
;
1524 /* There is only one consumer object per session possible. */
1525 ua_sess
->consumer
= usess
->consumer
;
1527 switch (ua_sess
->buffer_type
) {
1528 case LTTNG_BUFFER_PER_PID
:
1529 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1530 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1533 case LTTNG_BUFFER_PER_UID
:
1534 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1535 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1542 PERROR("asprintf UST shadow copy session");
1547 /* Iterate over all channels in global domain. */
1548 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1550 struct lttng_ht_iter uiter
;
1552 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1553 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1554 if (ua_chan_node
!= NULL
) {
1555 /* Session exist. Contiuing. */
1559 DBG2("Channel %s not found on shadow session copy, creating it",
1561 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1562 if (ua_chan
== NULL
) {
1563 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1566 shadow_copy_channel(ua_chan
, uchan
);
1568 * The concept of metadata channel does not exist on the tracing
1569 * registry side of the session daemon so this can only be a per CPU
1570 * channel and not metadata.
1572 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1574 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1582 * Lookup sesison wrapper.
1585 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1586 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1588 /* Get right UST app session from app */
1589 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1593 * Return ust app session from the app session hashtable using the UST session
1596 static struct ust_app_session
*lookup_session_by_app(
1597 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1599 struct lttng_ht_iter iter
;
1600 struct lttng_ht_node_u64
*node
;
1602 __lookup_session_by_app(usess
, app
, &iter
);
1603 node
= lttng_ht_iter_get_node_u64(&iter
);
1608 return caa_container_of(node
, struct ust_app_session
, node
);
1615 * Setup buffer registry per PID for the given session and application. If none
1616 * is found, a new one is created, added to the global registry and
1617 * initialized. If regp is valid, it's set with the newly created object.
1619 * Return 0 on success or else a negative value.
1621 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1622 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1625 struct buffer_reg_pid
*reg_pid
;
1632 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1635 * This is the create channel path meaning that if there is NO
1636 * registry available, we have to create one for this session.
1638 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1642 buffer_reg_pid_add(reg_pid
);
1647 /* Initialize registry. */
1648 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1649 app
->bits_per_long
, app
->uint8_t_alignment
,
1650 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1651 app
->uint64_t_alignment
, app
->long_alignment
,
1652 app
->byte_order
, app
->version
.major
,
1653 app
->version
.minor
);
1658 DBG3("UST app buffer registry per PID created successfully");
1670 * Setup buffer registry per UID for the given session and application. If none
1671 * is found, a new one is created, added to the global registry and
1672 * initialized. If regp is valid, it's set with the newly created object.
1674 * Return 0 on success or else a negative value.
1676 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1677 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1680 struct buffer_reg_uid
*reg_uid
;
1687 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1690 * This is the create channel path meaning that if there is NO
1691 * registry available, we have to create one for this session.
1693 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1694 LTTNG_DOMAIN_UST
, ®_uid
);
1698 buffer_reg_uid_add(reg_uid
);
1703 /* Initialize registry. */
1704 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1705 app
->bits_per_long
, app
->uint8_t_alignment
,
1706 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1707 app
->uint64_t_alignment
, app
->long_alignment
,
1708 app
->byte_order
, app
->version
.major
,
1709 app
->version
.minor
);
1713 /* Add node to teardown list of the session. */
1714 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1716 DBG3("UST app buffer registry per UID created successfully");
1728 * Create a session on the tracer side for the given app.
1730 * On success, ua_sess_ptr is populated with the session pointer or else left
1731 * untouched. If the session was created, is_created is set to 1. On error,
1732 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1735 * Returns 0 on success or else a negative code which is either -ENOMEM or
1736 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1738 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1739 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1742 int ret
, created
= 0;
1743 struct ust_app_session
*ua_sess
;
1747 assert(ua_sess_ptr
);
1749 health_code_update();
1751 ua_sess
= lookup_session_by_app(usess
, app
);
1752 if (ua_sess
== NULL
) {
1753 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1754 app
->pid
, usess
->id
);
1755 ua_sess
= alloc_ust_app_session(app
);
1756 if (ua_sess
== NULL
) {
1757 /* Only malloc can failed so something is really wrong */
1761 shadow_copy_session(ua_sess
, usess
, app
);
1765 switch (usess
->buffer_type
) {
1766 case LTTNG_BUFFER_PER_PID
:
1767 /* Init local registry. */
1768 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1773 case LTTNG_BUFFER_PER_UID
:
1774 /* Look for a global registry. If none exists, create one. */
1775 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1786 health_code_update();
1788 if (ua_sess
->handle
== -1) {
1789 ret
= ustctl_create_session(app
->sock
);
1791 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1792 ERR("Creating session for app pid %d with ret %d",
1795 DBG("UST app creating session failed. Application is dead");
1797 * This is normal behavior, an application can die during the
1798 * creation process. Don't report an error so the execution can
1799 * continue normally. This will get flagged ENOTCONN and the
1800 * caller will handle it.
1804 delete_ust_app_session(-1, ua_sess
, app
);
1805 if (ret
!= -ENOMEM
) {
1807 * Tracer is probably gone or got an internal error so let's
1808 * behave like it will soon unregister or not usable.
1815 ua_sess
->handle
= ret
;
1817 /* Add ust app session to app's HT */
1818 lttng_ht_node_init_u64(&ua_sess
->node
,
1819 ua_sess
->tracing_id
);
1820 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1822 DBG2("UST app session created successfully with handle %d", ret
);
1825 *ua_sess_ptr
= ua_sess
;
1827 *is_created
= created
;
1830 /* Everything went well. */
1834 health_code_update();
1839 * Create a context for the channel on the tracer.
1841 * Called with UST app session lock held and a RCU read side lock.
1844 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1845 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1846 struct ust_app
*app
)
1849 struct lttng_ht_iter iter
;
1850 struct lttng_ht_node_ulong
*node
;
1851 struct ust_app_ctx
*ua_ctx
;
1853 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1855 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1856 node
= lttng_ht_iter_get_node_ulong(&iter
);
1862 ua_ctx
= alloc_ust_app_ctx(uctx
);
1863 if (ua_ctx
== NULL
) {
1869 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1870 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1871 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1873 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1883 * Enable on the tracer side a ust app event for the session and channel.
1885 * Called with UST app session lock held.
1888 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1889 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1893 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1898 ua_event
->enabled
= 1;
1905 * Disable on the tracer side a ust app event for the session and channel.
1907 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1908 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1912 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1917 ua_event
->enabled
= 0;
1924 * Lookup ust app channel for session and disable it on the tracer side.
1927 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1928 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1932 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1937 ua_chan
->enabled
= 0;
1944 * Lookup ust app channel for session and enable it on the tracer side. This
1945 * MUST be called with a RCU read side lock acquired.
1947 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1948 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1951 struct lttng_ht_iter iter
;
1952 struct lttng_ht_node_str
*ua_chan_node
;
1953 struct ust_app_channel
*ua_chan
;
1955 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1956 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1957 if (ua_chan_node
== NULL
) {
1958 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1959 uchan
->name
, ua_sess
->tracing_id
);
1963 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1965 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1975 * Ask the consumer to create a channel and get it if successful.
1977 * Return 0 on success or else a negative value.
1979 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1980 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1981 int bitness
, struct ust_registry_session
*registry
)
1984 unsigned int nb_fd
= 0;
1985 struct consumer_socket
*socket
;
1993 health_code_update();
1995 /* Get the right consumer socket for the application. */
1996 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2002 health_code_update();
2004 /* Need one fd for the channel. */
2005 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2007 ERR("Exhausted number of available FD upon create channel");
2012 * Ask consumer to create channel. The consumer will return the number of
2013 * stream we have to expect.
2015 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2022 * Compute the number of fd needed before receiving them. It must be 2 per
2023 * stream (2 being the default value here).
2025 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2027 /* Reserve the amount of file descriptor we need. */
2028 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2030 ERR("Exhausted number of available FD upon create channel");
2031 goto error_fd_get_stream
;
2034 health_code_update();
2037 * Now get the channel from the consumer. This call wil populate the stream
2038 * list of that channel and set the ust objects.
2040 if (usess
->consumer
->enabled
) {
2041 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2051 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2052 error_fd_get_stream
:
2054 * Initiate a destroy channel on the consumer since we had an error
2055 * handling it on our side. The return value is of no importance since we
2056 * already have a ret value set by the previous error that we need to
2059 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2061 lttng_fd_put(LTTNG_FD_APPS
, 1);
2063 health_code_update();
2069 * Duplicate the ust data object of the ust app stream and save it in the
2070 * buffer registry stream.
2072 * Return 0 on success or else a negative value.
2074 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2075 struct ust_app_stream
*stream
)
2082 /* Reserve the amount of file descriptor we need. */
2083 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2085 ERR("Exhausted number of available FD upon duplicate stream");
2089 /* Duplicate object for stream once the original is in the registry. */
2090 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2091 reg_stream
->obj
.ust
);
2093 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2094 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2095 lttng_fd_put(LTTNG_FD_APPS
, 2);
2098 stream
->handle
= stream
->obj
->handle
;
2105 * Duplicate the ust data object of the ust app. channel and save it in the
2106 * buffer registry channel.
2108 * Return 0 on success or else a negative value.
2110 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2111 struct ust_app_channel
*ua_chan
)
2118 /* Need two fds for the channel. */
2119 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2121 ERR("Exhausted number of available FD upon duplicate channel");
2125 /* Duplicate object for stream once the original is in the registry. */
2126 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2128 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2129 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2132 ua_chan
->handle
= ua_chan
->obj
->handle
;
2137 lttng_fd_put(LTTNG_FD_APPS
, 1);
2143 * For a given channel buffer registry, setup all streams of the given ust
2144 * application channel.
2146 * Return 0 on success or else a negative value.
2148 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2149 struct ust_app_channel
*ua_chan
)
2152 struct ust_app_stream
*stream
, *stmp
;
2157 DBG2("UST app setup buffer registry stream");
2159 /* Send all streams to application. */
2160 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2161 struct buffer_reg_stream
*reg_stream
;
2163 ret
= buffer_reg_stream_create(®_stream
);
2169 * Keep original pointer and nullify it in the stream so the delete
2170 * stream call does not release the object.
2172 reg_stream
->obj
.ust
= stream
->obj
;
2174 buffer_reg_stream_add(reg_stream
, reg_chan
);
2176 /* We don't need the streams anymore. */
2177 cds_list_del(&stream
->list
);
2178 delete_ust_app_stream(-1, stream
);
2186 * Create a buffer registry channel for the given session registry and
2187 * application channel object. If regp pointer is valid, it's set with the
2188 * created object. Important, the created object is NOT added to the session
2189 * registry hash table.
2191 * Return 0 on success else a negative value.
2193 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2194 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2197 struct buffer_reg_channel
*reg_chan
= NULL
;
2202 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2204 /* Create buffer registry channel. */
2205 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2210 reg_chan
->consumer_key
= ua_chan
->key
;
2212 /* Create and add a channel registry to session. */
2213 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2214 ua_chan
->tracing_channel_id
);
2218 buffer_reg_channel_add(reg_sess
, reg_chan
);
2227 /* Safe because the registry channel object was not added to any HT. */
2228 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2234 * Setup buffer registry channel for the given session registry and application
2235 * channel object. If regp pointer is valid, it's set with the created object.
2237 * Return 0 on success else a negative value.
2239 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2240 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2247 assert(ua_chan
->obj
);
2249 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2251 /* Setup all streams for the registry. */
2252 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2257 reg_chan
->obj
.ust
= ua_chan
->obj
;
2258 ua_chan
->obj
= NULL
;
2263 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2264 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2269 * Send buffer registry channel to the application.
2271 * Return 0 on success else a negative value.
2273 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2274 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2275 struct ust_app_channel
*ua_chan
)
2278 struct buffer_reg_stream
*reg_stream
;
2285 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2287 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2292 /* Send channel to the application. */
2293 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2298 health_code_update();
2300 /* Send all streams to application. */
2301 pthread_mutex_lock(®_chan
->stream_list_lock
);
2302 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2303 struct ust_app_stream stream
;
2305 ret
= duplicate_stream_object(reg_stream
, &stream
);
2307 goto error_stream_unlock
;
2310 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2312 (void) release_ust_app_stream(-1, &stream
);
2313 goto error_stream_unlock
;
2317 * The return value is not important here. This function will output an
2320 (void) release_ust_app_stream(-1, &stream
);
2322 ua_chan
->is_sent
= 1;
2324 error_stream_unlock
:
2325 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2331 * Create and send to the application the created buffers with per UID buffers.
2333 * Return 0 on success else a negative value.
2335 static int create_channel_per_uid(struct ust_app
*app
,
2336 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2337 struct ust_app_channel
*ua_chan
)
2340 struct buffer_reg_uid
*reg_uid
;
2341 struct buffer_reg_channel
*reg_chan
;
2348 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2350 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2352 * The session creation handles the creation of this global registry
2353 * object. If none can be find, there is a code flow problem or a
2358 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2361 /* Create the buffer registry channel object. */
2362 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2369 * Create the buffers on the consumer side. This call populates the
2370 * ust app channel object with all streams and data object.
2372 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2373 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2376 * Let's remove the previously created buffer registry channel so
2377 * it's not visible anymore in the session registry.
2379 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2380 ua_chan
->tracing_channel_id
);
2381 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2382 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2387 * Setup the streams and add it to the session registry.
2389 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2396 /* Send buffers to the application. */
2397 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2407 * Create and send to the application the created buffers with per PID buffers.
2409 * Return 0 on success else a negative value.
2411 static int create_channel_per_pid(struct ust_app
*app
,
2412 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2413 struct ust_app_channel
*ua_chan
)
2416 struct ust_registry_session
*registry
;
2423 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2427 registry
= get_session_registry(ua_sess
);
2430 /* Create and add a new channel registry to session. */
2431 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2436 /* Create and get channel on the consumer side. */
2437 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2438 app
->bits_per_long
, registry
);
2443 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2454 * From an already allocated ust app channel, create the channel buffers if
2455 * need and send it to the application. This MUST be called with a RCU read
2456 * side lock acquired.
2458 * Return 0 on success or else a negative value.
2460 static int do_create_channel(struct ust_app
*app
,
2461 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2462 struct ust_app_channel
*ua_chan
)
2471 /* Handle buffer type before sending the channel to the application. */
2472 switch (usess
->buffer_type
) {
2473 case LTTNG_BUFFER_PER_UID
:
2475 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2481 case LTTNG_BUFFER_PER_PID
:
2483 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2495 /* Initialize ust objd object using the received handle and add it. */
2496 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2497 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2499 /* If channel is not enabled, disable it on the tracer */
2500 if (!ua_chan
->enabled
) {
2501 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2512 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2513 * newly created channel if not NULL.
2515 * Called with UST app session lock and RCU read-side lock held.
2517 * Return 0 on success or else a negative value.
2519 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2520 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2521 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2522 struct ust_app_channel
**ua_chanp
)
2525 struct lttng_ht_iter iter
;
2526 struct lttng_ht_node_str
*ua_chan_node
;
2527 struct ust_app_channel
*ua_chan
;
2529 /* Lookup channel in the ust app session */
2530 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2531 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2532 if (ua_chan_node
!= NULL
) {
2533 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2537 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2538 if (ua_chan
== NULL
) {
2539 /* Only malloc can fail here */
2543 shadow_copy_channel(ua_chan
, uchan
);
2545 /* Set channel type. */
2546 ua_chan
->attr
.type
= type
;
2548 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2553 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2556 /* Only add the channel if successful on the tracer side. */
2557 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2561 *ua_chanp
= ua_chan
;
2564 /* Everything went well. */
2568 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2574 * Create UST app event and create it on the tracer side.
2576 * Called with ust app session mutex held.
2579 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2580 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2581 struct ust_app
*app
)
2584 struct ust_app_event
*ua_event
;
2586 /* Get event node */
2587 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2588 uevent
->filter
, uevent
->attr
.loglevel
);
2589 if (ua_event
!= NULL
) {
2594 /* Does not exist so create one */
2595 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2596 if (ua_event
== NULL
) {
2597 /* Only malloc can failed so something is really wrong */
2601 shadow_copy_event(ua_event
, uevent
);
2603 /* Create it on the tracer side */
2604 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2606 /* Not found previously means that it does not exist on the tracer */
2607 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2611 add_unique_ust_app_event(ua_chan
, ua_event
);
2613 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2620 /* Valid. Calling here is already in a read side lock */
2621 delete_ust_app_event(-1, ua_event
);
2626 * Create UST metadata and open it on the tracer side.
2628 * Called with UST app session lock held and RCU read side lock.
2630 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2631 struct ust_app
*app
, struct consumer_output
*consumer
,
2632 struct ustctl_consumer_channel_attr
*attr
)
2635 struct ust_app_channel
*metadata
;
2636 struct consumer_socket
*socket
;
2637 struct ust_registry_session
*registry
;
2643 registry
= get_session_registry(ua_sess
);
2646 /* Metadata already exists for this registry or it was closed previously */
2647 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2652 /* Allocate UST metadata */
2653 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2655 /* malloc() failed */
2661 /* Set default attributes for metadata. */
2662 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2663 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2664 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2665 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2666 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2667 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2668 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2670 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2671 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2672 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2675 /* Need one fd for the channel. */
2676 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2678 ERR("Exhausted number of available FD upon create metadata");
2682 /* Get the right consumer socket for the application. */
2683 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2686 goto error_consumer
;
2690 * Keep metadata key so we can identify it on the consumer side. Assign it
2691 * to the registry *before* we ask the consumer so we avoid the race of the
2692 * consumer requesting the metadata and the ask_channel call on our side
2693 * did not returned yet.
2695 registry
->metadata_key
= metadata
->key
;
2698 * Ask the metadata channel creation to the consumer. The metadata object
2699 * will be created by the consumer and kept their. However, the stream is
2700 * never added or monitored until we do a first push metadata to the
2703 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2706 /* Nullify the metadata key so we don't try to close it later on. */
2707 registry
->metadata_key
= 0;
2708 goto error_consumer
;
2712 * The setup command will make the metadata stream be sent to the relayd,
2713 * if applicable, and the thread managing the metadatas. This is important
2714 * because after this point, if an error occurs, the only way the stream
2715 * can be deleted is to be monitored in the consumer.
2717 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2719 /* Nullify the metadata key so we don't try to close it later on. */
2720 registry
->metadata_key
= 0;
2721 goto error_consumer
;
2724 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2725 metadata
->key
, app
->pid
);
2728 lttng_fd_put(LTTNG_FD_APPS
, 1);
2729 delete_ust_app_channel(-1, metadata
, app
);
2735 * Return pointer to traceable apps list.
2737 struct lttng_ht
*ust_app_get_ht(void)
2743 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2744 * acquired before calling this function.
2746 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2748 struct ust_app
*app
= NULL
;
2749 struct lttng_ht_node_ulong
*node
;
2750 struct lttng_ht_iter iter
;
2752 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2753 node
= lttng_ht_iter_get_node_ulong(&iter
);
2755 DBG2("UST app no found with pid %d", pid
);
2759 DBG2("Found UST app by pid %d", pid
);
2761 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2768 * Allocate and init an UST app object using the registration information and
2769 * the command socket. This is called when the command socket connects to the
2772 * The object is returned on success or else NULL.
2774 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2776 struct ust_app
*lta
= NULL
;
2781 DBG3("UST app creating application for socket %d", sock
);
2783 if ((msg
->bits_per_long
== 64 &&
2784 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2785 || (msg
->bits_per_long
== 32 &&
2786 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2787 ERR("Registration failed: application \"%s\" (pid: %d) has "
2788 "%d-bit long, but no consumerd for this size is available.\n",
2789 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2793 lta
= zmalloc(sizeof(struct ust_app
));
2799 lta
->ppid
= msg
->ppid
;
2800 lta
->uid
= msg
->uid
;
2801 lta
->gid
= msg
->gid
;
2803 lta
->bits_per_long
= msg
->bits_per_long
;
2804 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2805 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2806 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2807 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2808 lta
->long_alignment
= msg
->long_alignment
;
2809 lta
->byte_order
= msg
->byte_order
;
2811 lta
->v_major
= msg
->major
;
2812 lta
->v_minor
= msg
->minor
;
2813 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2814 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2815 lta
->notify_sock
= -1;
2817 /* Copy name and make sure it's NULL terminated. */
2818 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2819 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2822 * Before this can be called, when receiving the registration information,
2823 * the application compatibility is checked. So, at this point, the
2824 * application can work with this session daemon.
2826 lta
->compatible
= 1;
2828 lta
->pid
= msg
->pid
;
2829 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2831 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2833 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2840 * For a given application object, add it to every hash table.
2842 void ust_app_add(struct ust_app
*app
)
2845 assert(app
->notify_sock
>= 0);
2850 * On a re-registration, we want to kick out the previous registration of
2853 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2856 * The socket _should_ be unique until _we_ call close. So, a add_unique
2857 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2858 * already in the table.
2860 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2862 /* Add application to the notify socket hash table. */
2863 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2864 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2866 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2867 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2868 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2875 * Set the application version into the object.
2877 * Return 0 on success else a negative value either an errno code or a
2878 * LTTng-UST error code.
2880 int ust_app_version(struct ust_app
*app
)
2886 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2888 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2889 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2891 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2899 * Unregister app by removing it from the global traceable app list and freeing
2902 * The socket is already closed at this point so no close to sock.
2904 void ust_app_unregister(int sock
)
2906 struct ust_app
*lta
;
2907 struct lttng_ht_node_ulong
*node
;
2908 struct lttng_ht_iter iter
;
2909 struct ust_app_session
*ua_sess
;
2914 /* Get the node reference for a call_rcu */
2915 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2916 node
= lttng_ht_iter_get_node_ulong(&iter
);
2919 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2920 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2922 /* Remove application from PID hash table */
2923 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2927 * Remove application from notify hash table. The thread handling the
2928 * notify socket could have deleted the node so ignore on error because
2929 * either way it's valid. The close of that socket is handled by the other
2932 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2933 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2936 * Ignore return value since the node might have been removed before by an
2937 * add replace during app registration because the PID can be reassigned by
2940 iter
.iter
.node
= <a
->pid_n
.node
;
2941 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2943 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2947 /* Remove sessions so they are not visible during deletion.*/
2948 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2950 struct ust_registry_session
*registry
;
2952 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2954 /* The session was already removed so scheduled for teardown. */
2959 * Add session to list for teardown. This is safe since at this point we
2960 * are the only one using this list.
2962 pthread_mutex_lock(&ua_sess
->lock
);
2965 * Normally, this is done in the delete session process which is
2966 * executed in the call rcu below. However, upon registration we can't
2967 * afford to wait for the grace period before pushing data or else the
2968 * data pending feature can race between the unregistration and stop
2969 * command where the data pending command is sent *before* the grace
2972 * The close metadata below nullifies the metadata pointer in the
2973 * session so the delete session will NOT push/close a second time.
2975 registry
= get_session_registry(ua_sess
);
2976 if (registry
&& !registry
->metadata_closed
) {
2977 /* Push metadata for application before freeing the application. */
2978 (void) push_metadata(registry
, ua_sess
->consumer
);
2981 * Don't ask to close metadata for global per UID buffers. Close
2982 * metadata only on destroy trace session in this case. Also, the
2983 * previous push metadata could have flag the metadata registry to
2984 * close so don't send a close command if closed.
2986 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2987 !registry
->metadata_closed
) {
2988 /* And ask to close it for this session registry. */
2989 (void) close_metadata(registry
, ua_sess
->consumer
);
2993 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2994 pthread_mutex_unlock(&ua_sess
->lock
);
2998 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3005 * Return traceable_app_count
3007 unsigned long ust_app_list_count(void)
3009 unsigned long count
;
3012 count
= lttng_ht_get_count(ust_app_ht
);
3019 * Fill events array with all events name of all registered apps.
3021 int ust_app_list_events(struct lttng_event
**events
)
3024 size_t nbmem
, count
= 0;
3025 struct lttng_ht_iter iter
;
3026 struct ust_app
*app
;
3027 struct lttng_event
*tmp_event
;
3029 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3030 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3031 if (tmp_event
== NULL
) {
3032 PERROR("zmalloc ust app events");
3039 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3040 struct lttng_ust_tracepoint_iter uiter
;
3042 health_code_update();
3044 if (!app
->compatible
) {
3046 * TODO: In time, we should notice the caller of this error by
3047 * telling him that this is a version error.
3051 handle
= ustctl_tracepoint_list(app
->sock
);
3053 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3054 ERR("UST app list events getting handle failed for app pid %d",
3060 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3061 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3062 /* Handle ustctl error. */
3065 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3066 ERR("UST app tp list get failed for app %d with ret %d",
3069 DBG3("UST app tp list get failed. Application is dead");
3071 * This is normal behavior, an application can die during the
3072 * creation process. Don't report an error so the execution can
3073 * continue normally. Continue normal execution.
3080 health_code_update();
3081 if (count
>= nbmem
) {
3082 /* In case the realloc fails, we free the memory */
3085 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3088 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3090 PERROR("realloc ust app events");
3097 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3098 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3099 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3100 tmp_event
[count
].pid
= app
->pid
;
3101 tmp_event
[count
].enabled
= -1;
3107 *events
= tmp_event
;
3109 DBG2("UST app list events done (%zu events)", count
);
3114 health_code_update();
3119 * Fill events array with all events name of all registered apps.
3121 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3124 size_t nbmem
, count
= 0;
3125 struct lttng_ht_iter iter
;
3126 struct ust_app
*app
;
3127 struct lttng_event_field
*tmp_event
;
3129 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3130 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3131 if (tmp_event
== NULL
) {
3132 PERROR("zmalloc ust app event fields");
3139 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3140 struct lttng_ust_field_iter uiter
;
3142 health_code_update();
3144 if (!app
->compatible
) {
3146 * TODO: In time, we should notice the caller of this error by
3147 * telling him that this is a version error.
3151 handle
= ustctl_tracepoint_field_list(app
->sock
);
3153 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3154 ERR("UST app list field getting handle failed for app pid %d",
3160 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3161 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3162 /* Handle ustctl error. */
3165 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3166 ERR("UST app tp list field failed for app %d with ret %d",
3169 DBG3("UST app tp list field failed. Application is dead");
3171 * This is normal behavior, an application can die during the
3172 * creation process. Don't report an error so the execution can
3173 * continue normally.
3180 health_code_update();
3181 if (count
>= nbmem
) {
3182 /* In case the realloc fails, we free the memory */
3185 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3188 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3190 PERROR("realloc ust app event fields");
3198 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3199 /* Mapping between these enums matches 1 to 1. */
3200 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3201 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3203 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3204 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3205 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3206 tmp_event
[count
].event
.pid
= app
->pid
;
3207 tmp_event
[count
].event
.enabled
= -1;
3213 *fields
= tmp_event
;
3215 DBG2("UST app list event fields done (%zu events)", count
);
3220 health_code_update();
3225 * Free and clean all traceable apps of the global list.
3227 * Should _NOT_ be called with RCU read-side lock held.
3229 void ust_app_clean_list(void)
3232 struct ust_app
*app
;
3233 struct lttng_ht_iter iter
;
3235 DBG2("UST app cleaning registered apps hash table");
3239 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3240 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3242 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3245 /* Cleanup socket hash table */
3246 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3248 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3252 /* Cleanup notify socket hash table */
3253 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3254 notify_sock_n
.node
) {
3255 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3260 /* Destroy is done only when the ht is empty */
3261 ht_cleanup_push(ust_app_ht
);
3262 ht_cleanup_push(ust_app_ht_by_sock
);
3263 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3267 * Init UST app hash table.
3269 void ust_app_ht_alloc(void)
3271 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3272 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3273 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3277 * For a specific UST session, disable the channel for all registered apps.
3279 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3280 struct ltt_ust_channel
*uchan
)
3283 struct lttng_ht_iter iter
;
3284 struct lttng_ht_node_str
*ua_chan_node
;
3285 struct ust_app
*app
;
3286 struct ust_app_session
*ua_sess
;
3287 struct ust_app_channel
*ua_chan
;
3289 if (usess
== NULL
|| uchan
== NULL
) {
3290 ERR("Disabling UST global channel with NULL values");
3295 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3296 uchan
->name
, usess
->id
);
3300 /* For every registered applications */
3301 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3302 struct lttng_ht_iter uiter
;
3303 if (!app
->compatible
) {
3305 * TODO: In time, we should notice the caller of this error by
3306 * telling him that this is a version error.
3310 ua_sess
= lookup_session_by_app(usess
, app
);
3311 if (ua_sess
== NULL
) {
3316 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3317 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3318 /* If the session if found for the app, the channel must be there */
3319 assert(ua_chan_node
);
3321 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3322 /* The channel must not be already disabled */
3323 assert(ua_chan
->enabled
== 1);
3325 /* Disable channel onto application */
3326 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3328 /* XXX: We might want to report this error at some point... */
3340 * For a specific UST session, enable the channel for all registered apps.
3342 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3343 struct ltt_ust_channel
*uchan
)
3346 struct lttng_ht_iter iter
;
3347 struct ust_app
*app
;
3348 struct ust_app_session
*ua_sess
;
3350 if (usess
== NULL
|| uchan
== NULL
) {
3351 ERR("Adding UST global channel to NULL values");
3356 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3357 uchan
->name
, usess
->id
);
3361 /* For every registered applications */
3362 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3363 if (!app
->compatible
) {
3365 * TODO: In time, we should notice the caller of this error by
3366 * telling him that this is a version error.
3370 ua_sess
= lookup_session_by_app(usess
, app
);
3371 if (ua_sess
== NULL
) {
3375 /* Enable channel onto application */
3376 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3378 /* XXX: We might want to report this error at some point... */
3390 * Disable an event in a channel and for a specific session.
3392 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3393 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3396 struct lttng_ht_iter iter
, uiter
;
3397 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3398 struct ust_app
*app
;
3399 struct ust_app_session
*ua_sess
;
3400 struct ust_app_channel
*ua_chan
;
3401 struct ust_app_event
*ua_event
;
3403 DBG("UST app disabling event %s for all apps in channel "
3404 "%s for session id %" PRIu64
,
3405 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3409 /* For all registered applications */
3410 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3411 if (!app
->compatible
) {
3413 * TODO: In time, we should notice the caller of this error by
3414 * telling him that this is a version error.
3418 ua_sess
= lookup_session_by_app(usess
, app
);
3419 if (ua_sess
== NULL
) {
3424 /* Lookup channel in the ust app session */
3425 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3426 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3427 if (ua_chan_node
== NULL
) {
3428 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3429 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3432 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3434 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3435 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3436 if (ua_event_node
== NULL
) {
3437 DBG2("Event %s not found in channel %s for app pid %d."
3438 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3441 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3443 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3445 /* XXX: Report error someday... */
3456 * For a specific UST session and UST channel, the event for all
3459 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3460 struct ltt_ust_channel
*uchan
)
3463 struct lttng_ht_iter iter
, uiter
;
3464 struct lttng_ht_node_str
*ua_chan_node
;
3465 struct ust_app
*app
;
3466 struct ust_app_session
*ua_sess
;
3467 struct ust_app_channel
*ua_chan
;
3468 struct ust_app_event
*ua_event
;
3470 DBG("UST app disabling all event for all apps in channel "
3471 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3475 /* For all registered applications */
3476 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3477 if (!app
->compatible
) {
3479 * TODO: In time, we should notice the caller of this error by
3480 * telling him that this is a version error.
3484 ua_sess
= lookup_session_by_app(usess
, app
);
3486 /* The application has problem or is probably dead. */
3490 /* Lookup channel in the ust app session */
3491 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3492 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3493 /* If the channel is not found, there is a code flow error */
3494 assert(ua_chan_node
);
3496 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3498 /* Disable each events of channel */
3499 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3501 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3503 /* XXX: Report error someday... */
3515 * For a specific UST session, create the channel for all registered apps.
3517 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3518 struct ltt_ust_channel
*uchan
)
3520 int ret
= 0, created
;
3521 struct lttng_ht_iter iter
;
3522 struct ust_app
*app
;
3523 struct ust_app_session
*ua_sess
= NULL
;
3525 /* Very wrong code flow */
3529 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3530 uchan
->name
, usess
->id
);
3534 /* For every registered applications */
3535 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3536 if (!app
->compatible
) {
3538 * TODO: In time, we should notice the caller of this error by
3539 * telling him that this is a version error.
3544 * Create session on the tracer side and add it to app session HT. Note
3545 * that if session exist, it will simply return a pointer to the ust
3548 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3553 * The application's socket is not valid. Either a bad socket
3554 * or a timeout on it. We can't inform the caller that for a
3555 * specific app, the session failed so lets continue here.
3560 goto error_rcu_unlock
;
3565 pthread_mutex_lock(&ua_sess
->lock
);
3566 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3567 sizeof(uchan
->name
))) {
3568 struct ustctl_consumer_channel_attr attr
;
3569 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3570 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3573 /* Create channel onto application. We don't need the chan ref. */
3574 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3575 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3577 pthread_mutex_unlock(&ua_sess
->lock
);
3579 if (ret
== -ENOMEM
) {
3580 /* No more memory is a fatal error. Stop right now. */
3581 goto error_rcu_unlock
;
3583 /* Cleanup the created session if it's the case. */
3585 destroy_app_session(app
, ua_sess
);
3596 * Enable event for a specific session and channel on the tracer.
3598 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3599 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3602 struct lttng_ht_iter iter
, uiter
;
3603 struct lttng_ht_node_str
*ua_chan_node
;
3604 struct ust_app
*app
;
3605 struct ust_app_session
*ua_sess
;
3606 struct ust_app_channel
*ua_chan
;
3607 struct ust_app_event
*ua_event
;
3609 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3610 uevent
->attr
.name
, usess
->id
);
3613 * NOTE: At this point, this function is called only if the session and
3614 * channel passed are already created for all apps. and enabled on the
3620 /* For all registered applications */
3621 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3622 if (!app
->compatible
) {
3624 * TODO: In time, we should notice the caller of this error by
3625 * telling him that this is a version error.
3629 ua_sess
= lookup_session_by_app(usess
, app
);
3631 /* The application has problem or is probably dead. */
3635 pthread_mutex_lock(&ua_sess
->lock
);
3637 /* Lookup channel in the ust app session */
3638 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3639 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3640 /* If the channel is not found, there is a code flow error */
3641 assert(ua_chan_node
);
3643 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3645 /* Get event node */
3646 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3647 uevent
->filter
, uevent
->attr
.loglevel
);
3648 if (ua_event
== NULL
) {
3649 DBG3("UST app enable event %s not found for app PID %d."
3650 "Skipping app", uevent
->attr
.name
, app
->pid
);
3654 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3656 pthread_mutex_unlock(&ua_sess
->lock
);
3660 pthread_mutex_unlock(&ua_sess
->lock
);
3669 * For a specific existing UST session and UST channel, creates the event for
3670 * all registered apps.
3672 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3673 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3676 struct lttng_ht_iter iter
, uiter
;
3677 struct lttng_ht_node_str
*ua_chan_node
;
3678 struct ust_app
*app
;
3679 struct ust_app_session
*ua_sess
;
3680 struct ust_app_channel
*ua_chan
;
3682 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3683 uevent
->attr
.name
, usess
->id
);
3687 /* For all registered applications */
3688 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3689 if (!app
->compatible
) {
3691 * TODO: In time, we should notice the caller of this error by
3692 * telling him that this is a version error.
3696 ua_sess
= lookup_session_by_app(usess
, app
);
3698 /* The application has problem or is probably dead. */
3702 pthread_mutex_lock(&ua_sess
->lock
);
3703 /* Lookup channel in the ust app session */
3704 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3705 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3706 /* If the channel is not found, there is a code flow error */
3707 assert(ua_chan_node
);
3709 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3711 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3712 pthread_mutex_unlock(&ua_sess
->lock
);
3714 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3715 /* Possible value at this point: -ENOMEM. If so, we stop! */
3718 DBG2("UST app event %s already exist on app PID %d",
3719 uevent
->attr
.name
, app
->pid
);
3730 * Start tracing for a specific UST session and app.
3733 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3736 struct ust_app_session
*ua_sess
;
3738 DBG("Starting tracing for ust app pid %d", app
->pid
);
3742 if (!app
->compatible
) {
3746 ua_sess
= lookup_session_by_app(usess
, app
);
3747 if (ua_sess
== NULL
) {
3748 /* The session is in teardown process. Ignore and continue. */
3752 pthread_mutex_lock(&ua_sess
->lock
);
3754 /* Upon restart, we skip the setup, already done */
3755 if (ua_sess
->started
) {
3759 /* Create directories if consumer is LOCAL and has a path defined. */
3760 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3761 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3762 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3763 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3765 if (ret
!= -EEXIST
) {
3766 ERR("Trace directory creation error");
3773 * Create the metadata for the application. This returns gracefully if a
3774 * metadata was already set for the session.
3776 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3781 health_code_update();
3784 /* This start the UST tracing */
3785 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3787 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3788 ERR("Error starting tracing for app pid: %d (ret: %d)",
3791 DBG("UST app start session failed. Application is dead.");
3793 * This is normal behavior, an application can die during the
3794 * creation process. Don't report an error so the execution can
3795 * continue normally.
3797 pthread_mutex_unlock(&ua_sess
->lock
);
3803 /* Indicate that the session has been started once */
3804 ua_sess
->started
= 1;
3806 pthread_mutex_unlock(&ua_sess
->lock
);
3808 health_code_update();
3810 /* Quiescent wait after starting trace */
3811 ret
= ustctl_wait_quiescent(app
->sock
);
3812 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3813 ERR("UST app wait quiescent failed for app pid %d ret %d",
3819 health_code_update();
3823 pthread_mutex_unlock(&ua_sess
->lock
);
3825 health_code_update();
3830 * Stop tracing for a specific UST session and app.
3833 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3836 struct ust_app_session
*ua_sess
;
3837 struct ust_registry_session
*registry
;
3839 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3843 if (!app
->compatible
) {
3844 goto end_no_session
;
3847 ua_sess
= lookup_session_by_app(usess
, app
);
3848 if (ua_sess
== NULL
) {
3849 goto end_no_session
;
3852 pthread_mutex_lock(&ua_sess
->lock
);
3855 * If started = 0, it means that stop trace has been called for a session
3856 * that was never started. It's possible since we can have a fail start
3857 * from either the application manager thread or the command thread. Simply
3858 * indicate that this is a stop error.
3860 if (!ua_sess
->started
) {
3861 goto error_rcu_unlock
;
3864 health_code_update();
3866 /* This inhibits UST tracing */
3867 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3869 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3870 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3873 DBG("UST app stop session failed. Application is dead.");
3875 * This is normal behavior, an application can die during the
3876 * creation process. Don't report an error so the execution can
3877 * continue normally.
3881 goto error_rcu_unlock
;
3884 health_code_update();
3886 /* Quiescent wait after stopping trace */
3887 ret
= ustctl_wait_quiescent(app
->sock
);
3888 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3889 ERR("UST app wait quiescent failed for app pid %d ret %d",
3893 health_code_update();
3895 registry
= get_session_registry(ua_sess
);
3898 if (!registry
->metadata_closed
) {
3899 /* Push metadata for application before freeing the application. */
3900 (void) push_metadata(registry
, ua_sess
->consumer
);
3904 pthread_mutex_unlock(&ua_sess
->lock
);
3907 health_code_update();
3911 pthread_mutex_unlock(&ua_sess
->lock
);
3913 health_code_update();
3918 * Flush buffers for a specific UST session and app.
3921 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3924 struct lttng_ht_iter iter
;
3925 struct ust_app_session
*ua_sess
;
3926 struct ust_app_channel
*ua_chan
;
3928 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3932 if (!app
->compatible
) {
3933 goto end_no_session
;
3936 ua_sess
= lookup_session_by_app(usess
, app
);
3937 if (ua_sess
== NULL
) {
3938 goto end_no_session
;
3941 pthread_mutex_lock(&ua_sess
->lock
);
3943 health_code_update();
3945 /* Flushing buffers */
3946 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3948 health_code_update();
3949 assert(ua_chan
->is_sent
);
3950 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3952 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3953 ERR("UST app PID %d channel %s flush failed with ret %d",
3954 app
->pid
, ua_chan
->name
, ret
);
3956 DBG3("UST app failed to flush %s. Application is dead.",
3959 * This is normal behavior, an application can die during the
3960 * creation process. Don't report an error so the execution can
3961 * continue normally.
3964 /* Continuing flushing all buffers */
3969 health_code_update();
3971 pthread_mutex_unlock(&ua_sess
->lock
);
3974 health_code_update();
3979 * Destroy a specific UST session in apps.
3981 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3984 struct ust_app_session
*ua_sess
;
3985 struct lttng_ht_iter iter
;
3986 struct lttng_ht_node_u64
*node
;
3988 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3992 if (!app
->compatible
) {
3996 __lookup_session_by_app(usess
, app
, &iter
);
3997 node
= lttng_ht_iter_get_node_u64(&iter
);
3999 /* Session is being or is deleted. */
4002 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4004 health_code_update();
4005 destroy_app_session(app
, ua_sess
);
4007 health_code_update();
4009 /* Quiescent wait after stopping trace */
4010 ret
= ustctl_wait_quiescent(app
->sock
);
4011 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4012 ERR("UST app wait quiescent failed for app pid %d ret %d",
4017 health_code_update();
4022 * Start tracing for the UST session.
4024 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4027 struct lttng_ht_iter iter
;
4028 struct ust_app
*app
;
4030 DBG("Starting all UST traces");
4034 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4035 ret
= ust_app_start_trace(usess
, app
);
4037 /* Continue to next apps even on error */
4048 * Start tracing for the UST session.
4050 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4053 struct lttng_ht_iter iter
;
4054 struct ust_app
*app
;
4056 DBG("Stopping all UST traces");
4060 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4061 ret
= ust_app_stop_trace(usess
, app
);
4063 /* Continue to next apps even on error */
4068 /* Flush buffers and push metadata (for UID buffers). */
4069 switch (usess
->buffer_type
) {
4070 case LTTNG_BUFFER_PER_UID
:
4072 struct buffer_reg_uid
*reg
;
4074 /* Flush all per UID buffers associated to that session. */
4075 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4076 struct ust_registry_session
*ust_session_reg
;
4077 struct buffer_reg_channel
*reg_chan
;
4078 struct consumer_socket
*socket
;
4080 /* Get consumer socket to use to push the metadata.*/
4081 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4084 /* Ignore request if no consumer is found for the session. */
4088 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4089 reg_chan
, node
.node
) {
4091 * The following call will print error values so the return
4092 * code is of little importance because whatever happens, we
4093 * have to try them all.
4095 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4098 ust_session_reg
= reg
->registry
->reg
.ust
;
4099 if (!ust_session_reg
->metadata_closed
) {
4100 /* Push metadata. */
4101 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4107 case LTTNG_BUFFER_PER_PID
:
4108 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4109 ret
= ust_app_flush_trace(usess
, app
);
4111 /* Continue to next apps even on error */
4127 * Destroy app UST session.
4129 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4132 struct lttng_ht_iter iter
;
4133 struct ust_app
*app
;
4135 DBG("Destroy all UST traces");
4139 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4140 ret
= destroy_trace(usess
, app
);
4142 /* Continue to next apps even on error */
4153 * Add channels/events from UST global domain to registered apps at sock.
4155 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4158 struct lttng_ht_iter iter
, uiter
;
4159 struct ust_app
*app
;
4160 struct ust_app_session
*ua_sess
= NULL
;
4161 struct ust_app_channel
*ua_chan
;
4162 struct ust_app_event
*ua_event
;
4163 struct ust_app_ctx
*ua_ctx
;
4168 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4173 app
= find_app_by_sock(sock
);
4176 * Application can be unregistered before so this is possible hence
4177 * simply stopping the update.
4179 DBG3("UST app update failed to find app sock %d", sock
);
4183 if (!app
->compatible
) {
4187 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4189 /* Tracer is probably gone or ENOMEM. */
4194 pthread_mutex_lock(&ua_sess
->lock
);
4197 * We can iterate safely here over all UST app session since the create ust
4198 * app session above made a shadow copy of the UST global domain from the
4201 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4204 * For a metadata channel, handle it differently.
4206 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4207 sizeof(ua_chan
->name
))) {
4208 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4213 /* Remove it from the hash table and continue!. */
4214 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4216 delete_ust_app_channel(-1, ua_chan
, app
);
4219 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4222 * Stop everything. On error, the application failed, no more
4223 * file descriptor are available or ENOMEM so stopping here is
4224 * the only thing we can do for now.
4231 * Add context using the list so they are enabled in the same order the
4234 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4235 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4242 /* For each events */
4243 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4245 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4252 pthread_mutex_unlock(&ua_sess
->lock
);
4254 if (usess
->start_trace
) {
4255 ret
= ust_app_start_trace(usess
, app
);
4260 DBG2("UST trace started for app pid %d", app
->pid
);
4263 /* Everything went well at this point. */
4268 pthread_mutex_unlock(&ua_sess
->lock
);
4271 destroy_app_session(app
, ua_sess
);
4278 * Add context to a specific channel for global UST domain.
4280 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4281 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4284 struct lttng_ht_node_str
*ua_chan_node
;
4285 struct lttng_ht_iter iter
, uiter
;
4286 struct ust_app_channel
*ua_chan
= NULL
;
4287 struct ust_app_session
*ua_sess
;
4288 struct ust_app
*app
;
4292 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4293 if (!app
->compatible
) {
4295 * TODO: In time, we should notice the caller of this error by
4296 * telling him that this is a version error.
4300 ua_sess
= lookup_session_by_app(usess
, app
);
4301 if (ua_sess
== NULL
) {
4305 pthread_mutex_lock(&ua_sess
->lock
);
4306 /* Lookup channel in the ust app session */
4307 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4308 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4309 if (ua_chan_node
== NULL
) {
4312 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4314 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4319 pthread_mutex_unlock(&ua_sess
->lock
);
4327 * Enable event for a channel from a UST session for a specific PID.
4329 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4330 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4333 struct lttng_ht_iter iter
;
4334 struct lttng_ht_node_str
*ua_chan_node
;
4335 struct ust_app
*app
;
4336 struct ust_app_session
*ua_sess
;
4337 struct ust_app_channel
*ua_chan
;
4338 struct ust_app_event
*ua_event
;
4340 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4344 app
= ust_app_find_by_pid(pid
);
4346 ERR("UST app enable event per PID %d not found", pid
);
4351 if (!app
->compatible
) {
4356 ua_sess
= lookup_session_by_app(usess
, app
);
4358 /* The application has problem or is probably dead. */
4363 pthread_mutex_lock(&ua_sess
->lock
);
4364 /* Lookup channel in the ust app session */
4365 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4366 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4367 /* If the channel is not found, there is a code flow error */
4368 assert(ua_chan_node
);
4370 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4372 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4373 uevent
->filter
, uevent
->attr
.loglevel
);
4374 if (ua_event
== NULL
) {
4375 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4380 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4387 pthread_mutex_unlock(&ua_sess
->lock
);
4394 * Disable event for a channel from a UST session for a specific PID.
4396 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4397 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4400 struct lttng_ht_iter iter
;
4401 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4402 struct ust_app
*app
;
4403 struct ust_app_session
*ua_sess
;
4404 struct ust_app_channel
*ua_chan
;
4405 struct ust_app_event
*ua_event
;
4407 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4411 app
= ust_app_find_by_pid(pid
);
4413 ERR("UST app disable event per PID %d not found", pid
);
4418 if (!app
->compatible
) {
4423 ua_sess
= lookup_session_by_app(usess
, app
);
4425 /* The application has problem or is probably dead. */
4429 /* Lookup channel in the ust app session */
4430 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4431 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4432 if (ua_chan_node
== NULL
) {
4433 /* Channel does not exist, skip disabling */
4436 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4438 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4439 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4440 if (ua_event_node
== NULL
) {
4441 /* Event does not exist, skip disabling */
4444 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4446 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4457 * Calibrate registered applications.
4459 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4462 struct lttng_ht_iter iter
;
4463 struct ust_app
*app
;
4467 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4468 if (!app
->compatible
) {
4470 * TODO: In time, we should notice the caller of this error by
4471 * telling him that this is a version error.
4476 health_code_update();
4478 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4482 /* Means that it's not implemented on the tracer side. */
4486 DBG2("Calibrate app PID %d returned with error %d",
4493 DBG("UST app global domain calibration finished");
4497 health_code_update();
4503 * Receive registration and populate the given msg structure.
4505 * On success return 0 else a negative value returned by the ustctl call.
4507 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4510 uint32_t pid
, ppid
, uid
, gid
;
4514 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4515 &pid
, &ppid
, &uid
, &gid
,
4516 &msg
->bits_per_long
,
4517 &msg
->uint8_t_alignment
,
4518 &msg
->uint16_t_alignment
,
4519 &msg
->uint32_t_alignment
,
4520 &msg
->uint64_t_alignment
,
4521 &msg
->long_alignment
,
4528 case LTTNG_UST_ERR_EXITING
:
4529 DBG3("UST app recv reg message failed. Application died");
4531 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4532 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4533 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4534 LTTNG_UST_ABI_MINOR_VERSION
);
4537 ERR("UST app recv reg message failed with ret %d", ret
);
4542 msg
->pid
= (pid_t
) pid
;
4543 msg
->ppid
= (pid_t
) ppid
;
4544 msg
->uid
= (uid_t
) uid
;
4545 msg
->gid
= (gid_t
) gid
;
4552 * Return a ust app channel object using the application object and the channel
4553 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4554 * lock MUST be acquired before calling this function.
4556 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4559 struct lttng_ht_node_ulong
*node
;
4560 struct lttng_ht_iter iter
;
4561 struct ust_app_channel
*ua_chan
= NULL
;
4565 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4566 node
= lttng_ht_iter_get_node_ulong(&iter
);
4568 DBG2("UST app channel find by objd %d not found", objd
);
4572 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4579 * Reply to a register channel notification from an application on the notify
4580 * socket. The channel metadata is also created.
4582 * The session UST registry lock is acquired in this function.
4584 * On success 0 is returned else a negative value.
4586 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4587 size_t nr_fields
, struct ustctl_field
*fields
)
4589 int ret
, ret_code
= 0;
4590 uint32_t chan_id
, reg_count
;
4591 uint64_t chan_reg_key
;
4592 enum ustctl_channel_header type
;
4593 struct ust_app
*app
;
4594 struct ust_app_channel
*ua_chan
;
4595 struct ust_app_session
*ua_sess
;
4596 struct ust_registry_session
*registry
;
4597 struct ust_registry_channel
*chan_reg
;
4601 /* Lookup application. If not found, there is a code flow error. */
4602 app
= find_app_by_notify_sock(sock
);
4604 DBG("Application socket %d is being teardown. Abort event notify",
4608 goto error_rcu_unlock
;
4611 /* Lookup channel by UST object descriptor. */
4612 ua_chan
= find_channel_by_objd(app
, cobjd
);
4614 DBG("Application channel is being teardown. Abort event notify");
4617 goto error_rcu_unlock
;
4620 assert(ua_chan
->session
);
4621 ua_sess
= ua_chan
->session
;
4623 /* Get right session registry depending on the session buffer type. */
4624 registry
= get_session_registry(ua_sess
);
4627 /* Depending on the buffer type, a different channel key is used. */
4628 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4629 chan_reg_key
= ua_chan
->tracing_channel_id
;
4631 chan_reg_key
= ua_chan
->key
;
4634 pthread_mutex_lock(®istry
->lock
);
4636 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4639 if (!chan_reg
->register_done
) {
4640 reg_count
= ust_registry_get_event_count(chan_reg
);
4641 if (reg_count
< 31) {
4642 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4644 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4647 chan_reg
->nr_ctx_fields
= nr_fields
;
4648 chan_reg
->ctx_fields
= fields
;
4649 chan_reg
->header_type
= type
;
4651 /* Get current already assigned values. */
4652 type
= chan_reg
->header_type
;
4654 /* Set to NULL so the error path does not do a double free. */
4657 /* Channel id is set during the object creation. */
4658 chan_id
= chan_reg
->chan_id
;
4660 /* Append to metadata */
4661 if (!chan_reg
->metadata_dumped
) {
4662 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4664 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4670 DBG3("UST app replying to register channel key %" PRIu64
4671 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4674 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4676 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4677 ERR("UST app reply channel failed with ret %d", ret
);
4679 DBG3("UST app reply channel failed. Application died");
4684 /* This channel registry registration is completed. */
4685 chan_reg
->register_done
= 1;
4688 pthread_mutex_unlock(®istry
->lock
);
4698 * Add event to the UST channel registry. When the event is added to the
4699 * registry, the metadata is also created. Once done, this replies to the
4700 * application with the appropriate error code.
4702 * The session UST registry lock is acquired in the function.
4704 * On success 0 is returned else a negative value.
4706 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4707 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4708 char *model_emf_uri
)
4711 uint32_t event_id
= 0;
4712 uint64_t chan_reg_key
;
4713 struct ust_app
*app
;
4714 struct ust_app_channel
*ua_chan
;
4715 struct ust_app_session
*ua_sess
;
4716 struct ust_registry_session
*registry
;
4720 /* Lookup application. If not found, there is a code flow error. */
4721 app
= find_app_by_notify_sock(sock
);
4723 DBG("Application socket %d is being teardown. Abort event notify",
4728 free(model_emf_uri
);
4729 goto error_rcu_unlock
;
4732 /* Lookup channel by UST object descriptor. */
4733 ua_chan
= find_channel_by_objd(app
, cobjd
);
4735 DBG("Application channel is being teardown. Abort event notify");
4739 free(model_emf_uri
);
4740 goto error_rcu_unlock
;
4743 assert(ua_chan
->session
);
4744 ua_sess
= ua_chan
->session
;
4746 registry
= get_session_registry(ua_sess
);
4749 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4750 chan_reg_key
= ua_chan
->tracing_channel_id
;
4752 chan_reg_key
= ua_chan
->key
;
4755 pthread_mutex_lock(®istry
->lock
);
4758 * From this point on, this call acquires the ownership of the sig, fields
4759 * and model_emf_uri meaning any free are done inside it if needed. These
4760 * three variables MUST NOT be read/write after this.
4762 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4763 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4764 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4768 * The return value is returned to ustctl so in case of an error, the
4769 * application can be notified. In case of an error, it's important not to
4770 * return a negative error or else the application will get closed.
4772 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4774 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4775 ERR("UST app reply event failed with ret %d", ret
);
4777 DBG3("UST app reply event failed. Application died");
4780 * No need to wipe the create event since the application socket will
4781 * get close on error hence cleaning up everything by itself.
4786 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4790 pthread_mutex_unlock(®istry
->lock
);
4797 * Handle application notification through the given notify socket.
4799 * Return 0 on success or else a negative value.
4801 int ust_app_recv_notify(int sock
)
4804 enum ustctl_notify_cmd cmd
;
4806 DBG3("UST app receiving notify from sock %d", sock
);
4808 ret
= ustctl_recv_notify(sock
, &cmd
);
4810 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4811 ERR("UST app recv notify failed with ret %d", ret
);
4813 DBG3("UST app recv notify failed. Application died");
4819 case USTCTL_NOTIFY_CMD_EVENT
:
4821 int sobjd
, cobjd
, loglevel
;
4822 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4824 struct ustctl_field
*fields
;
4826 DBG2("UST app ustctl register event received");
4828 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4829 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4831 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4832 ERR("UST app recv event failed with ret %d", ret
);
4834 DBG3("UST app recv event failed. Application died");
4840 * Add event to the UST registry coming from the notify socket. This
4841 * call will free if needed the sig, fields and model_emf_uri. This
4842 * code path loses the ownsership of these variables and transfer them
4843 * to the this function.
4845 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4846 fields
, loglevel
, model_emf_uri
);
4853 case USTCTL_NOTIFY_CMD_CHANNEL
:
4857 struct ustctl_field
*fields
;
4859 DBG2("UST app ustctl register channel received");
4861 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4864 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4865 ERR("UST app recv channel failed with ret %d", ret
);
4867 DBG3("UST app recv channel failed. Application died");
4873 * The fields ownership are transfered to this function call meaning
4874 * that if needed it will be freed. After this, it's invalid to access
4875 * fields or clean it up.
4877 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4886 /* Should NEVER happen. */
4895 * Once the notify socket hangs up, this is called. First, it tries to find the
4896 * corresponding application. On failure, the call_rcu to close the socket is
4897 * executed. If an application is found, it tries to delete it from the notify
4898 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4900 * Note that an object needs to be allocated here so on ENOMEM failure, the
4901 * call RCU is not done but the rest of the cleanup is.
4903 void ust_app_notify_sock_unregister(int sock
)
4906 struct lttng_ht_iter iter
;
4907 struct ust_app
*app
;
4908 struct ust_app_notify_sock_obj
*obj
;
4914 obj
= zmalloc(sizeof(*obj
));
4917 * An ENOMEM is kind of uncool. If this strikes we continue the
4918 * procedure but the call_rcu will not be called. In this case, we
4919 * accept the fd leak rather than possibly creating an unsynchronized
4920 * state between threads.
4922 * TODO: The notify object should be created once the notify socket is
4923 * registered and stored independantely from the ust app object. The
4924 * tricky part is to synchronize the teardown of the application and
4925 * this notify object. Let's keep that in mind so we can avoid this
4926 * kind of shenanigans with ENOMEM in the teardown path.
4933 DBG("UST app notify socket unregister %d", sock
);
4936 * Lookup application by notify socket. If this fails, this means that the
4937 * hash table delete has already been done by the application
4938 * unregistration process so we can safely close the notify socket in a
4941 app
= find_app_by_notify_sock(sock
);
4946 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4949 * Whatever happens here either we fail or succeed, in both cases we have
4950 * to close the socket after a grace period to continue to the call RCU
4951 * here. If the deletion is successful, the application is not visible
4952 * anymore by other threads and is it fails it means that it was already
4953 * deleted from the hash table so either way we just have to close the
4956 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4962 * Close socket after a grace period to avoid for the socket to be reused
4963 * before the application object is freed creating potential race between
4964 * threads trying to add unique in the global hash table.
4967 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4972 * Destroy a ust app data structure and free its memory.
4974 void ust_app_destroy(struct ust_app
*app
)
4980 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);