2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
44 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key
;
48 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id
;
52 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 * Return the incremented value of next_channel_key.
57 static uint64_t get_next_channel_key(void)
61 pthread_mutex_lock(&next_channel_key_lock
);
62 ret
= ++_next_channel_key
;
63 pthread_mutex_unlock(&next_channel_key_lock
);
68 * Return the atomically incremented value of next_session_id.
70 static uint64_t get_next_session_id(void)
74 pthread_mutex_lock(&next_session_id_lock
);
75 ret
= ++_next_session_id
;
76 pthread_mutex_unlock(&next_session_id_lock
);
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr
*attr
,
82 struct lttng_ust_channel_attr
*uattr
)
84 /* Copy event attributes since the layout is different. */
85 attr
->subbuf_size
= uattr
->subbuf_size
;
86 attr
->num_subbuf
= uattr
->num_subbuf
;
87 attr
->overwrite
= uattr
->overwrite
;
88 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
89 attr
->read_timer_interval
= uattr
->read_timer_interval
;
90 attr
->output
= uattr
->output
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
107 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
113 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
117 /* Event loglevel. */
118 if (event
->attr
.loglevel
!= key
->loglevel
) {
119 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
120 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
122 * Match is accepted. This is because on event creation, the
123 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
124 * -1 are accepted for this loglevel type since 0 is the one set by
125 * the API when receiving an enable event.
132 /* One of the filters is NULL, fail. */
133 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
137 if (key
->filter
&& event
->filter
) {
138 /* Both filters exists, check length followed by the bytecode. */
139 if (event
->filter
->len
!= key
->filter
->len
||
140 memcmp(event
->filter
->data
, key
->filter
->data
,
141 event
->filter
->len
) != 0) {
146 /* One of the exclusions is NULL, fail. */
147 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
151 if (key
->exclusion
&& event
->exclusion
) {
152 /* Both exclusions exists, check count followed by the names. */
153 if (event
->exclusion
->count
!= key
->exclusion
->count
||
154 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
155 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
169 * Unique add of an ust app event in the given ht. This uses the custom
170 * ht_match_ust_app_event match function and the event name as hash.
172 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
173 struct ust_app_event
*event
)
175 struct cds_lfht_node
*node_ptr
;
176 struct ust_app_ht_key key
;
180 assert(ua_chan
->events
);
183 ht
= ua_chan
->events
;
184 key
.name
= event
->attr
.name
;
185 key
.filter
= event
->filter
;
186 key
.loglevel
= event
->attr
.loglevel
;
187 key
.exclusion
= event
->exclusion
;
189 node_ptr
= cds_lfht_add_unique(ht
->ht
,
190 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
191 ht_match_ust_app_event
, &key
, &event
->node
.node
);
192 assert(node_ptr
== &event
->node
.node
);
196 * Close the notify socket from the given RCU head object. This MUST be called
197 * through a call_rcu().
199 static void close_notify_sock_rcu(struct rcu_head
*head
)
202 struct ust_app_notify_sock_obj
*obj
=
203 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
205 /* Must have a valid fd here. */
206 assert(obj
->fd
>= 0);
208 ret
= close(obj
->fd
);
210 ERR("close notify sock %d RCU", obj
->fd
);
212 lttng_fd_put(LTTNG_FD_APPS
, 1);
218 * Return the session registry according to the buffer type of the given
221 * A registry per UID object MUST exists before calling this function or else
222 * it assert() if not found. RCU read side lock must be acquired.
224 static struct ust_registry_session
*get_session_registry(
225 struct ust_app_session
*ua_sess
)
227 struct ust_registry_session
*registry
= NULL
;
231 switch (ua_sess
->buffer_type
) {
232 case LTTNG_BUFFER_PER_PID
:
234 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
238 registry
= reg_pid
->registry
->reg
.ust
;
241 case LTTNG_BUFFER_PER_UID
:
243 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
244 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
248 registry
= reg_uid
->registry
->reg
.ust
;
260 * Delete ust context safely. RCU read lock must be held before calling
264 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
271 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
272 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
273 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
274 sock
, ua_ctx
->obj
->handle
, ret
);
282 * Delete ust app event safely. RCU read lock must be held before calling
286 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
292 free(ua_event
->filter
);
293 if (ua_event
->exclusion
!= NULL
)
294 free(ua_event
->exclusion
);
295 if (ua_event
->obj
!= NULL
) {
296 ret
= ustctl_release_object(sock
, ua_event
->obj
);
297 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
298 ERR("UST app sock %d release event obj failed with ret %d",
307 * Release ust data object of the given stream.
309 * Return 0 on success or else a negative value.
311 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
318 ret
= ustctl_release_object(sock
, stream
->obj
);
319 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
320 ERR("UST app sock %d release stream obj failed with ret %d",
323 lttng_fd_put(LTTNG_FD_APPS
, 2);
331 * Delete ust app stream safely. RCU read lock must be held before calling
335 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
339 (void) release_ust_app_stream(sock
, stream
);
344 * We need to execute ht_destroy outside of RCU read-side critical
345 * section and outside of call_rcu thread, so we postpone its execution
346 * using ht_cleanup_push. It is simpler than to change the semantic of
347 * the many callers of delete_ust_app_session().
350 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
352 struct ust_app_channel
*ua_chan
=
353 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
355 ht_cleanup_push(ua_chan
->ctx
);
356 ht_cleanup_push(ua_chan
->events
);
361 * Delete ust app channel safely. RCU read lock must be held before calling
365 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
369 struct lttng_ht_iter iter
;
370 struct ust_app_event
*ua_event
;
371 struct ust_app_ctx
*ua_ctx
;
372 struct ust_app_stream
*stream
, *stmp
;
373 struct ust_registry_session
*registry
;
377 DBG3("UST app deleting channel %s", ua_chan
->name
);
380 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
381 cds_list_del(&stream
->list
);
382 delete_ust_app_stream(sock
, stream
);
386 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
387 cds_list_del(&ua_ctx
->list
);
388 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
390 delete_ust_app_ctx(sock
, ua_ctx
);
394 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
396 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
398 delete_ust_app_event(sock
, ua_event
);
401 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
402 /* Wipe and free registry from session registry. */
403 registry
= get_session_registry(ua_chan
->session
);
405 ust_registry_channel_del_free(registry
, ua_chan
->key
);
409 if (ua_chan
->obj
!= NULL
) {
410 /* Remove channel from application UST object descriptor. */
411 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
412 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
414 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
415 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
416 ERR("UST app sock %d release channel obj failed with ret %d",
419 lttng_fd_put(LTTNG_FD_APPS
, 1);
422 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
426 * Push metadata to consumer socket.
428 * The socket lock MUST be acquired.
429 * The ust app session lock MUST be acquired.
431 * On success, return the len of metadata pushed or else a negative value.
433 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
434 struct consumer_socket
*socket
, int send_zero_data
)
437 char *metadata_str
= NULL
;
445 * On a push metadata error either the consumer is dead or the metadata
446 * channel has been destroyed because its endpoint might have died (e.g:
447 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
448 * metadata again which is not valid anymore on the consumer side.
450 * The ust app session mutex locked allows us to make this check without
453 if (registry
->metadata_closed
) {
457 pthread_mutex_lock(®istry
->lock
);
459 offset
= registry
->metadata_len_sent
;
460 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
462 DBG3("No metadata to push for metadata key %" PRIu64
,
463 registry
->metadata_key
);
465 if (send_zero_data
) {
466 DBG("No metadata to push");
472 /* Allocate only what we have to send. */
473 metadata_str
= zmalloc(len
);
475 PERROR("zmalloc ust app metadata string");
479 /* Copy what we haven't send out. */
480 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
481 registry
->metadata_len_sent
+= len
;
484 pthread_mutex_unlock(®istry
->lock
);
485 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
486 metadata_str
, len
, offset
);
489 * There is an acceptable race here between the registry metadata key
490 * assignment and the creation on the consumer. The session daemon can
491 * concurrently push metadata for this registry while being created on
492 * the consumer since the metadata key of the registry is assigned
493 * *before* it is setup to avoid the consumer to ask for metadata that
494 * could possibly be not found in the session daemon.
496 * The metadata will get pushed either by the session being stopped or
497 * the consumer requesting metadata if that race is triggered.
499 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
503 /* Update back the actual metadata len sent since it failed here. */
504 pthread_mutex_lock(®istry
->lock
);
505 registry
->metadata_len_sent
-= len
;
506 pthread_mutex_unlock(®istry
->lock
);
516 pthread_mutex_unlock(®istry
->lock
);
523 * For a given application and session, push metadata to consumer. The session
524 * lock MUST be acquired here before calling this.
525 * Either sock or consumer is required : if sock is NULL, the default
526 * socket to send the metadata is retrieved from consumer, if sock
527 * is not NULL we use it to send the metadata.
529 * Return 0 on success else a negative error.
531 static int push_metadata(struct ust_registry_session
*registry
,
532 struct consumer_output
*consumer
)
536 struct consumer_socket
*socket
;
544 * Means that no metadata was assigned to the session. This can happens if
545 * no start has been done previously.
547 if (!registry
->metadata_key
) {
552 /* Get consumer socket to use to push the metadata.*/
553 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
557 goto error_rcu_unlock
;
561 * TODO: Currently, we hold the socket lock around sampling of the next
562 * metadata segment to ensure we send metadata over the consumer socket in
563 * the correct order. This makes the registry lock nest inside the socket
566 * Please note that this is a temporary measure: we should move this lock
567 * back into ust_consumer_push_metadata() when the consumer gets the
568 * ability to reorder the metadata it receives.
570 pthread_mutex_lock(socket
->lock
);
571 ret
= ust_app_push_metadata(registry
, socket
, 0);
572 pthread_mutex_unlock(socket
->lock
);
575 goto error_rcu_unlock
;
583 * On error, flag the registry that the metadata is closed. We were unable
584 * to push anything and this means that either the consumer is not
585 * responding or the metadata cache has been destroyed on the consumer.
587 registry
->metadata_closed
= 1;
594 * Send to the consumer a close metadata command for the given session. Once
595 * done, the metadata channel is deleted and the session metadata pointer is
596 * nullified. The session lock MUST be acquired here unless the application is
597 * in the destroy path.
599 * Return 0 on success else a negative value.
601 static int close_metadata(struct ust_registry_session
*registry
,
602 struct consumer_output
*consumer
)
605 struct consumer_socket
*socket
;
612 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
617 /* Get consumer socket to use to push the metadata.*/
618 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
625 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
632 * Metadata closed. Even on error this means that the consumer is not
633 * responding or not found so either way a second close should NOT be emit
636 registry
->metadata_closed
= 1;
643 * We need to execute ht_destroy outside of RCU read-side critical
644 * section and outside of call_rcu thread, so we postpone its execution
645 * using ht_cleanup_push. It is simpler than to change the semantic of
646 * the many callers of delete_ust_app_session().
649 void delete_ust_app_session_rcu(struct rcu_head
*head
)
651 struct ust_app_session
*ua_sess
=
652 caa_container_of(head
, struct ust_app_session
, rcu_head
);
654 ht_cleanup_push(ua_sess
->channels
);
659 * Delete ust app session safely. RCU read lock must be held before calling
663 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
667 struct lttng_ht_iter iter
;
668 struct ust_app_channel
*ua_chan
;
669 struct ust_registry_session
*registry
;
673 pthread_mutex_lock(&ua_sess
->lock
);
675 registry
= get_session_registry(ua_sess
);
676 if (registry
&& !registry
->metadata_closed
) {
677 /* Push metadata for application before freeing the application. */
678 (void) push_metadata(registry
, ua_sess
->consumer
);
681 * Don't ask to close metadata for global per UID buffers. Close
682 * metadata only on destroy trace session in this case. Also, the
683 * previous push metadata could have flag the metadata registry to
684 * close so don't send a close command if closed.
686 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
687 !registry
->metadata_closed
) {
688 /* And ask to close it for this session registry. */
689 (void) close_metadata(registry
, ua_sess
->consumer
);
693 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
695 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
697 delete_ust_app_channel(sock
, ua_chan
, app
);
700 /* In case of per PID, the registry is kept in the session. */
701 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
702 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
704 buffer_reg_pid_remove(reg_pid
);
705 buffer_reg_pid_destroy(reg_pid
);
709 if (ua_sess
->handle
!= -1) {
710 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
711 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
712 ERR("UST app sock %d release session handle failed with ret %d",
716 pthread_mutex_unlock(&ua_sess
->lock
);
718 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
722 * Delete a traceable application structure from the global list. Never call
723 * this function outside of a call_rcu call.
725 * RCU read side lock should _NOT_ be held when calling this function.
728 void delete_ust_app(struct ust_app
*app
)
731 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
733 /* Delete ust app sessions info */
738 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
740 /* Free every object in the session and the session. */
742 delete_ust_app_session(sock
, ua_sess
, app
);
746 ht_cleanup_push(app
->sessions
);
747 ht_cleanup_push(app
->ust_objd
);
750 * Wait until we have deleted the application from the sock hash table
751 * before closing this socket, otherwise an application could re-use the
752 * socket ID and race with the teardown, using the same hash table entry.
754 * It's OK to leave the close in call_rcu. We want it to stay unique for
755 * all RCU readers that could run concurrently with unregister app,
756 * therefore we _need_ to only close that socket after a grace period. So
757 * it should stay in this RCU callback.
759 * This close() is a very important step of the synchronization model so
760 * every modification to this function must be carefully reviewed.
766 lttng_fd_put(LTTNG_FD_APPS
, 1);
768 DBG2("UST app pid %d deleted", app
->pid
);
773 * URCU intermediate call to delete an UST app.
776 void delete_ust_app_rcu(struct rcu_head
*head
)
778 struct lttng_ht_node_ulong
*node
=
779 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
780 struct ust_app
*app
=
781 caa_container_of(node
, struct ust_app
, pid_n
);
783 DBG3("Call RCU deleting app PID %d", app
->pid
);
788 * Delete the session from the application ht and delete the data structure by
789 * freeing every object inside and releasing them.
791 static void destroy_app_session(struct ust_app
*app
,
792 struct ust_app_session
*ua_sess
)
795 struct lttng_ht_iter iter
;
800 iter
.iter
.node
= &ua_sess
->node
.node
;
801 ret
= lttng_ht_del(app
->sessions
, &iter
);
803 /* Already scheduled for teardown. */
807 /* Once deleted, free the data structure. */
808 delete_ust_app_session(app
->sock
, ua_sess
, app
);
815 * Alloc new UST app session.
818 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
820 struct ust_app_session
*ua_sess
;
822 /* Init most of the default value by allocating and zeroing */
823 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
824 if (ua_sess
== NULL
) {
829 ua_sess
->handle
= -1;
830 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
831 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
832 pthread_mutex_init(&ua_sess
->lock
, NULL
);
841 * Alloc new UST app channel.
844 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
845 struct ust_app_session
*ua_sess
,
846 struct lttng_ust_channel_attr
*attr
)
848 struct ust_app_channel
*ua_chan
;
850 /* Init most of the default value by allocating and zeroing */
851 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
852 if (ua_chan
== NULL
) {
857 /* Setup channel name */
858 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
859 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
861 ua_chan
->enabled
= 1;
862 ua_chan
->handle
= -1;
863 ua_chan
->session
= ua_sess
;
864 ua_chan
->key
= get_next_channel_key();
865 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
866 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
867 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
869 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
870 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
872 /* Copy attributes */
874 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
875 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
876 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
877 ua_chan
->attr
.overwrite
= attr
->overwrite
;
878 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
879 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
880 ua_chan
->attr
.output
= attr
->output
;
882 /* By default, the channel is a per cpu channel. */
883 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
885 DBG3("UST app channel %s allocated", ua_chan
->name
);
894 * Allocate and initialize a UST app stream.
896 * Return newly allocated stream pointer or NULL on error.
898 struct ust_app_stream
*ust_app_alloc_stream(void)
900 struct ust_app_stream
*stream
= NULL
;
902 stream
= zmalloc(sizeof(*stream
));
903 if (stream
== NULL
) {
904 PERROR("zmalloc ust app stream");
908 /* Zero could be a valid value for a handle so flag it to -1. */
916 * Alloc new UST app event.
919 struct ust_app_event
*alloc_ust_app_event(char *name
,
920 struct lttng_ust_event
*attr
)
922 struct ust_app_event
*ua_event
;
924 /* Init most of the default value by allocating and zeroing */
925 ua_event
= zmalloc(sizeof(struct ust_app_event
));
926 if (ua_event
== NULL
) {
931 ua_event
->enabled
= 1;
932 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
933 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
934 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
936 /* Copy attributes */
938 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
941 DBG3("UST app event %s allocated", ua_event
->name
);
950 * Alloc new UST app context.
953 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
955 struct ust_app_ctx
*ua_ctx
;
957 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
958 if (ua_ctx
== NULL
) {
962 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
965 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
968 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
975 * Allocate a filter and copy the given original filter.
977 * Return allocated filter or NULL on error.
979 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
980 struct lttng_ust_filter_bytecode
*orig_f
)
982 struct lttng_ust_filter_bytecode
*filter
= NULL
;
984 /* Copy filter bytecode */
985 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
987 PERROR("zmalloc alloc ust app filter");
991 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
998 * Find an ust_app using the sock and return it. RCU read side lock must be
999 * held before calling this helper function.
1001 struct ust_app
*ust_app_find_by_sock(int sock
)
1003 struct lttng_ht_node_ulong
*node
;
1004 struct lttng_ht_iter iter
;
1006 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1007 node
= lttng_ht_iter_get_node_ulong(&iter
);
1009 DBG2("UST app find by sock %d not found", sock
);
1013 return caa_container_of(node
, struct ust_app
, sock_n
);
1020 * Find an ust_app using the notify sock and return it. RCU read side lock must
1021 * be held before calling this helper function.
1023 static struct ust_app
*find_app_by_notify_sock(int sock
)
1025 struct lttng_ht_node_ulong
*node
;
1026 struct lttng_ht_iter iter
;
1028 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1030 node
= lttng_ht_iter_get_node_ulong(&iter
);
1032 DBG2("UST app find by notify sock %d not found", sock
);
1036 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1043 * Lookup for an ust app event based on event name, filter bytecode and the
1046 * Return an ust_app_event object or NULL on error.
1048 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1049 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1050 const struct lttng_event_exclusion
*exclusion
)
1052 struct lttng_ht_iter iter
;
1053 struct lttng_ht_node_str
*node
;
1054 struct ust_app_event
*event
= NULL
;
1055 struct ust_app_ht_key key
;
1060 /* Setup key for event lookup. */
1062 key
.filter
= filter
;
1063 key
.loglevel
= loglevel
;
1064 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1065 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1067 /* Lookup using the event name as hash and a custom match fct. */
1068 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1069 ht_match_ust_app_event
, &key
, &iter
.iter
);
1070 node
= lttng_ht_iter_get_node_str(&iter
);
1075 event
= caa_container_of(node
, struct ust_app_event
, node
);
1082 * Create the channel context on the tracer.
1084 * Called with UST app session lock held.
1087 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1088 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1092 health_code_update();
1094 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1095 ua_chan
->obj
, &ua_ctx
->obj
);
1097 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1098 ERR("UST app create channel context failed for app (pid: %d) "
1099 "with ret %d", app
->pid
, ret
);
1102 * This is normal behavior, an application can die during the
1103 * creation process. Don't report an error so the execution can
1104 * continue normally.
1107 DBG3("UST app disable event failed. Application is dead.");
1112 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1114 DBG2("UST app context handle %d created successfully for channel %s",
1115 ua_ctx
->handle
, ua_chan
->name
);
1118 health_code_update();
1123 * Set the filter on the tracer.
1126 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1127 struct ust_app
*app
)
1131 health_code_update();
1133 if (!ua_event
->filter
) {
1138 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1141 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1142 ERR("UST app event %s filter failed for app (pid: %d) "
1143 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1146 * This is normal behavior, an application can die during the
1147 * creation process. Don't report an error so the execution can
1148 * continue normally.
1151 DBG3("UST app filter event failed. Application is dead.");
1156 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1159 health_code_update();
1164 * Set event exclusions on the tracer.
1167 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1168 struct ust_app
*app
)
1172 health_code_update();
1174 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1179 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1182 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1183 ERR("UST app event %s exclusions failed for app (pid: %d) "
1184 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1187 * This is normal behavior, an application can die during the
1188 * creation process. Don't report an error so the execution can
1189 * continue normally.
1192 DBG3("UST app event exclusion failed. Application is dead.");
1197 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1200 health_code_update();
1205 * Disable the specified event on to UST tracer for the UST session.
1207 static int disable_ust_event(struct ust_app
*app
,
1208 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1212 health_code_update();
1214 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1216 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1217 ERR("UST app event %s disable failed for app (pid: %d) "
1218 "and session handle %d with ret %d",
1219 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1222 * This is normal behavior, an application can die during the
1223 * creation process. Don't report an error so the execution can
1224 * continue normally.
1227 DBG3("UST app disable event failed. Application is dead.");
1232 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1233 ua_event
->attr
.name
, app
->pid
);
1236 health_code_update();
1241 * Disable the specified channel on to UST tracer for the UST session.
1243 static int disable_ust_channel(struct ust_app
*app
,
1244 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1248 health_code_update();
1250 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1252 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1253 ERR("UST app channel %s disable failed for app (pid: %d) "
1254 "and session handle %d with ret %d",
1255 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1258 * This is normal behavior, an application can die during the
1259 * creation process. Don't report an error so the execution can
1260 * continue normally.
1263 DBG3("UST app disable channel failed. Application is dead.");
1268 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1269 ua_chan
->name
, app
->pid
);
1272 health_code_update();
1277 * Enable the specified channel on to UST tracer for the UST session.
1279 static int enable_ust_channel(struct ust_app
*app
,
1280 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1284 health_code_update();
1286 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1288 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1289 ERR("UST app channel %s enable failed for app (pid: %d) "
1290 "and session handle %d with ret %d",
1291 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1294 * This is normal behavior, an application can die during the
1295 * creation process. Don't report an error so the execution can
1296 * continue normally.
1299 DBG3("UST app enable channel failed. Application is dead.");
1304 ua_chan
->enabled
= 1;
1306 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1307 ua_chan
->name
, app
->pid
);
1310 health_code_update();
1315 * Enable the specified event on to UST tracer for the UST session.
1317 static int enable_ust_event(struct ust_app
*app
,
1318 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1322 health_code_update();
1324 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1326 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1327 ERR("UST app event %s enable failed for app (pid: %d) "
1328 "and session handle %d with ret %d",
1329 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1332 * This is normal behavior, an application can die during the
1333 * creation process. Don't report an error so the execution can
1334 * continue normally.
1337 DBG3("UST app enable event failed. Application is dead.");
1342 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1343 ua_event
->attr
.name
, app
->pid
);
1346 health_code_update();
1351 * Send channel and stream buffer to application.
1353 * Return 0 on success. On error, a negative value is returned.
1355 static int send_channel_pid_to_ust(struct ust_app
*app
,
1356 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1359 struct ust_app_stream
*stream
, *stmp
;
1365 health_code_update();
1367 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1370 /* Send channel to the application. */
1371 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1376 health_code_update();
1378 /* Send all streams to application. */
1379 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1380 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1384 /* We don't need the stream anymore once sent to the tracer. */
1385 cds_list_del(&stream
->list
);
1386 delete_ust_app_stream(-1, stream
);
1388 /* Flag the channel that it is sent to the application. */
1389 ua_chan
->is_sent
= 1;
1392 health_code_update();
1397 * Create the specified event onto the UST tracer for a UST session.
1399 * Should be called with session mutex held.
1402 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1403 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1407 health_code_update();
1409 /* Create UST event on tracer */
1410 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1413 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1414 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1415 ua_event
->attr
.name
, app
->pid
, ret
);
1418 * This is normal behavior, an application can die during the
1419 * creation process. Don't report an error so the execution can
1420 * continue normally.
1423 DBG3("UST app create event failed. Application is dead.");
1428 ua_event
->handle
= ua_event
->obj
->handle
;
1430 DBG2("UST app event %s created successfully for pid:%d",
1431 ua_event
->attr
.name
, app
->pid
);
1433 health_code_update();
1435 /* Set filter if one is present. */
1436 if (ua_event
->filter
) {
1437 ret
= set_ust_event_filter(ua_event
, app
);
1443 /* Set exclusions for the event */
1444 if (ua_event
->exclusion
) {
1445 ret
= set_ust_event_exclusion(ua_event
, app
);
1451 /* If event not enabled, disable it on the tracer */
1452 if (ua_event
->enabled
) {
1454 * We now need to explicitly enable the event, since it
1455 * is now disabled at creation.
1457 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1460 * If we hit an EPERM, something is wrong with our enable call. If
1461 * we get an EEXIST, there is a problem on the tracer side since we
1465 case -LTTNG_UST_ERR_PERM
:
1466 /* Code flow problem */
1468 case -LTTNG_UST_ERR_EXIST
:
1469 /* It's OK for our use case. */
1478 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1481 * If we hit an EPERM, something is wrong with our disable call. If
1482 * we get an EEXIST, there is a problem on the tracer side since we
1486 case -LTTNG_UST_ERR_PERM
:
1487 /* Code flow problem */
1489 case -LTTNG_UST_ERR_EXIST
:
1490 /* It's OK for our use case. */
1501 health_code_update();
1506 * Copy data between an UST app event and a LTT event.
1508 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1509 struct ltt_ust_event
*uevent
)
1511 size_t exclusion_alloc_size
;
1513 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1514 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1516 ua_event
->enabled
= uevent
->enabled
;
1518 /* Copy event attributes */
1519 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1521 /* Copy filter bytecode */
1522 if (uevent
->filter
) {
1523 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1524 /* Filter might be NULL here in case of ENONEM. */
1527 /* Copy exclusion data */
1528 if (uevent
->exclusion
) {
1529 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1530 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1531 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1532 if (ua_event
->exclusion
== NULL
) {
1535 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1536 exclusion_alloc_size
);
1542 * Copy data between an UST app channel and a LTT channel.
1544 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1545 struct ltt_ust_channel
*uchan
)
1547 struct lttng_ht_iter iter
;
1548 struct ltt_ust_event
*uevent
;
1549 struct ltt_ust_context
*uctx
;
1550 struct ust_app_event
*ua_event
;
1551 struct ust_app_ctx
*ua_ctx
;
1553 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1555 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1556 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1558 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1559 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1561 /* Copy event attributes since the layout is different. */
1562 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1563 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1564 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1565 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1566 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1567 ua_chan
->attr
.output
= uchan
->attr
.output
;
1569 * Note that the attribute channel type is not set since the channel on the
1570 * tracing registry side does not have this information.
1573 ua_chan
->enabled
= uchan
->enabled
;
1574 ua_chan
->tracing_channel_id
= uchan
->id
;
1576 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1577 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1578 if (ua_ctx
== NULL
) {
1581 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1582 (unsigned long) ua_ctx
->ctx
.ctx
);
1583 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1584 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1587 /* Copy all events from ltt ust channel to ust app channel */
1588 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1589 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1590 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1591 if (ua_event
== NULL
) {
1592 DBG2("UST event %s not found on shadow copy channel",
1594 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1595 if (ua_event
== NULL
) {
1598 shadow_copy_event(ua_event
, uevent
);
1599 add_unique_ust_app_event(ua_chan
, ua_event
);
1603 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1607 * Copy data between a UST app session and a regular LTT session.
1609 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1610 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1612 struct lttng_ht_node_str
*ua_chan_node
;
1613 struct lttng_ht_iter iter
;
1614 struct ltt_ust_channel
*uchan
;
1615 struct ust_app_channel
*ua_chan
;
1617 struct tm
*timeinfo
;
1621 /* Get date and time for unique app path */
1623 timeinfo
= localtime(&rawtime
);
1624 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1626 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1628 ua_sess
->tracing_id
= usess
->id
;
1629 ua_sess
->id
= get_next_session_id();
1630 ua_sess
->uid
= app
->uid
;
1631 ua_sess
->gid
= app
->gid
;
1632 ua_sess
->euid
= usess
->uid
;
1633 ua_sess
->egid
= usess
->gid
;
1634 ua_sess
->buffer_type
= usess
->buffer_type
;
1635 ua_sess
->bits_per_long
= app
->bits_per_long
;
1636 /* There is only one consumer object per session possible. */
1637 ua_sess
->consumer
= usess
->consumer
;
1638 ua_sess
->output_traces
= usess
->output_traces
;
1639 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1640 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1641 &usess
->metadata_attr
);
1643 switch (ua_sess
->buffer_type
) {
1644 case LTTNG_BUFFER_PER_PID
:
1645 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1646 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1649 case LTTNG_BUFFER_PER_UID
:
1650 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1651 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1658 PERROR("asprintf UST shadow copy session");
1663 /* Iterate over all channels in global domain. */
1664 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1666 struct lttng_ht_iter uiter
;
1668 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1669 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1670 if (ua_chan_node
!= NULL
) {
1671 /* Session exist. Contiuing. */
1675 DBG2("Channel %s not found on shadow session copy, creating it",
1677 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1678 if (ua_chan
== NULL
) {
1679 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1682 shadow_copy_channel(ua_chan
, uchan
);
1684 * The concept of metadata channel does not exist on the tracing
1685 * registry side of the session daemon so this can only be a per CPU
1686 * channel and not metadata.
1688 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1690 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1698 * Lookup sesison wrapper.
1701 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1702 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1704 /* Get right UST app session from app */
1705 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1709 * Return ust app session from the app session hashtable using the UST session
1712 static struct ust_app_session
*lookup_session_by_app(
1713 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1715 struct lttng_ht_iter iter
;
1716 struct lttng_ht_node_u64
*node
;
1718 __lookup_session_by_app(usess
, app
, &iter
);
1719 node
= lttng_ht_iter_get_node_u64(&iter
);
1724 return caa_container_of(node
, struct ust_app_session
, node
);
1731 * Setup buffer registry per PID for the given session and application. If none
1732 * is found, a new one is created, added to the global registry and
1733 * initialized. If regp is valid, it's set with the newly created object.
1735 * Return 0 on success or else a negative value.
1737 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1738 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1741 struct buffer_reg_pid
*reg_pid
;
1748 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1751 * This is the create channel path meaning that if there is NO
1752 * registry available, we have to create one for this session.
1754 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1758 buffer_reg_pid_add(reg_pid
);
1763 /* Initialize registry. */
1764 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1765 app
->bits_per_long
, app
->uint8_t_alignment
,
1766 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1767 app
->uint64_t_alignment
, app
->long_alignment
,
1768 app
->byte_order
, app
->version
.major
,
1769 app
->version
.minor
);
1774 DBG3("UST app buffer registry per PID created successfully");
1786 * Setup buffer registry per UID for the given session and application. If none
1787 * is found, a new one is created, added to the global registry and
1788 * initialized. If regp is valid, it's set with the newly created object.
1790 * Return 0 on success or else a negative value.
1792 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1793 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1796 struct buffer_reg_uid
*reg_uid
;
1803 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1806 * This is the create channel path meaning that if there is NO
1807 * registry available, we have to create one for this session.
1809 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1810 LTTNG_DOMAIN_UST
, ®_uid
);
1814 buffer_reg_uid_add(reg_uid
);
1819 /* Initialize registry. */
1820 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1821 app
->bits_per_long
, app
->uint8_t_alignment
,
1822 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1823 app
->uint64_t_alignment
, app
->long_alignment
,
1824 app
->byte_order
, app
->version
.major
,
1825 app
->version
.minor
);
1829 /* Add node to teardown list of the session. */
1830 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1832 DBG3("UST app buffer registry per UID created successfully");
1844 * Create a session on the tracer side for the given app.
1846 * On success, ua_sess_ptr is populated with the session pointer or else left
1847 * untouched. If the session was created, is_created is set to 1. On error,
1848 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1851 * Returns 0 on success or else a negative code which is either -ENOMEM or
1852 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1854 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1855 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1858 int ret
, created
= 0;
1859 struct ust_app_session
*ua_sess
;
1863 assert(ua_sess_ptr
);
1865 health_code_update();
1867 ua_sess
= lookup_session_by_app(usess
, app
);
1868 if (ua_sess
== NULL
) {
1869 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1870 app
->pid
, usess
->id
);
1871 ua_sess
= alloc_ust_app_session(app
);
1872 if (ua_sess
== NULL
) {
1873 /* Only malloc can failed so something is really wrong */
1877 shadow_copy_session(ua_sess
, usess
, app
);
1881 switch (usess
->buffer_type
) {
1882 case LTTNG_BUFFER_PER_PID
:
1883 /* Init local registry. */
1884 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1889 case LTTNG_BUFFER_PER_UID
:
1890 /* Look for a global registry. If none exists, create one. */
1891 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1902 health_code_update();
1904 if (ua_sess
->handle
== -1) {
1905 ret
= ustctl_create_session(app
->sock
);
1907 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1908 ERR("Creating session for app pid %d with ret %d",
1911 DBG("UST app creating session failed. Application is dead");
1913 * This is normal behavior, an application can die during the
1914 * creation process. Don't report an error so the execution can
1915 * continue normally. This will get flagged ENOTCONN and the
1916 * caller will handle it.
1920 delete_ust_app_session(-1, ua_sess
, app
);
1921 if (ret
!= -ENOMEM
) {
1923 * Tracer is probably gone or got an internal error so let's
1924 * behave like it will soon unregister or not usable.
1931 ua_sess
->handle
= ret
;
1933 /* Add ust app session to app's HT */
1934 lttng_ht_node_init_u64(&ua_sess
->node
,
1935 ua_sess
->tracing_id
);
1936 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1938 DBG2("UST app session created successfully with handle %d", ret
);
1941 *ua_sess_ptr
= ua_sess
;
1943 *is_created
= created
;
1946 /* Everything went well. */
1950 health_code_update();
1955 * Match function for a hash table lookup of ust_app_ctx.
1957 * It matches an ust app context based on the context type and, in the case
1958 * of perf counters, their name.
1960 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1962 struct ust_app_ctx
*ctx
;
1963 const struct lttng_ust_context
*key
;
1968 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1972 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1976 /* Check the name in the case of perf thread counters. */
1977 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1978 if (strncmp(key
->u
.perf_counter
.name
,
1979 ctx
->ctx
.u
.perf_counter
.name
,
1980 sizeof(key
->u
.perf_counter
.name
))) {
1993 * Lookup for an ust app context from an lttng_ust_context.
1995 * Must be called while holding RCU read side lock.
1996 * Return an ust_app_ctx object or NULL on error.
1999 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2000 struct lttng_ust_context
*uctx
)
2002 struct lttng_ht_iter iter
;
2003 struct lttng_ht_node_ulong
*node
;
2004 struct ust_app_ctx
*app_ctx
= NULL
;
2009 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2010 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2011 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2012 node
= lttng_ht_iter_get_node_ulong(&iter
);
2017 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2024 * Create a context for the channel on the tracer.
2026 * Called with UST app session lock held and a RCU read side lock.
2029 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2030 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2031 struct ust_app
*app
)
2034 struct ust_app_ctx
*ua_ctx
;
2036 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2038 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2044 ua_ctx
= alloc_ust_app_ctx(uctx
);
2045 if (ua_ctx
== NULL
) {
2051 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2052 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2053 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2055 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2065 * Enable on the tracer side a ust app event for the session and channel.
2067 * Called with UST app session lock held.
2070 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2071 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2075 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2080 ua_event
->enabled
= 1;
2087 * Disable on the tracer side a ust app event for the session and channel.
2089 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2090 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2094 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2099 ua_event
->enabled
= 0;
2106 * Lookup ust app channel for session and disable it on the tracer side.
2109 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2110 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2114 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2119 ua_chan
->enabled
= 0;
2126 * Lookup ust app channel for session and enable it on the tracer side. This
2127 * MUST be called with a RCU read side lock acquired.
2129 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2130 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2133 struct lttng_ht_iter iter
;
2134 struct lttng_ht_node_str
*ua_chan_node
;
2135 struct ust_app_channel
*ua_chan
;
2137 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2138 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2139 if (ua_chan_node
== NULL
) {
2140 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2141 uchan
->name
, ua_sess
->tracing_id
);
2145 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2147 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2157 * Ask the consumer to create a channel and get it if successful.
2159 * Return 0 on success or else a negative value.
2161 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2162 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2163 int bitness
, struct ust_registry_session
*registry
)
2166 unsigned int nb_fd
= 0;
2167 struct consumer_socket
*socket
;
2175 health_code_update();
2177 /* Get the right consumer socket for the application. */
2178 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2184 health_code_update();
2186 /* Need one fd for the channel. */
2187 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2189 ERR("Exhausted number of available FD upon create channel");
2194 * Ask consumer to create channel. The consumer will return the number of
2195 * stream we have to expect.
2197 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2204 * Compute the number of fd needed before receiving them. It must be 2 per
2205 * stream (2 being the default value here).
2207 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2209 /* Reserve the amount of file descriptor we need. */
2210 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2212 ERR("Exhausted number of available FD upon create channel");
2213 goto error_fd_get_stream
;
2216 health_code_update();
2219 * Now get the channel from the consumer. This call wil populate the stream
2220 * list of that channel and set the ust objects.
2222 if (usess
->consumer
->enabled
) {
2223 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2233 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2234 error_fd_get_stream
:
2236 * Initiate a destroy channel on the consumer since we had an error
2237 * handling it on our side. The return value is of no importance since we
2238 * already have a ret value set by the previous error that we need to
2241 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2243 lttng_fd_put(LTTNG_FD_APPS
, 1);
2245 health_code_update();
2251 * Duplicate the ust data object of the ust app stream and save it in the
2252 * buffer registry stream.
2254 * Return 0 on success or else a negative value.
2256 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2257 struct ust_app_stream
*stream
)
2264 /* Reserve the amount of file descriptor we need. */
2265 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2267 ERR("Exhausted number of available FD upon duplicate stream");
2271 /* Duplicate object for stream once the original is in the registry. */
2272 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2273 reg_stream
->obj
.ust
);
2275 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2276 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2277 lttng_fd_put(LTTNG_FD_APPS
, 2);
2280 stream
->handle
= stream
->obj
->handle
;
2287 * Duplicate the ust data object of the ust app. channel and save it in the
2288 * buffer registry channel.
2290 * Return 0 on success or else a negative value.
2292 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2293 struct ust_app_channel
*ua_chan
)
2300 /* Need two fds for the channel. */
2301 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2303 ERR("Exhausted number of available FD upon duplicate channel");
2307 /* Duplicate object for stream once the original is in the registry. */
2308 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2310 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2311 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2314 ua_chan
->handle
= ua_chan
->obj
->handle
;
2319 lttng_fd_put(LTTNG_FD_APPS
, 1);
2325 * For a given channel buffer registry, setup all streams of the given ust
2326 * application channel.
2328 * Return 0 on success or else a negative value.
2330 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2331 struct ust_app_channel
*ua_chan
)
2334 struct ust_app_stream
*stream
, *stmp
;
2339 DBG2("UST app setup buffer registry stream");
2341 /* Send all streams to application. */
2342 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2343 struct buffer_reg_stream
*reg_stream
;
2345 ret
= buffer_reg_stream_create(®_stream
);
2351 * Keep original pointer and nullify it in the stream so the delete
2352 * stream call does not release the object.
2354 reg_stream
->obj
.ust
= stream
->obj
;
2356 buffer_reg_stream_add(reg_stream
, reg_chan
);
2358 /* We don't need the streams anymore. */
2359 cds_list_del(&stream
->list
);
2360 delete_ust_app_stream(-1, stream
);
2368 * Create a buffer registry channel for the given session registry and
2369 * application channel object. If regp pointer is valid, it's set with the
2370 * created object. Important, the created object is NOT added to the session
2371 * registry hash table.
2373 * Return 0 on success else a negative value.
2375 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2376 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2379 struct buffer_reg_channel
*reg_chan
= NULL
;
2384 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2386 /* Create buffer registry channel. */
2387 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2392 reg_chan
->consumer_key
= ua_chan
->key
;
2393 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2395 /* Create and add a channel registry to session. */
2396 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2397 ua_chan
->tracing_channel_id
);
2401 buffer_reg_channel_add(reg_sess
, reg_chan
);
2410 /* Safe because the registry channel object was not added to any HT. */
2411 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2417 * Setup buffer registry channel for the given session registry and application
2418 * channel object. If regp pointer is valid, it's set with the created object.
2420 * Return 0 on success else a negative value.
2422 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2423 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2430 assert(ua_chan
->obj
);
2432 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2434 /* Setup all streams for the registry. */
2435 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2440 reg_chan
->obj
.ust
= ua_chan
->obj
;
2441 ua_chan
->obj
= NULL
;
2446 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2447 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2452 * Send buffer registry channel to the application.
2454 * Return 0 on success else a negative value.
2456 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2457 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2458 struct ust_app_channel
*ua_chan
)
2461 struct buffer_reg_stream
*reg_stream
;
2468 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2470 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2475 /* Send channel to the application. */
2476 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2481 health_code_update();
2483 /* Send all streams to application. */
2484 pthread_mutex_lock(®_chan
->stream_list_lock
);
2485 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2486 struct ust_app_stream stream
;
2488 ret
= duplicate_stream_object(reg_stream
, &stream
);
2490 goto error_stream_unlock
;
2493 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2495 (void) release_ust_app_stream(-1, &stream
);
2496 goto error_stream_unlock
;
2500 * The return value is not important here. This function will output an
2503 (void) release_ust_app_stream(-1, &stream
);
2505 ua_chan
->is_sent
= 1;
2507 error_stream_unlock
:
2508 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2514 * Create and send to the application the created buffers with per UID buffers.
2516 * Return 0 on success else a negative value.
2518 static int create_channel_per_uid(struct ust_app
*app
,
2519 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2520 struct ust_app_channel
*ua_chan
)
2523 struct buffer_reg_uid
*reg_uid
;
2524 struct buffer_reg_channel
*reg_chan
;
2531 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2533 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2535 * The session creation handles the creation of this global registry
2536 * object. If none can be find, there is a code flow problem or a
2541 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2544 /* Create the buffer registry channel object. */
2545 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2547 ERR("Error creating the UST channel \"%s\" registry instance",
2554 * Create the buffers on the consumer side. This call populates the
2555 * ust app channel object with all streams and data object.
2557 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2558 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2560 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2564 * Let's remove the previously created buffer registry channel so
2565 * it's not visible anymore in the session registry.
2567 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2568 ua_chan
->tracing_channel_id
);
2569 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2570 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2575 * Setup the streams and add it to the session registry.
2577 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2579 ERR("Error setting up UST channel \"%s\"",
2586 /* Send buffers to the application. */
2587 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2590 * Don't report error to the console, since it may be
2591 * caused by application concurrently exiting.
2601 * Create and send to the application the created buffers with per PID buffers.
2603 * Return 0 on success else a negative value.
2605 static int create_channel_per_pid(struct ust_app
*app
,
2606 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2607 struct ust_app_channel
*ua_chan
)
2610 struct ust_registry_session
*registry
;
2617 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2621 registry
= get_session_registry(ua_sess
);
2624 /* Create and add a new channel registry to session. */
2625 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2627 ERR("Error creating the UST channel \"%s\" registry instance",
2632 /* Create and get channel on the consumer side. */
2633 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2634 app
->bits_per_long
, registry
);
2636 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2641 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2644 * Don't report error to the console, since it may be
2645 * caused by application concurrently exiting.
2656 * From an already allocated ust app channel, create the channel buffers if
2657 * need and send it to the application. This MUST be called with a RCU read
2658 * side lock acquired.
2660 * Return 0 on success or else a negative value.
2662 static int do_create_channel(struct ust_app
*app
,
2663 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2664 struct ust_app_channel
*ua_chan
)
2673 /* Handle buffer type before sending the channel to the application. */
2674 switch (usess
->buffer_type
) {
2675 case LTTNG_BUFFER_PER_UID
:
2677 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2683 case LTTNG_BUFFER_PER_PID
:
2685 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2697 /* Initialize ust objd object using the received handle and add it. */
2698 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2699 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2701 /* If channel is not enabled, disable it on the tracer */
2702 if (!ua_chan
->enabled
) {
2703 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2714 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2715 * newly created channel if not NULL.
2717 * Called with UST app session lock and RCU read-side lock held.
2719 * Return 0 on success or else a negative value.
2721 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2722 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2723 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2724 struct ust_app_channel
**ua_chanp
)
2727 struct lttng_ht_iter iter
;
2728 struct lttng_ht_node_str
*ua_chan_node
;
2729 struct ust_app_channel
*ua_chan
;
2731 /* Lookup channel in the ust app session */
2732 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2733 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2734 if (ua_chan_node
!= NULL
) {
2735 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2739 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2740 if (ua_chan
== NULL
) {
2741 /* Only malloc can fail here */
2745 shadow_copy_channel(ua_chan
, uchan
);
2747 /* Set channel type. */
2748 ua_chan
->attr
.type
= type
;
2750 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2755 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2758 /* Only add the channel if successful on the tracer side. */
2759 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2763 *ua_chanp
= ua_chan
;
2766 /* Everything went well. */
2770 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2776 * Create UST app event and create it on the tracer side.
2778 * Called with ust app session mutex held.
2781 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2782 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2783 struct ust_app
*app
)
2786 struct ust_app_event
*ua_event
;
2788 /* Get event node */
2789 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2790 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2791 if (ua_event
!= NULL
) {
2796 /* Does not exist so create one */
2797 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2798 if (ua_event
== NULL
) {
2799 /* Only malloc can failed so something is really wrong */
2803 shadow_copy_event(ua_event
, uevent
);
2805 /* Create it on the tracer side */
2806 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2808 /* Not found previously means that it does not exist on the tracer */
2809 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2813 add_unique_ust_app_event(ua_chan
, ua_event
);
2815 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2822 /* Valid. Calling here is already in a read side lock */
2823 delete_ust_app_event(-1, ua_event
);
2828 * Create UST metadata and open it on the tracer side.
2830 * Called with UST app session lock held and RCU read side lock.
2832 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2833 struct ust_app
*app
, struct consumer_output
*consumer
)
2836 struct ust_app_channel
*metadata
;
2837 struct consumer_socket
*socket
;
2838 struct ust_registry_session
*registry
;
2844 registry
= get_session_registry(ua_sess
);
2847 /* Metadata already exists for this registry or it was closed previously */
2848 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2853 /* Allocate UST metadata */
2854 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2856 /* malloc() failed */
2861 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2863 /* Need one fd for the channel. */
2864 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2866 ERR("Exhausted number of available FD upon create metadata");
2870 /* Get the right consumer socket for the application. */
2871 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2874 goto error_consumer
;
2878 * Keep metadata key so we can identify it on the consumer side. Assign it
2879 * to the registry *before* we ask the consumer so we avoid the race of the
2880 * consumer requesting the metadata and the ask_channel call on our side
2881 * did not returned yet.
2883 registry
->metadata_key
= metadata
->key
;
2886 * Ask the metadata channel creation to the consumer. The metadata object
2887 * will be created by the consumer and kept their. However, the stream is
2888 * never added or monitored until we do a first push metadata to the
2891 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2894 /* Nullify the metadata key so we don't try to close it later on. */
2895 registry
->metadata_key
= 0;
2896 goto error_consumer
;
2900 * The setup command will make the metadata stream be sent to the relayd,
2901 * if applicable, and the thread managing the metadatas. This is important
2902 * because after this point, if an error occurs, the only way the stream
2903 * can be deleted is to be monitored in the consumer.
2905 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2907 /* Nullify the metadata key so we don't try to close it later on. */
2908 registry
->metadata_key
= 0;
2909 goto error_consumer
;
2912 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2913 metadata
->key
, app
->pid
);
2916 lttng_fd_put(LTTNG_FD_APPS
, 1);
2917 delete_ust_app_channel(-1, metadata
, app
);
2923 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2924 * acquired before calling this function.
2926 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2928 struct ust_app
*app
= NULL
;
2929 struct lttng_ht_node_ulong
*node
;
2930 struct lttng_ht_iter iter
;
2932 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2933 node
= lttng_ht_iter_get_node_ulong(&iter
);
2935 DBG2("UST app no found with pid %d", pid
);
2939 DBG2("Found UST app by pid %d", pid
);
2941 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2948 * Allocate and init an UST app object using the registration information and
2949 * the command socket. This is called when the command socket connects to the
2952 * The object is returned on success or else NULL.
2954 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2956 struct ust_app
*lta
= NULL
;
2961 DBG3("UST app creating application for socket %d", sock
);
2963 if ((msg
->bits_per_long
== 64 &&
2964 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2965 || (msg
->bits_per_long
== 32 &&
2966 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2967 ERR("Registration failed: application \"%s\" (pid: %d) has "
2968 "%d-bit long, but no consumerd for this size is available.\n",
2969 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2973 lta
= zmalloc(sizeof(struct ust_app
));
2979 lta
->ppid
= msg
->ppid
;
2980 lta
->uid
= msg
->uid
;
2981 lta
->gid
= msg
->gid
;
2983 lta
->bits_per_long
= msg
->bits_per_long
;
2984 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2985 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2986 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2987 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2988 lta
->long_alignment
= msg
->long_alignment
;
2989 lta
->byte_order
= msg
->byte_order
;
2991 lta
->v_major
= msg
->major
;
2992 lta
->v_minor
= msg
->minor
;
2993 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2994 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2995 lta
->notify_sock
= -1;
2997 /* Copy name and make sure it's NULL terminated. */
2998 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2999 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3002 * Before this can be called, when receiving the registration information,
3003 * the application compatibility is checked. So, at this point, the
3004 * application can work with this session daemon.
3006 lta
->compatible
= 1;
3008 lta
->pid
= msg
->pid
;
3009 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3011 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3013 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3020 * For a given application object, add it to every hash table.
3022 void ust_app_add(struct ust_app
*app
)
3025 assert(app
->notify_sock
>= 0);
3030 * On a re-registration, we want to kick out the previous registration of
3033 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3036 * The socket _should_ be unique until _we_ call close. So, a add_unique
3037 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3038 * already in the table.
3040 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3042 /* Add application to the notify socket hash table. */
3043 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3044 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3046 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3047 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3048 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3055 * Set the application version into the object.
3057 * Return 0 on success else a negative value either an errno code or a
3058 * LTTng-UST error code.
3060 int ust_app_version(struct ust_app
*app
)
3066 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3068 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3069 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3071 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3079 * Unregister app by removing it from the global traceable app list and freeing
3082 * The socket is already closed at this point so no close to sock.
3084 void ust_app_unregister(int sock
)
3086 struct ust_app
*lta
;
3087 struct lttng_ht_node_ulong
*node
;
3088 struct lttng_ht_iter ust_app_sock_iter
;
3089 struct lttng_ht_iter iter
;
3090 struct ust_app_session
*ua_sess
;
3095 /* Get the node reference for a call_rcu */
3096 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3097 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3100 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3101 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3104 * Perform "push metadata" and flush all application streams
3105 * before removing app from hash tables, ensuring proper
3106 * behavior of data_pending check.
3107 * Remove sessions so they are not visible during deletion.
3109 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3111 struct ust_registry_session
*registry
;
3113 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3115 /* The session was already removed so scheduled for teardown. */
3119 (void) ust_app_flush_app_session(lta
, ua_sess
);
3122 * Add session to list for teardown. This is safe since at this point we
3123 * are the only one using this list.
3125 pthread_mutex_lock(&ua_sess
->lock
);
3128 * Normally, this is done in the delete session process which is
3129 * executed in the call rcu below. However, upon registration we can't
3130 * afford to wait for the grace period before pushing data or else the
3131 * data pending feature can race between the unregistration and stop
3132 * command where the data pending command is sent *before* the grace
3135 * The close metadata below nullifies the metadata pointer in the
3136 * session so the delete session will NOT push/close a second time.
3138 registry
= get_session_registry(ua_sess
);
3139 if (registry
&& !registry
->metadata_closed
) {
3140 /* Push metadata for application before freeing the application. */
3141 (void) push_metadata(registry
, ua_sess
->consumer
);
3144 * Don't ask to close metadata for global per UID buffers. Close
3145 * metadata only on destroy trace session in this case. Also, the
3146 * previous push metadata could have flag the metadata registry to
3147 * close so don't send a close command if closed.
3149 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3150 !registry
->metadata_closed
) {
3151 /* And ask to close it for this session registry. */
3152 (void) close_metadata(registry
, ua_sess
->consumer
);
3155 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3157 pthread_mutex_unlock(&ua_sess
->lock
);
3160 /* Remove application from PID hash table */
3161 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3165 * Remove application from notify hash table. The thread handling the
3166 * notify socket could have deleted the node so ignore on error because
3167 * either way it's valid. The close of that socket is handled by the other
3170 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3171 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3174 * Ignore return value since the node might have been removed before by an
3175 * add replace during app registration because the PID can be reassigned by
3178 iter
.iter
.node
= <a
->pid_n
.node
;
3179 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3181 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3186 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3193 * Fill events array with all events name of all registered apps.
3195 int ust_app_list_events(struct lttng_event
**events
)
3198 size_t nbmem
, count
= 0;
3199 struct lttng_ht_iter iter
;
3200 struct ust_app
*app
;
3201 struct lttng_event
*tmp_event
;
3203 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3204 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3205 if (tmp_event
== NULL
) {
3206 PERROR("zmalloc ust app events");
3213 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3214 struct lttng_ust_tracepoint_iter uiter
;
3216 health_code_update();
3218 if (!app
->compatible
) {
3220 * TODO: In time, we should notice the caller of this error by
3221 * telling him that this is a version error.
3225 handle
= ustctl_tracepoint_list(app
->sock
);
3227 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3228 ERR("UST app list events getting handle failed for app pid %d",
3234 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3235 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3236 /* Handle ustctl error. */
3238 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3239 ERR("UST app tp list get failed for app %d with ret %d",
3242 DBG3("UST app tp list get failed. Application is dead");
3244 * This is normal behavior, an application can die during the
3245 * creation process. Don't report an error so the execution can
3246 * continue normally. Continue normal execution.
3254 health_code_update();
3255 if (count
>= nbmem
) {
3256 /* In case the realloc fails, we free the memory */
3257 struct lttng_event
*new_tmp_event
;
3260 new_nbmem
= nbmem
<< 1;
3261 DBG2("Reallocating event list from %zu to %zu entries",
3263 new_tmp_event
= realloc(tmp_event
,
3264 new_nbmem
* sizeof(struct lttng_event
));
3265 if (new_tmp_event
== NULL
) {
3266 PERROR("realloc ust app events");
3271 /* Zero the new memory */
3272 memset(new_tmp_event
+ nbmem
, 0,
3273 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3275 tmp_event
= new_tmp_event
;
3277 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3278 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3279 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3280 tmp_event
[count
].pid
= app
->pid
;
3281 tmp_event
[count
].enabled
= -1;
3287 *events
= tmp_event
;
3289 DBG2("UST app list events done (%zu events)", count
);
3294 health_code_update();
3299 * Fill events array with all events name of all registered apps.
3301 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3304 size_t nbmem
, count
= 0;
3305 struct lttng_ht_iter iter
;
3306 struct ust_app
*app
;
3307 struct lttng_event_field
*tmp_event
;
3309 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3310 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3311 if (tmp_event
== NULL
) {
3312 PERROR("zmalloc ust app event fields");
3319 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3320 struct lttng_ust_field_iter uiter
;
3322 health_code_update();
3324 if (!app
->compatible
) {
3326 * TODO: In time, we should notice the caller of this error by
3327 * telling him that this is a version error.
3331 handle
= ustctl_tracepoint_field_list(app
->sock
);
3333 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3334 ERR("UST app list field getting handle failed for app pid %d",
3340 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3341 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3342 /* Handle ustctl error. */
3344 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3345 ERR("UST app tp list field failed for app %d with ret %d",
3348 DBG3("UST app tp list field failed. Application is dead");
3350 * This is normal behavior, an application can die during the
3351 * creation process. Don't report an error so the execution can
3352 * continue normally. Reset list and count for next app.
3360 health_code_update();
3361 if (count
>= nbmem
) {
3362 /* In case the realloc fails, we free the memory */
3363 struct lttng_event_field
*new_tmp_event
;
3366 new_nbmem
= nbmem
<< 1;
3367 DBG2("Reallocating event field list from %zu to %zu entries",
3369 new_tmp_event
= realloc(tmp_event
,
3370 new_nbmem
* sizeof(struct lttng_event_field
));
3371 if (new_tmp_event
== NULL
) {
3372 PERROR("realloc ust app event fields");
3377 /* Zero the new memory */
3378 memset(new_tmp_event
+ nbmem
, 0,
3379 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3381 tmp_event
= new_tmp_event
;
3384 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3385 /* Mapping between these enums matches 1 to 1. */
3386 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3387 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3389 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3390 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3391 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3392 tmp_event
[count
].event
.pid
= app
->pid
;
3393 tmp_event
[count
].event
.enabled
= -1;
3399 *fields
= tmp_event
;
3401 DBG2("UST app list event fields done (%zu events)", count
);
3406 health_code_update();
3411 * Free and clean all traceable apps of the global list.
3413 * Should _NOT_ be called with RCU read-side lock held.
3415 void ust_app_clean_list(void)
3418 struct ust_app
*app
;
3419 struct lttng_ht_iter iter
;
3421 DBG2("UST app cleaning registered apps hash table");
3425 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3426 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3428 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3431 /* Cleanup socket hash table */
3432 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3434 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3438 /* Cleanup notify socket hash table */
3439 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3440 notify_sock_n
.node
) {
3441 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3446 /* Destroy is done only when the ht is empty */
3447 ht_cleanup_push(ust_app_ht
);
3448 ht_cleanup_push(ust_app_ht_by_sock
);
3449 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3453 * Init UST app hash table.
3455 void ust_app_ht_alloc(void)
3457 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3458 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3459 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3463 * For a specific UST session, disable the channel for all registered apps.
3465 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3466 struct ltt_ust_channel
*uchan
)
3469 struct lttng_ht_iter iter
;
3470 struct lttng_ht_node_str
*ua_chan_node
;
3471 struct ust_app
*app
;
3472 struct ust_app_session
*ua_sess
;
3473 struct ust_app_channel
*ua_chan
;
3475 if (usess
== NULL
|| uchan
== NULL
) {
3476 ERR("Disabling UST global channel with NULL values");
3481 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3482 uchan
->name
, usess
->id
);
3486 /* For every registered applications */
3487 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3488 struct lttng_ht_iter uiter
;
3489 if (!app
->compatible
) {
3491 * TODO: In time, we should notice the caller of this error by
3492 * telling him that this is a version error.
3496 ua_sess
= lookup_session_by_app(usess
, app
);
3497 if (ua_sess
== NULL
) {
3502 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3503 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3504 /* If the session if found for the app, the channel must be there */
3505 assert(ua_chan_node
);
3507 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3508 /* The channel must not be already disabled */
3509 assert(ua_chan
->enabled
== 1);
3511 /* Disable channel onto application */
3512 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3514 /* XXX: We might want to report this error at some point... */
3526 * For a specific UST session, enable the channel for all registered apps.
3528 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3529 struct ltt_ust_channel
*uchan
)
3532 struct lttng_ht_iter iter
;
3533 struct ust_app
*app
;
3534 struct ust_app_session
*ua_sess
;
3536 if (usess
== NULL
|| uchan
== NULL
) {
3537 ERR("Adding UST global channel to NULL values");
3542 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3543 uchan
->name
, usess
->id
);
3547 /* For every registered applications */
3548 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3549 if (!app
->compatible
) {
3551 * TODO: In time, we should notice the caller of this error by
3552 * telling him that this is a version error.
3556 ua_sess
= lookup_session_by_app(usess
, app
);
3557 if (ua_sess
== NULL
) {
3561 /* Enable channel onto application */
3562 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3564 /* XXX: We might want to report this error at some point... */
3576 * Disable an event in a channel and for a specific session.
3578 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3579 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3582 struct lttng_ht_iter iter
, uiter
;
3583 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3584 struct ust_app
*app
;
3585 struct ust_app_session
*ua_sess
;
3586 struct ust_app_channel
*ua_chan
;
3587 struct ust_app_event
*ua_event
;
3589 DBG("UST app disabling event %s for all apps in channel "
3590 "%s for session id %" PRIu64
,
3591 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3595 /* For all registered applications */
3596 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3597 if (!app
->compatible
) {
3599 * TODO: In time, we should notice the caller of this error by
3600 * telling him that this is a version error.
3604 ua_sess
= lookup_session_by_app(usess
, app
);
3605 if (ua_sess
== NULL
) {
3610 /* Lookup channel in the ust app session */
3611 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3612 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3613 if (ua_chan_node
== NULL
) {
3614 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3615 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3618 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3620 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3621 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3622 if (ua_event_node
== NULL
) {
3623 DBG2("Event %s not found in channel %s for app pid %d."
3624 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3627 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3629 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3631 /* XXX: Report error someday... */
3642 * For a specific UST session, create the channel for all registered apps.
3644 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3645 struct ltt_ust_channel
*uchan
)
3647 int ret
= 0, created
;
3648 struct lttng_ht_iter iter
;
3649 struct ust_app
*app
;
3650 struct ust_app_session
*ua_sess
= NULL
;
3652 /* Very wrong code flow */
3656 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3657 uchan
->name
, usess
->id
);
3661 /* For every registered applications */
3662 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3663 if (!app
->compatible
) {
3665 * TODO: In time, we should notice the caller of this error by
3666 * telling him that this is a version error.
3671 * Create session on the tracer side and add it to app session HT. Note
3672 * that if session exist, it will simply return a pointer to the ust
3675 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3680 * The application's socket is not valid. Either a bad socket
3681 * or a timeout on it. We can't inform the caller that for a
3682 * specific app, the session failed so lets continue here.
3687 goto error_rcu_unlock
;
3692 pthread_mutex_lock(&ua_sess
->lock
);
3693 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3694 sizeof(uchan
->name
))) {
3695 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3698 /* Create channel onto application. We don't need the chan ref. */
3699 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3700 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3702 pthread_mutex_unlock(&ua_sess
->lock
);
3704 if (ret
== -ENOMEM
) {
3705 /* No more memory is a fatal error. Stop right now. */
3706 goto error_rcu_unlock
;
3708 /* Cleanup the created session if it's the case. */
3710 destroy_app_session(app
, ua_sess
);
3721 * Enable event for a specific session and channel on the tracer.
3723 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3724 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3727 struct lttng_ht_iter iter
, uiter
;
3728 struct lttng_ht_node_str
*ua_chan_node
;
3729 struct ust_app
*app
;
3730 struct ust_app_session
*ua_sess
;
3731 struct ust_app_channel
*ua_chan
;
3732 struct ust_app_event
*ua_event
;
3734 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3735 uevent
->attr
.name
, usess
->id
);
3738 * NOTE: At this point, this function is called only if the session and
3739 * channel passed are already created for all apps. and enabled on the
3745 /* For all registered applications */
3746 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3747 if (!app
->compatible
) {
3749 * TODO: In time, we should notice the caller of this error by
3750 * telling him that this is a version error.
3754 ua_sess
= lookup_session_by_app(usess
, app
);
3756 /* The application has problem or is probably dead. */
3760 pthread_mutex_lock(&ua_sess
->lock
);
3762 /* Lookup channel in the ust app session */
3763 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3764 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3765 /* If the channel is not found, there is a code flow error */
3766 assert(ua_chan_node
);
3768 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3770 /* Get event node */
3771 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3772 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3773 if (ua_event
== NULL
) {
3774 DBG3("UST app enable event %s not found for app PID %d."
3775 "Skipping app", uevent
->attr
.name
, app
->pid
);
3779 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3781 pthread_mutex_unlock(&ua_sess
->lock
);
3785 pthread_mutex_unlock(&ua_sess
->lock
);
3794 * For a specific existing UST session and UST channel, creates the event for
3795 * all registered apps.
3797 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3798 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3801 struct lttng_ht_iter iter
, uiter
;
3802 struct lttng_ht_node_str
*ua_chan_node
;
3803 struct ust_app
*app
;
3804 struct ust_app_session
*ua_sess
;
3805 struct ust_app_channel
*ua_chan
;
3807 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3808 uevent
->attr
.name
, usess
->id
);
3812 /* For all registered applications */
3813 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3814 if (!app
->compatible
) {
3816 * TODO: In time, we should notice the caller of this error by
3817 * telling him that this is a version error.
3821 ua_sess
= lookup_session_by_app(usess
, app
);
3823 /* The application has problem or is probably dead. */
3827 pthread_mutex_lock(&ua_sess
->lock
);
3828 /* Lookup channel in the ust app session */
3829 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3830 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3831 /* If the channel is not found, there is a code flow error */
3832 assert(ua_chan_node
);
3834 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3836 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3837 pthread_mutex_unlock(&ua_sess
->lock
);
3839 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3840 /* Possible value at this point: -ENOMEM. If so, we stop! */
3843 DBG2("UST app event %s already exist on app PID %d",
3844 uevent
->attr
.name
, app
->pid
);
3855 * Start tracing for a specific UST session and app.
3858 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3861 struct ust_app_session
*ua_sess
;
3863 DBG("Starting tracing for ust app pid %d", app
->pid
);
3867 if (!app
->compatible
) {
3871 ua_sess
= lookup_session_by_app(usess
, app
);
3872 if (ua_sess
== NULL
) {
3873 /* The session is in teardown process. Ignore and continue. */
3877 pthread_mutex_lock(&ua_sess
->lock
);
3879 /* Upon restart, we skip the setup, already done */
3880 if (ua_sess
->started
) {
3884 /* Create directories if consumer is LOCAL and has a path defined. */
3885 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3886 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3887 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3888 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3890 if (ret
!= -EEXIST
) {
3891 ERR("Trace directory creation error");
3898 * Create the metadata for the application. This returns gracefully if a
3899 * metadata was already set for the session.
3901 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3906 health_code_update();
3909 /* This start the UST tracing */
3910 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3912 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3913 ERR("Error starting tracing for app pid: %d (ret: %d)",
3916 DBG("UST app start session failed. Application is dead.");
3918 * This is normal behavior, an application can die during the
3919 * creation process. Don't report an error so the execution can
3920 * continue normally.
3922 pthread_mutex_unlock(&ua_sess
->lock
);
3928 /* Indicate that the session has been started once */
3929 ua_sess
->started
= 1;
3931 pthread_mutex_unlock(&ua_sess
->lock
);
3933 health_code_update();
3935 /* Quiescent wait after starting trace */
3936 ret
= ustctl_wait_quiescent(app
->sock
);
3937 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3938 ERR("UST app wait quiescent failed for app pid %d ret %d",
3944 health_code_update();
3948 pthread_mutex_unlock(&ua_sess
->lock
);
3950 health_code_update();
3955 * Stop tracing for a specific UST session and app.
3958 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3961 struct ust_app_session
*ua_sess
;
3962 struct ust_registry_session
*registry
;
3964 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3968 if (!app
->compatible
) {
3969 goto end_no_session
;
3972 ua_sess
= lookup_session_by_app(usess
, app
);
3973 if (ua_sess
== NULL
) {
3974 goto end_no_session
;
3977 pthread_mutex_lock(&ua_sess
->lock
);
3980 * If started = 0, it means that stop trace has been called for a session
3981 * that was never started. It's possible since we can have a fail start
3982 * from either the application manager thread or the command thread. Simply
3983 * indicate that this is a stop error.
3985 if (!ua_sess
->started
) {
3986 goto error_rcu_unlock
;
3989 health_code_update();
3991 /* This inhibits UST tracing */
3992 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3994 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3995 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3998 DBG("UST app stop session failed. Application is dead.");
4000 * This is normal behavior, an application can die during the
4001 * creation process. Don't report an error so the execution can
4002 * continue normally.
4006 goto error_rcu_unlock
;
4009 health_code_update();
4011 /* Quiescent wait after stopping trace */
4012 ret
= ustctl_wait_quiescent(app
->sock
);
4013 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4014 ERR("UST app wait quiescent failed for app pid %d ret %d",
4018 health_code_update();
4020 registry
= get_session_registry(ua_sess
);
4023 if (!registry
->metadata_closed
) {
4024 /* Push metadata for application before freeing the application. */
4025 (void) push_metadata(registry
, ua_sess
->consumer
);
4029 pthread_mutex_unlock(&ua_sess
->lock
);
4032 health_code_update();
4036 pthread_mutex_unlock(&ua_sess
->lock
);
4038 health_code_update();
4043 int ust_app_flush_app_session(struct ust_app
*app
,
4044 struct ust_app_session
*ua_sess
)
4046 int ret
, retval
= 0;
4047 struct lttng_ht_iter iter
;
4048 struct ust_app_channel
*ua_chan
;
4049 struct consumer_socket
*socket
;
4051 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4055 if (!app
->compatible
) {
4056 goto end_not_compatible
;
4059 pthread_mutex_lock(&ua_sess
->lock
);
4061 health_code_update();
4063 /* Flushing buffers */
4064 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4066 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4068 health_code_update();
4069 assert(ua_chan
->is_sent
);
4070 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4072 ERR("Error flushing consumer channel");
4078 health_code_update();
4080 pthread_mutex_unlock(&ua_sess
->lock
);
4083 health_code_update();
4088 * Flush buffers for a specific UST session and app.
4091 int ust_app_flush_session(struct ust_app
*app
, struct ltt_ust_session
*usess
)
4095 struct ust_app_session
*ua_sess
;
4097 DBG("Flushing session buffers for ust app pid %d", app
->pid
);
4101 ua_sess
= lookup_session_by_app(usess
, app
);
4102 if (ua_sess
== NULL
) {
4104 goto end_no_session
;
4106 ret
= ust_app_flush_app_session(app
, ua_sess
);
4110 health_code_update();
4115 * Destroy a specific UST session in apps.
4117 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4120 struct ust_app_session
*ua_sess
;
4121 struct lttng_ht_iter iter
;
4122 struct lttng_ht_node_u64
*node
;
4124 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4128 if (!app
->compatible
) {
4132 __lookup_session_by_app(usess
, app
, &iter
);
4133 node
= lttng_ht_iter_get_node_u64(&iter
);
4135 /* Session is being or is deleted. */
4138 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4140 health_code_update();
4141 destroy_app_session(app
, ua_sess
);
4143 health_code_update();
4145 /* Quiescent wait after stopping trace */
4146 ret
= ustctl_wait_quiescent(app
->sock
);
4147 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4148 ERR("UST app wait quiescent failed for app pid %d ret %d",
4153 health_code_update();
4158 * Start tracing for the UST session.
4160 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4163 struct lttng_ht_iter iter
;
4164 struct ust_app
*app
;
4166 DBG("Starting all UST traces");
4170 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4171 ret
= ust_app_start_trace(usess
, app
);
4173 /* Continue to next apps even on error */
4184 * Start tracing for the UST session.
4186 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4189 struct lttng_ht_iter iter
;
4190 struct ust_app
*app
;
4192 DBG("Stopping all UST traces");
4196 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4197 ret
= ust_app_stop_trace(usess
, app
);
4199 /* Continue to next apps even on error */
4204 /* Flush buffers and push metadata (for UID buffers). */
4205 switch (usess
->buffer_type
) {
4206 case LTTNG_BUFFER_PER_UID
:
4208 struct buffer_reg_uid
*reg
;
4210 /* Flush all per UID buffers associated to that session. */
4211 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4212 struct ust_registry_session
*ust_session_reg
;
4213 struct buffer_reg_channel
*reg_chan
;
4214 struct consumer_socket
*socket
;
4216 /* Get consumer socket to use to push the metadata.*/
4217 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4220 /* Ignore request if no consumer is found for the session. */
4224 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4225 reg_chan
, node
.node
) {
4227 * The following call will print error values so the return
4228 * code is of little importance because whatever happens, we
4229 * have to try them all.
4231 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4234 ust_session_reg
= reg
->registry
->reg
.ust
;
4235 if (!ust_session_reg
->metadata_closed
) {
4236 /* Push metadata. */
4237 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4243 case LTTNG_BUFFER_PER_PID
:
4244 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4245 ret
= ust_app_flush_session(app
, usess
);
4247 /* Continue to next apps even on error */
4263 * Destroy app UST session.
4265 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4268 struct lttng_ht_iter iter
;
4269 struct ust_app
*app
;
4271 DBG("Destroy all UST traces");
4275 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4276 ret
= destroy_trace(usess
, app
);
4278 /* Continue to next apps even on error */
4289 * Add channels/events from UST global domain to registered apps at sock.
4291 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4294 struct lttng_ht_iter iter
, uiter
;
4295 struct ust_app
*app
;
4296 struct ust_app_session
*ua_sess
= NULL
;
4297 struct ust_app_channel
*ua_chan
;
4298 struct ust_app_event
*ua_event
;
4299 struct ust_app_ctx
*ua_ctx
;
4304 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4309 app
= ust_app_find_by_sock(sock
);
4312 * Application can be unregistered before so this is possible hence
4313 * simply stopping the update.
4315 DBG3("UST app update failed to find app sock %d", sock
);
4319 if (!app
->compatible
) {
4323 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4325 /* Tracer is probably gone or ENOMEM. */
4330 pthread_mutex_lock(&ua_sess
->lock
);
4333 * We can iterate safely here over all UST app session since the create ust
4334 * app session above made a shadow copy of the UST global domain from the
4337 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4339 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4342 * Stop everything. On error, the application failed, no more
4343 * file descriptor are available or ENOMEM so stopping here is
4344 * the only thing we can do for now.
4350 * Add context using the list so they are enabled in the same order the
4353 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4354 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4361 /* For each events */
4362 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4364 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4371 pthread_mutex_unlock(&ua_sess
->lock
);
4373 if (usess
->active
) {
4374 ret
= ust_app_start_trace(usess
, app
);
4379 DBG2("UST trace started for app pid %d", app
->pid
);
4382 /* Everything went well at this point. */
4387 pthread_mutex_unlock(&ua_sess
->lock
);
4390 destroy_app_session(app
, ua_sess
);
4397 * Add context to a specific channel for global UST domain.
4399 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4400 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4403 struct lttng_ht_node_str
*ua_chan_node
;
4404 struct lttng_ht_iter iter
, uiter
;
4405 struct ust_app_channel
*ua_chan
= NULL
;
4406 struct ust_app_session
*ua_sess
;
4407 struct ust_app
*app
;
4411 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4412 if (!app
->compatible
) {
4414 * TODO: In time, we should notice the caller of this error by
4415 * telling him that this is a version error.
4419 ua_sess
= lookup_session_by_app(usess
, app
);
4420 if (ua_sess
== NULL
) {
4424 pthread_mutex_lock(&ua_sess
->lock
);
4425 /* Lookup channel in the ust app session */
4426 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4427 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4428 if (ua_chan_node
== NULL
) {
4431 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4433 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4438 pthread_mutex_unlock(&ua_sess
->lock
);
4446 * Enable event for a channel from a UST session for a specific PID.
4448 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4449 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4452 struct lttng_ht_iter iter
;
4453 struct lttng_ht_node_str
*ua_chan_node
;
4454 struct ust_app
*app
;
4455 struct ust_app_session
*ua_sess
;
4456 struct ust_app_channel
*ua_chan
;
4457 struct ust_app_event
*ua_event
;
4459 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4463 app
= ust_app_find_by_pid(pid
);
4465 ERR("UST app enable event per PID %d not found", pid
);
4470 if (!app
->compatible
) {
4475 ua_sess
= lookup_session_by_app(usess
, app
);
4477 /* The application has problem or is probably dead. */
4482 pthread_mutex_lock(&ua_sess
->lock
);
4483 /* Lookup channel in the ust app session */
4484 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4485 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4486 /* If the channel is not found, there is a code flow error */
4487 assert(ua_chan_node
);
4489 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4491 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4492 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4493 if (ua_event
== NULL
) {
4494 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4499 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4506 pthread_mutex_unlock(&ua_sess
->lock
);
4513 * Calibrate registered applications.
4515 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4518 struct lttng_ht_iter iter
;
4519 struct ust_app
*app
;
4523 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4524 if (!app
->compatible
) {
4526 * TODO: In time, we should notice the caller of this error by
4527 * telling him that this is a version error.
4532 health_code_update();
4534 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4538 /* Means that it's not implemented on the tracer side. */
4542 DBG2("Calibrate app PID %d returned with error %d",
4549 DBG("UST app global domain calibration finished");
4553 health_code_update();
4559 * Receive registration and populate the given msg structure.
4561 * On success return 0 else a negative value returned by the ustctl call.
4563 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4566 uint32_t pid
, ppid
, uid
, gid
;
4570 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4571 &pid
, &ppid
, &uid
, &gid
,
4572 &msg
->bits_per_long
,
4573 &msg
->uint8_t_alignment
,
4574 &msg
->uint16_t_alignment
,
4575 &msg
->uint32_t_alignment
,
4576 &msg
->uint64_t_alignment
,
4577 &msg
->long_alignment
,
4584 case LTTNG_UST_ERR_EXITING
:
4585 DBG3("UST app recv reg message failed. Application died");
4587 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4588 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4589 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4590 LTTNG_UST_ABI_MINOR_VERSION
);
4593 ERR("UST app recv reg message failed with ret %d", ret
);
4598 msg
->pid
= (pid_t
) pid
;
4599 msg
->ppid
= (pid_t
) ppid
;
4600 msg
->uid
= (uid_t
) uid
;
4601 msg
->gid
= (gid_t
) gid
;
4608 * Return a ust app channel object using the application object and the channel
4609 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4610 * lock MUST be acquired before calling this function.
4612 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4615 struct lttng_ht_node_ulong
*node
;
4616 struct lttng_ht_iter iter
;
4617 struct ust_app_channel
*ua_chan
= NULL
;
4621 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4622 node
= lttng_ht_iter_get_node_ulong(&iter
);
4624 DBG2("UST app channel find by objd %d not found", objd
);
4628 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4635 * Reply to a register channel notification from an application on the notify
4636 * socket. The channel metadata is also created.
4638 * The session UST registry lock is acquired in this function.
4640 * On success 0 is returned else a negative value.
4642 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4643 size_t nr_fields
, struct ustctl_field
*fields
)
4645 int ret
, ret_code
= 0;
4646 uint32_t chan_id
, reg_count
;
4647 uint64_t chan_reg_key
;
4648 enum ustctl_channel_header type
;
4649 struct ust_app
*app
;
4650 struct ust_app_channel
*ua_chan
;
4651 struct ust_app_session
*ua_sess
;
4652 struct ust_registry_session
*registry
;
4653 struct ust_registry_channel
*chan_reg
;
4657 /* Lookup application. If not found, there is a code flow error. */
4658 app
= find_app_by_notify_sock(sock
);
4660 DBG("Application socket %d is being teardown. Abort event notify",
4664 goto error_rcu_unlock
;
4667 /* Lookup channel by UST object descriptor. */
4668 ua_chan
= find_channel_by_objd(app
, cobjd
);
4670 DBG("Application channel is being teardown. Abort event notify");
4673 goto error_rcu_unlock
;
4676 assert(ua_chan
->session
);
4677 ua_sess
= ua_chan
->session
;
4679 /* Get right session registry depending on the session buffer type. */
4680 registry
= get_session_registry(ua_sess
);
4683 /* Depending on the buffer type, a different channel key is used. */
4684 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4685 chan_reg_key
= ua_chan
->tracing_channel_id
;
4687 chan_reg_key
= ua_chan
->key
;
4690 pthread_mutex_lock(®istry
->lock
);
4692 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4695 if (!chan_reg
->register_done
) {
4696 reg_count
= ust_registry_get_event_count(chan_reg
);
4697 if (reg_count
< 31) {
4698 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4700 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4703 chan_reg
->nr_ctx_fields
= nr_fields
;
4704 chan_reg
->ctx_fields
= fields
;
4705 chan_reg
->header_type
= type
;
4707 /* Get current already assigned values. */
4708 type
= chan_reg
->header_type
;
4710 /* Set to NULL so the error path does not do a double free. */
4713 /* Channel id is set during the object creation. */
4714 chan_id
= chan_reg
->chan_id
;
4716 /* Append to metadata */
4717 if (!chan_reg
->metadata_dumped
) {
4718 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4720 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4726 DBG3("UST app replying to register channel key %" PRIu64
4727 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4730 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4732 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4733 ERR("UST app reply channel failed with ret %d", ret
);
4735 DBG3("UST app reply channel failed. Application died");
4740 /* This channel registry registration is completed. */
4741 chan_reg
->register_done
= 1;
4744 pthread_mutex_unlock(®istry
->lock
);
4754 * Add event to the UST channel registry. When the event is added to the
4755 * registry, the metadata is also created. Once done, this replies to the
4756 * application with the appropriate error code.
4758 * The session UST registry lock is acquired in the function.
4760 * On success 0 is returned else a negative value.
4762 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4763 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4764 char *model_emf_uri
)
4767 uint32_t event_id
= 0;
4768 uint64_t chan_reg_key
;
4769 struct ust_app
*app
;
4770 struct ust_app_channel
*ua_chan
;
4771 struct ust_app_session
*ua_sess
;
4772 struct ust_registry_session
*registry
;
4776 /* Lookup application. If not found, there is a code flow error. */
4777 app
= find_app_by_notify_sock(sock
);
4779 DBG("Application socket %d is being teardown. Abort event notify",
4784 free(model_emf_uri
);
4785 goto error_rcu_unlock
;
4788 /* Lookup channel by UST object descriptor. */
4789 ua_chan
= find_channel_by_objd(app
, cobjd
);
4791 DBG("Application channel is being teardown. Abort event notify");
4795 free(model_emf_uri
);
4796 goto error_rcu_unlock
;
4799 assert(ua_chan
->session
);
4800 ua_sess
= ua_chan
->session
;
4802 registry
= get_session_registry(ua_sess
);
4805 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4806 chan_reg_key
= ua_chan
->tracing_channel_id
;
4808 chan_reg_key
= ua_chan
->key
;
4811 pthread_mutex_lock(®istry
->lock
);
4814 * From this point on, this call acquires the ownership of the sig, fields
4815 * and model_emf_uri meaning any free are done inside it if needed. These
4816 * three variables MUST NOT be read/write after this.
4818 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4819 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4820 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4824 * The return value is returned to ustctl so in case of an error, the
4825 * application can be notified. In case of an error, it's important not to
4826 * return a negative error or else the application will get closed.
4828 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4830 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4831 ERR("UST app reply event failed with ret %d", ret
);
4833 DBG3("UST app reply event failed. Application died");
4836 * No need to wipe the create event since the application socket will
4837 * get close on error hence cleaning up everything by itself.
4842 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4846 pthread_mutex_unlock(®istry
->lock
);
4853 * Handle application notification through the given notify socket.
4855 * Return 0 on success or else a negative value.
4857 int ust_app_recv_notify(int sock
)
4860 enum ustctl_notify_cmd cmd
;
4862 DBG3("UST app receiving notify from sock %d", sock
);
4864 ret
= ustctl_recv_notify(sock
, &cmd
);
4866 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4867 ERR("UST app recv notify failed with ret %d", ret
);
4869 DBG3("UST app recv notify failed. Application died");
4875 case USTCTL_NOTIFY_CMD_EVENT
:
4877 int sobjd
, cobjd
, loglevel
;
4878 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4880 struct ustctl_field
*fields
;
4882 DBG2("UST app ustctl register event received");
4884 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4885 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4887 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4888 ERR("UST app recv event failed with ret %d", ret
);
4890 DBG3("UST app recv event failed. Application died");
4896 * Add event to the UST registry coming from the notify socket. This
4897 * call will free if needed the sig, fields and model_emf_uri. This
4898 * code path loses the ownsership of these variables and transfer them
4899 * to the this function.
4901 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4902 fields
, loglevel
, model_emf_uri
);
4909 case USTCTL_NOTIFY_CMD_CHANNEL
:
4913 struct ustctl_field
*fields
;
4915 DBG2("UST app ustctl register channel received");
4917 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4920 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4921 ERR("UST app recv channel failed with ret %d", ret
);
4923 DBG3("UST app recv channel failed. Application died");
4929 * The fields ownership are transfered to this function call meaning
4930 * that if needed it will be freed. After this, it's invalid to access
4931 * fields or clean it up.
4933 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4942 /* Should NEVER happen. */
4951 * Once the notify socket hangs up, this is called. First, it tries to find the
4952 * corresponding application. On failure, the call_rcu to close the socket is
4953 * executed. If an application is found, it tries to delete it from the notify
4954 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4956 * Note that an object needs to be allocated here so on ENOMEM failure, the
4957 * call RCU is not done but the rest of the cleanup is.
4959 void ust_app_notify_sock_unregister(int sock
)
4962 struct lttng_ht_iter iter
;
4963 struct ust_app
*app
;
4964 struct ust_app_notify_sock_obj
*obj
;
4970 obj
= zmalloc(sizeof(*obj
));
4973 * An ENOMEM is kind of uncool. If this strikes we continue the
4974 * procedure but the call_rcu will not be called. In this case, we
4975 * accept the fd leak rather than possibly creating an unsynchronized
4976 * state between threads.
4978 * TODO: The notify object should be created once the notify socket is
4979 * registered and stored independantely from the ust app object. The
4980 * tricky part is to synchronize the teardown of the application and
4981 * this notify object. Let's keep that in mind so we can avoid this
4982 * kind of shenanigans with ENOMEM in the teardown path.
4989 DBG("UST app notify socket unregister %d", sock
);
4992 * Lookup application by notify socket. If this fails, this means that the
4993 * hash table delete has already been done by the application
4994 * unregistration process so we can safely close the notify socket in a
4997 app
= find_app_by_notify_sock(sock
);
5002 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5005 * Whatever happens here either we fail or succeed, in both cases we have
5006 * to close the socket after a grace period to continue to the call RCU
5007 * here. If the deletion is successful, the application is not visible
5008 * anymore by other threads and is it fails it means that it was already
5009 * deleted from the hash table so either way we just have to close the
5012 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5018 * Close socket after a grace period to avoid for the socket to be reused
5019 * before the application object is freed creating potential race between
5020 * threads trying to add unique in the global hash table.
5023 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5028 * Destroy a ust app data structure and free its memory.
5030 void ust_app_destroy(struct ust_app
*app
)
5036 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5040 * Take a snapshot for a given UST session. The snapshot is sent to the given
5043 * Return 0 on success or else a negative value.
5045 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5046 struct snapshot_output
*output
, int wait
, uint64_t max_stream_size
)
5049 unsigned int snapshot_done
= 0;
5050 struct lttng_ht_iter iter
;
5051 struct ust_app
*app
;
5052 char pathname
[PATH_MAX
];
5059 switch (usess
->buffer_type
) {
5060 case LTTNG_BUFFER_PER_UID
:
5062 struct buffer_reg_uid
*reg
;
5064 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5065 struct buffer_reg_channel
*reg_chan
;
5066 struct consumer_socket
*socket
;
5068 /* Get consumer socket to use to push the metadata.*/
5069 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5076 memset(pathname
, 0, sizeof(pathname
));
5077 ret
= snprintf(pathname
, sizeof(pathname
),
5078 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5079 reg
->uid
, reg
->bits_per_long
);
5081 PERROR("snprintf snapshot path");
5085 /* Add the UST default trace dir to path. */
5086 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5087 reg_chan
, node
.node
) {
5088 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5089 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5095 ret
= consumer_snapshot_channel(socket
,
5096 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5097 usess
->uid
, usess
->gid
, pathname
, wait
, max_stream_size
);
5105 case LTTNG_BUFFER_PER_PID
:
5107 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5108 struct consumer_socket
*socket
;
5109 struct lttng_ht_iter chan_iter
;
5110 struct ust_app_channel
*ua_chan
;
5111 struct ust_app_session
*ua_sess
;
5112 struct ust_registry_session
*registry
;
5114 ua_sess
= lookup_session_by_app(usess
, app
);
5116 /* Session not associated with this app. */
5120 /* Get the right consumer socket for the application. */
5121 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5128 /* Add the UST default trace dir to path. */
5129 memset(pathname
, 0, sizeof(pathname
));
5130 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5133 PERROR("snprintf snapshot path");
5137 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5138 ua_chan
, node
.node
) {
5139 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5140 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5147 registry
= get_session_registry(ua_sess
);
5149 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5150 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5164 if (!snapshot_done
) {
5166 * If no snapshot was made and we are not in the error path, this means
5167 * that there are no buffers thus no (prior) application to snapshot
5168 * data from so we have simply NO data.
5179 * Return the number of streams for a UST session.
5181 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5183 unsigned int ret
= 0;
5184 struct ust_app
*app
;
5185 struct lttng_ht_iter iter
;
5189 switch (usess
->buffer_type
) {
5190 case LTTNG_BUFFER_PER_UID
:
5192 struct buffer_reg_uid
*reg
;
5194 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5195 struct buffer_reg_channel
*reg_chan
;
5198 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5199 reg_chan
, node
.node
) {
5200 ret
+= reg_chan
->stream_count
;
5206 case LTTNG_BUFFER_PER_PID
:
5209 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5210 struct ust_app_channel
*ua_chan
;
5211 struct ust_app_session
*ua_sess
;
5212 struct lttng_ht_iter chan_iter
;
5214 ua_sess
= lookup_session_by_app(usess
, app
);
5216 /* Session not associated with this app. */
5220 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5221 ua_chan
, node
.node
) {
5222 ret
+= ua_chan
->streams
.count
;