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_unique_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 * Create a context for the channel on the tracer.
1957 * Called with UST app session lock held and a RCU read side lock.
1960 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1961 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1962 struct ust_app
*app
)
1965 struct lttng_ht_iter iter
;
1966 struct lttng_ht_node_ulong
*node
;
1967 struct ust_app_ctx
*ua_ctx
;
1969 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1971 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1972 node
= lttng_ht_iter_get_node_ulong(&iter
);
1978 ua_ctx
= alloc_ust_app_ctx(uctx
);
1979 if (ua_ctx
== NULL
) {
1985 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1986 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1987 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1989 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1999 * Enable on the tracer side a ust app event for the session and channel.
2001 * Called with UST app session lock held.
2004 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2005 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2009 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2014 ua_event
->enabled
= 1;
2021 * Disable on the tracer side a ust app event for the session and channel.
2023 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2024 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2028 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2033 ua_event
->enabled
= 0;
2040 * Lookup ust app channel for session and disable it on the tracer side.
2043 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2044 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2048 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2053 ua_chan
->enabled
= 0;
2060 * Lookup ust app channel for session and enable it on the tracer side. This
2061 * MUST be called with a RCU read side lock acquired.
2063 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2064 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2067 struct lttng_ht_iter iter
;
2068 struct lttng_ht_node_str
*ua_chan_node
;
2069 struct ust_app_channel
*ua_chan
;
2071 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2072 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2073 if (ua_chan_node
== NULL
) {
2074 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2075 uchan
->name
, ua_sess
->tracing_id
);
2079 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2081 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2091 * Ask the consumer to create a channel and get it if successful.
2093 * Return 0 on success or else a negative value.
2095 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2096 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2097 int bitness
, struct ust_registry_session
*registry
)
2100 unsigned int nb_fd
= 0;
2101 struct consumer_socket
*socket
;
2109 health_code_update();
2111 /* Get the right consumer socket for the application. */
2112 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2118 health_code_update();
2120 /* Need one fd for the channel. */
2121 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2123 ERR("Exhausted number of available FD upon create channel");
2128 * Ask consumer to create channel. The consumer will return the number of
2129 * stream we have to expect.
2131 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2138 * Compute the number of fd needed before receiving them. It must be 2 per
2139 * stream (2 being the default value here).
2141 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2143 /* Reserve the amount of file descriptor we need. */
2144 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2146 ERR("Exhausted number of available FD upon create channel");
2147 goto error_fd_get_stream
;
2150 health_code_update();
2153 * Now get the channel from the consumer. This call wil populate the stream
2154 * list of that channel and set the ust objects.
2156 if (usess
->consumer
->enabled
) {
2157 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2167 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2168 error_fd_get_stream
:
2170 * Initiate a destroy channel on the consumer since we had an error
2171 * handling it on our side. The return value is of no importance since we
2172 * already have a ret value set by the previous error that we need to
2175 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2177 lttng_fd_put(LTTNG_FD_APPS
, 1);
2179 health_code_update();
2185 * Duplicate the ust data object of the ust app stream and save it in the
2186 * buffer registry stream.
2188 * Return 0 on success or else a negative value.
2190 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2191 struct ust_app_stream
*stream
)
2198 /* Reserve the amount of file descriptor we need. */
2199 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2201 ERR("Exhausted number of available FD upon duplicate stream");
2205 /* Duplicate object for stream once the original is in the registry. */
2206 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2207 reg_stream
->obj
.ust
);
2209 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2210 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2211 lttng_fd_put(LTTNG_FD_APPS
, 2);
2214 stream
->handle
= stream
->obj
->handle
;
2221 * Duplicate the ust data object of the ust app. channel and save it in the
2222 * buffer registry channel.
2224 * Return 0 on success or else a negative value.
2226 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2227 struct ust_app_channel
*ua_chan
)
2234 /* Need two fds for the channel. */
2235 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2237 ERR("Exhausted number of available FD upon duplicate channel");
2241 /* Duplicate object for stream once the original is in the registry. */
2242 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2244 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2245 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2248 ua_chan
->handle
= ua_chan
->obj
->handle
;
2253 lttng_fd_put(LTTNG_FD_APPS
, 1);
2259 * For a given channel buffer registry, setup all streams of the given ust
2260 * application channel.
2262 * Return 0 on success or else a negative value.
2264 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2265 struct ust_app_channel
*ua_chan
)
2268 struct ust_app_stream
*stream
, *stmp
;
2273 DBG2("UST app setup buffer registry stream");
2275 /* Send all streams to application. */
2276 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2277 struct buffer_reg_stream
*reg_stream
;
2279 ret
= buffer_reg_stream_create(®_stream
);
2285 * Keep original pointer and nullify it in the stream so the delete
2286 * stream call does not release the object.
2288 reg_stream
->obj
.ust
= stream
->obj
;
2290 buffer_reg_stream_add(reg_stream
, reg_chan
);
2292 /* We don't need the streams anymore. */
2293 cds_list_del(&stream
->list
);
2294 delete_ust_app_stream(-1, stream
);
2302 * Create a buffer registry channel for the given session registry and
2303 * application channel object. If regp pointer is valid, it's set with the
2304 * created object. Important, the created object is NOT added to the session
2305 * registry hash table.
2307 * Return 0 on success else a negative value.
2309 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2310 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2313 struct buffer_reg_channel
*reg_chan
= NULL
;
2318 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2320 /* Create buffer registry channel. */
2321 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2326 reg_chan
->consumer_key
= ua_chan
->key
;
2327 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2329 /* Create and add a channel registry to session. */
2330 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2331 ua_chan
->tracing_channel_id
);
2335 buffer_reg_channel_add(reg_sess
, reg_chan
);
2344 /* Safe because the registry channel object was not added to any HT. */
2345 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2351 * Setup buffer registry channel for the given session registry and application
2352 * channel object. If regp pointer is valid, it's set with the created object.
2354 * Return 0 on success else a negative value.
2356 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2357 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2364 assert(ua_chan
->obj
);
2366 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2368 /* Setup all streams for the registry. */
2369 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2374 reg_chan
->obj
.ust
= ua_chan
->obj
;
2375 ua_chan
->obj
= NULL
;
2380 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2381 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2386 * Send buffer registry channel to the application.
2388 * Return 0 on success else a negative value.
2390 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2391 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2392 struct ust_app_channel
*ua_chan
)
2395 struct buffer_reg_stream
*reg_stream
;
2402 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2404 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2409 /* Send channel to the application. */
2410 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2415 health_code_update();
2417 /* Send all streams to application. */
2418 pthread_mutex_lock(®_chan
->stream_list_lock
);
2419 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2420 struct ust_app_stream stream
;
2422 ret
= duplicate_stream_object(reg_stream
, &stream
);
2424 goto error_stream_unlock
;
2427 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2429 (void) release_ust_app_stream(-1, &stream
);
2430 goto error_stream_unlock
;
2434 * The return value is not important here. This function will output an
2437 (void) release_ust_app_stream(-1, &stream
);
2439 ua_chan
->is_sent
= 1;
2441 error_stream_unlock
:
2442 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2448 * Create and send to the application the created buffers with per UID buffers.
2450 * Return 0 on success else a negative value.
2452 static int create_channel_per_uid(struct ust_app
*app
,
2453 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2454 struct ust_app_channel
*ua_chan
)
2457 struct buffer_reg_uid
*reg_uid
;
2458 struct buffer_reg_channel
*reg_chan
;
2465 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2467 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2469 * The session creation handles the creation of this global registry
2470 * object. If none can be find, there is a code flow problem or a
2475 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2478 /* Create the buffer registry channel object. */
2479 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2486 * Create the buffers on the consumer side. This call populates the
2487 * ust app channel object with all streams and data object.
2489 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2490 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2493 * Let's remove the previously created buffer registry channel so
2494 * it's not visible anymore in the session registry.
2496 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2497 ua_chan
->tracing_channel_id
);
2498 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2499 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2504 * Setup the streams and add it to the session registry.
2506 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2513 /* Send buffers to the application. */
2514 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2524 * Create and send to the application the created buffers with per PID buffers.
2526 * Return 0 on success else a negative value.
2528 static int create_channel_per_pid(struct ust_app
*app
,
2529 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2530 struct ust_app_channel
*ua_chan
)
2533 struct ust_registry_session
*registry
;
2540 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2544 registry
= get_session_registry(ua_sess
);
2547 /* Create and add a new channel registry to session. */
2548 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2553 /* Create and get channel on the consumer side. */
2554 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2555 app
->bits_per_long
, registry
);
2560 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2571 * From an already allocated ust app channel, create the channel buffers if
2572 * need and send it to the application. This MUST be called with a RCU read
2573 * side lock acquired.
2575 * Return 0 on success or else a negative value.
2577 static int do_create_channel(struct ust_app
*app
,
2578 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2579 struct ust_app_channel
*ua_chan
)
2588 /* Handle buffer type before sending the channel to the application. */
2589 switch (usess
->buffer_type
) {
2590 case LTTNG_BUFFER_PER_UID
:
2592 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2598 case LTTNG_BUFFER_PER_PID
:
2600 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2612 /* Initialize ust objd object using the received handle and add it. */
2613 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2614 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2616 /* If channel is not enabled, disable it on the tracer */
2617 if (!ua_chan
->enabled
) {
2618 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2629 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2630 * newly created channel if not NULL.
2632 * Called with UST app session lock and RCU read-side lock held.
2634 * Return 0 on success or else a negative value.
2636 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2637 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2638 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2639 struct ust_app_channel
**ua_chanp
)
2642 struct lttng_ht_iter iter
;
2643 struct lttng_ht_node_str
*ua_chan_node
;
2644 struct ust_app_channel
*ua_chan
;
2646 /* Lookup channel in the ust app session */
2647 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2648 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2649 if (ua_chan_node
!= NULL
) {
2650 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2654 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2655 if (ua_chan
== NULL
) {
2656 /* Only malloc can fail here */
2660 shadow_copy_channel(ua_chan
, uchan
);
2662 /* Set channel type. */
2663 ua_chan
->attr
.type
= type
;
2665 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2670 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2673 /* Only add the channel if successful on the tracer side. */
2674 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2678 *ua_chanp
= ua_chan
;
2681 /* Everything went well. */
2685 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2691 * Create UST app event and create it on the tracer side.
2693 * Called with ust app session mutex held.
2696 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2697 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2698 struct ust_app
*app
)
2701 struct ust_app_event
*ua_event
;
2703 /* Get event node */
2704 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2705 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2706 if (ua_event
!= NULL
) {
2711 /* Does not exist so create one */
2712 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2713 if (ua_event
== NULL
) {
2714 /* Only malloc can failed so something is really wrong */
2718 shadow_copy_event(ua_event
, uevent
);
2720 /* Create it on the tracer side */
2721 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2723 /* Not found previously means that it does not exist on the tracer */
2724 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2728 add_unique_ust_app_event(ua_chan
, ua_event
);
2730 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2737 /* Valid. Calling here is already in a read side lock */
2738 delete_ust_app_event(-1, ua_event
);
2743 * Create UST metadata and open it on the tracer side.
2745 * Called with UST app session lock held and RCU read side lock.
2747 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2748 struct ust_app
*app
, struct consumer_output
*consumer
)
2751 struct ust_app_channel
*metadata
;
2752 struct consumer_socket
*socket
;
2753 struct ust_registry_session
*registry
;
2759 registry
= get_session_registry(ua_sess
);
2762 /* Metadata already exists for this registry or it was closed previously */
2763 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2768 /* Allocate UST metadata */
2769 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2771 /* malloc() failed */
2776 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2778 /* Need one fd for the channel. */
2779 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2781 ERR("Exhausted number of available FD upon create metadata");
2785 /* Get the right consumer socket for the application. */
2786 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2789 goto error_consumer
;
2793 * Keep metadata key so we can identify it on the consumer side. Assign it
2794 * to the registry *before* we ask the consumer so we avoid the race of the
2795 * consumer requesting the metadata and the ask_channel call on our side
2796 * did not returned yet.
2798 registry
->metadata_key
= metadata
->key
;
2801 * Ask the metadata channel creation to the consumer. The metadata object
2802 * will be created by the consumer and kept their. However, the stream is
2803 * never added or monitored until we do a first push metadata to the
2806 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2809 /* Nullify the metadata key so we don't try to close it later on. */
2810 registry
->metadata_key
= 0;
2811 goto error_consumer
;
2815 * The setup command will make the metadata stream be sent to the relayd,
2816 * if applicable, and the thread managing the metadatas. This is important
2817 * because after this point, if an error occurs, the only way the stream
2818 * can be deleted is to be monitored in the consumer.
2820 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2822 /* Nullify the metadata key so we don't try to close it later on. */
2823 registry
->metadata_key
= 0;
2824 goto error_consumer
;
2827 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2828 metadata
->key
, app
->pid
);
2831 lttng_fd_put(LTTNG_FD_APPS
, 1);
2832 delete_ust_app_channel(-1, metadata
, app
);
2838 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2839 * acquired before calling this function.
2841 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2843 struct ust_app
*app
= NULL
;
2844 struct lttng_ht_node_ulong
*node
;
2845 struct lttng_ht_iter iter
;
2847 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2848 node
= lttng_ht_iter_get_node_ulong(&iter
);
2850 DBG2("UST app no found with pid %d", pid
);
2854 DBG2("Found UST app by pid %d", pid
);
2856 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2863 * Allocate and init an UST app object using the registration information and
2864 * the command socket. This is called when the command socket connects to the
2867 * The object is returned on success or else NULL.
2869 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2871 struct ust_app
*lta
= NULL
;
2876 DBG3("UST app creating application for socket %d", sock
);
2878 if ((msg
->bits_per_long
== 64 &&
2879 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2880 || (msg
->bits_per_long
== 32 &&
2881 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2882 ERR("Registration failed: application \"%s\" (pid: %d) has "
2883 "%d-bit long, but no consumerd for this size is available.\n",
2884 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2888 lta
= zmalloc(sizeof(struct ust_app
));
2894 lta
->ppid
= msg
->ppid
;
2895 lta
->uid
= msg
->uid
;
2896 lta
->gid
= msg
->gid
;
2898 lta
->bits_per_long
= msg
->bits_per_long
;
2899 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2900 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2901 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2902 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2903 lta
->long_alignment
= msg
->long_alignment
;
2904 lta
->byte_order
= msg
->byte_order
;
2906 lta
->v_major
= msg
->major
;
2907 lta
->v_minor
= msg
->minor
;
2908 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2909 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2910 lta
->notify_sock
= -1;
2912 /* Copy name and make sure it's NULL terminated. */
2913 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2914 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2917 * Before this can be called, when receiving the registration information,
2918 * the application compatibility is checked. So, at this point, the
2919 * application can work with this session daemon.
2921 lta
->compatible
= 1;
2923 lta
->pid
= msg
->pid
;
2924 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2926 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2928 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2935 * For a given application object, add it to every hash table.
2937 void ust_app_add(struct ust_app
*app
)
2940 assert(app
->notify_sock
>= 0);
2945 * On a re-registration, we want to kick out the previous registration of
2948 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2951 * The socket _should_ be unique until _we_ call close. So, a add_unique
2952 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2953 * already in the table.
2955 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2957 /* Add application to the notify socket hash table. */
2958 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2959 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2961 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2962 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2963 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2970 * Set the application version into the object.
2972 * Return 0 on success else a negative value either an errno code or a
2973 * LTTng-UST error code.
2975 int ust_app_version(struct ust_app
*app
)
2981 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2983 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2984 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2986 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2994 * Unregister app by removing it from the global traceable app list and freeing
2997 * The socket is already closed at this point so no close to sock.
2999 void ust_app_unregister(int sock
)
3001 struct ust_app
*lta
;
3002 struct lttng_ht_node_ulong
*node
;
3003 struct lttng_ht_iter ust_app_sock_iter
;
3004 struct lttng_ht_iter iter
;
3005 struct ust_app_session
*ua_sess
;
3010 /* Get the node reference for a call_rcu */
3011 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3012 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3015 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3016 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3019 * Perform "push metadata" and flush all application streams
3020 * before removing app from hash tables, ensuring proper
3021 * behavior of data_pending check.
3022 * Remove sessions so they are not visible during deletion.
3024 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3026 struct ust_registry_session
*registry
;
3028 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3030 /* The session was already removed so scheduled for teardown. */
3034 (void) ust_app_flush_app_session(lta
, ua_sess
);
3037 * Add session to list for teardown. This is safe since at this point we
3038 * are the only one using this list.
3040 pthread_mutex_lock(&ua_sess
->lock
);
3043 * Normally, this is done in the delete session process which is
3044 * executed in the call rcu below. However, upon registration we can't
3045 * afford to wait for the grace period before pushing data or else the
3046 * data pending feature can race between the unregistration and stop
3047 * command where the data pending command is sent *before* the grace
3050 * The close metadata below nullifies the metadata pointer in the
3051 * session so the delete session will NOT push/close a second time.
3053 registry
= get_session_registry(ua_sess
);
3054 if (registry
&& !registry
->metadata_closed
) {
3055 /* Push metadata for application before freeing the application. */
3056 (void) push_metadata(registry
, ua_sess
->consumer
);
3059 * Don't ask to close metadata for global per UID buffers. Close
3060 * metadata only on destroy trace session in this case. Also, the
3061 * previous push metadata could have flag the metadata registry to
3062 * close so don't send a close command if closed.
3064 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3065 !registry
->metadata_closed
) {
3066 /* And ask to close it for this session registry. */
3067 (void) close_metadata(registry
, ua_sess
->consumer
);
3070 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3072 pthread_mutex_unlock(&ua_sess
->lock
);
3075 /* Remove application from PID hash table */
3076 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3080 * Remove application from notify hash table. The thread handling the
3081 * notify socket could have deleted the node so ignore on error because
3082 * either way it's valid. The close of that socket is handled by the other
3085 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3086 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3089 * Ignore return value since the node might have been removed before by an
3090 * add replace during app registration because the PID can be reassigned by
3093 iter
.iter
.node
= <a
->pid_n
.node
;
3094 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3096 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3101 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3108 * Fill events array with all events name of all registered apps.
3110 int ust_app_list_events(struct lttng_event
**events
)
3113 size_t nbmem
, count
= 0;
3114 struct lttng_ht_iter iter
;
3115 struct ust_app
*app
;
3116 struct lttng_event
*tmp_event
;
3118 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3119 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3120 if (tmp_event
== NULL
) {
3121 PERROR("zmalloc ust app events");
3128 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3129 struct lttng_ust_tracepoint_iter uiter
;
3131 health_code_update();
3133 if (!app
->compatible
) {
3135 * TODO: In time, we should notice the caller of this error by
3136 * telling him that this is a version error.
3140 handle
= ustctl_tracepoint_list(app
->sock
);
3142 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3143 ERR("UST app list events getting handle failed for app pid %d",
3149 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3150 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3151 /* Handle ustctl error. */
3153 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3154 ERR("UST app tp list get failed for app %d with ret %d",
3157 DBG3("UST app tp list get failed. Application is dead");
3159 * This is normal behavior, an application can die during the
3160 * creation process. Don't report an error so the execution can
3161 * continue normally. Continue normal execution.
3169 health_code_update();
3170 if (count
>= nbmem
) {
3171 /* In case the realloc fails, we free the memory */
3172 struct lttng_event
*new_tmp_event
;
3175 new_nbmem
= nbmem
<< 1;
3176 DBG2("Reallocating event list from %zu to %zu entries",
3178 new_tmp_event
= realloc(tmp_event
,
3179 new_nbmem
* sizeof(struct lttng_event
));
3180 if (new_tmp_event
== NULL
) {
3181 PERROR("realloc ust app events");
3186 /* Zero the new memory */
3187 memset(new_tmp_event
+ nbmem
, 0,
3188 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3190 tmp_event
= new_tmp_event
;
3192 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3193 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3194 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3195 tmp_event
[count
].pid
= app
->pid
;
3196 tmp_event
[count
].enabled
= -1;
3202 *events
= tmp_event
;
3204 DBG2("UST app list events done (%zu events)", count
);
3209 health_code_update();
3214 * Fill events array with all events name of all registered apps.
3216 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3219 size_t nbmem
, count
= 0;
3220 struct lttng_ht_iter iter
;
3221 struct ust_app
*app
;
3222 struct lttng_event_field
*tmp_event
;
3224 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3225 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3226 if (tmp_event
== NULL
) {
3227 PERROR("zmalloc ust app event fields");
3234 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3235 struct lttng_ust_field_iter uiter
;
3237 health_code_update();
3239 if (!app
->compatible
) {
3241 * TODO: In time, we should notice the caller of this error by
3242 * telling him that this is a version error.
3246 handle
= ustctl_tracepoint_field_list(app
->sock
);
3248 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3249 ERR("UST app list field getting handle failed for app pid %d",
3255 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3256 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3257 /* Handle ustctl error. */
3259 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3260 ERR("UST app tp list field failed for app %d with ret %d",
3263 DBG3("UST app tp list field failed. Application is dead");
3265 * This is normal behavior, an application can die during the
3266 * creation process. Don't report an error so the execution can
3267 * continue normally. Reset list and count for next app.
3275 health_code_update();
3276 if (count
>= nbmem
) {
3277 /* In case the realloc fails, we free the memory */
3278 struct lttng_event_field
*new_tmp_event
;
3281 new_nbmem
= nbmem
<< 1;
3282 DBG2("Reallocating event field list from %zu to %zu entries",
3284 new_tmp_event
= realloc(tmp_event
,
3285 new_nbmem
* sizeof(struct lttng_event_field
));
3286 if (new_tmp_event
== NULL
) {
3287 PERROR("realloc ust app event fields");
3292 /* Zero the new memory */
3293 memset(new_tmp_event
+ nbmem
, 0,
3294 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3296 tmp_event
= new_tmp_event
;
3299 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3300 /* Mapping between these enums matches 1 to 1. */
3301 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3302 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3304 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3305 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3306 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3307 tmp_event
[count
].event
.pid
= app
->pid
;
3308 tmp_event
[count
].event
.enabled
= -1;
3314 *fields
= tmp_event
;
3316 DBG2("UST app list event fields done (%zu events)", count
);
3321 health_code_update();
3326 * Free and clean all traceable apps of the global list.
3328 * Should _NOT_ be called with RCU read-side lock held.
3330 void ust_app_clean_list(void)
3333 struct ust_app
*app
;
3334 struct lttng_ht_iter iter
;
3336 DBG2("UST app cleaning registered apps hash table");
3340 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3341 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3343 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3346 /* Cleanup socket hash table */
3347 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3349 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3353 /* Cleanup notify socket hash table */
3354 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3355 notify_sock_n
.node
) {
3356 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3361 /* Destroy is done only when the ht is empty */
3362 ht_cleanup_push(ust_app_ht
);
3363 ht_cleanup_push(ust_app_ht_by_sock
);
3364 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3368 * Init UST app hash table.
3370 void ust_app_ht_alloc(void)
3372 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3373 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3374 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3378 * For a specific UST session, disable the channel for all registered apps.
3380 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3381 struct ltt_ust_channel
*uchan
)
3384 struct lttng_ht_iter iter
;
3385 struct lttng_ht_node_str
*ua_chan_node
;
3386 struct ust_app
*app
;
3387 struct ust_app_session
*ua_sess
;
3388 struct ust_app_channel
*ua_chan
;
3390 if (usess
== NULL
|| uchan
== NULL
) {
3391 ERR("Disabling UST global channel with NULL values");
3396 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3397 uchan
->name
, usess
->id
);
3401 /* For every registered applications */
3402 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3403 struct lttng_ht_iter uiter
;
3404 if (!app
->compatible
) {
3406 * TODO: In time, we should notice the caller of this error by
3407 * telling him that this is a version error.
3411 ua_sess
= lookup_session_by_app(usess
, app
);
3412 if (ua_sess
== NULL
) {
3417 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3418 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3419 /* If the session if found for the app, the channel must be there */
3420 assert(ua_chan_node
);
3422 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3423 /* The channel must not be already disabled */
3424 assert(ua_chan
->enabled
== 1);
3426 /* Disable channel onto application */
3427 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3429 /* XXX: We might want to report this error at some point... */
3441 * For a specific UST session, enable the channel for all registered apps.
3443 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3444 struct ltt_ust_channel
*uchan
)
3447 struct lttng_ht_iter iter
;
3448 struct ust_app
*app
;
3449 struct ust_app_session
*ua_sess
;
3451 if (usess
== NULL
|| uchan
== NULL
) {
3452 ERR("Adding UST global channel to NULL values");
3457 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3458 uchan
->name
, usess
->id
);
3462 /* For every registered applications */
3463 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3464 if (!app
->compatible
) {
3466 * TODO: In time, we should notice the caller of this error by
3467 * telling him that this is a version error.
3471 ua_sess
= lookup_session_by_app(usess
, app
);
3472 if (ua_sess
== NULL
) {
3476 /* Enable channel onto application */
3477 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3479 /* XXX: We might want to report this error at some point... */
3491 * Disable an event in a channel and for a specific session.
3493 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3494 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3497 struct lttng_ht_iter iter
, uiter
;
3498 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3499 struct ust_app
*app
;
3500 struct ust_app_session
*ua_sess
;
3501 struct ust_app_channel
*ua_chan
;
3502 struct ust_app_event
*ua_event
;
3504 DBG("UST app disabling event %s for all apps in channel "
3505 "%s for session id %" PRIu64
,
3506 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3510 /* For all registered applications */
3511 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3512 if (!app
->compatible
) {
3514 * TODO: In time, we should notice the caller of this error by
3515 * telling him that this is a version error.
3519 ua_sess
= lookup_session_by_app(usess
, app
);
3520 if (ua_sess
== NULL
) {
3525 /* Lookup channel in the ust app session */
3526 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3527 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3528 if (ua_chan_node
== NULL
) {
3529 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3530 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3533 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3535 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3536 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3537 if (ua_event_node
== NULL
) {
3538 DBG2("Event %s not found in channel %s for app pid %d."
3539 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3542 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3544 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3546 /* XXX: Report error someday... */
3557 * For a specific UST session, create the channel for all registered apps.
3559 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3560 struct ltt_ust_channel
*uchan
)
3562 int ret
= 0, created
;
3563 struct lttng_ht_iter iter
;
3564 struct ust_app
*app
;
3565 struct ust_app_session
*ua_sess
= NULL
;
3567 /* Very wrong code flow */
3571 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3572 uchan
->name
, usess
->id
);
3576 /* For every registered applications */
3577 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3578 if (!app
->compatible
) {
3580 * TODO: In time, we should notice the caller of this error by
3581 * telling him that this is a version error.
3586 * Create session on the tracer side and add it to app session HT. Note
3587 * that if session exist, it will simply return a pointer to the ust
3590 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3595 * The application's socket is not valid. Either a bad socket
3596 * or a timeout on it. We can't inform the caller that for a
3597 * specific app, the session failed so lets continue here.
3602 goto error_rcu_unlock
;
3607 pthread_mutex_lock(&ua_sess
->lock
);
3608 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3609 sizeof(uchan
->name
))) {
3610 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3613 /* Create channel onto application. We don't need the chan ref. */
3614 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3615 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3617 pthread_mutex_unlock(&ua_sess
->lock
);
3619 if (ret
== -ENOMEM
) {
3620 /* No more memory is a fatal error. Stop right now. */
3621 goto error_rcu_unlock
;
3623 /* Cleanup the created session if it's the case. */
3625 destroy_app_session(app
, ua_sess
);
3636 * Enable event for a specific session and channel on the tracer.
3638 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3639 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3642 struct lttng_ht_iter iter
, uiter
;
3643 struct lttng_ht_node_str
*ua_chan_node
;
3644 struct ust_app
*app
;
3645 struct ust_app_session
*ua_sess
;
3646 struct ust_app_channel
*ua_chan
;
3647 struct ust_app_event
*ua_event
;
3649 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3650 uevent
->attr
.name
, usess
->id
);
3653 * NOTE: At this point, this function is called only if the session and
3654 * channel passed are already created for all apps. and enabled on the
3660 /* For all registered applications */
3661 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3662 if (!app
->compatible
) {
3664 * TODO: In time, we should notice the caller of this error by
3665 * telling him that this is a version error.
3669 ua_sess
= lookup_session_by_app(usess
, app
);
3671 /* The application has problem or is probably dead. */
3675 pthread_mutex_lock(&ua_sess
->lock
);
3677 /* Lookup channel in the ust app session */
3678 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3679 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3680 /* If the channel is not found, there is a code flow error */
3681 assert(ua_chan_node
);
3683 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3685 /* Get event node */
3686 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3687 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3688 if (ua_event
== NULL
) {
3689 DBG3("UST app enable event %s not found for app PID %d."
3690 "Skipping app", uevent
->attr
.name
, app
->pid
);
3694 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3696 pthread_mutex_unlock(&ua_sess
->lock
);
3700 pthread_mutex_unlock(&ua_sess
->lock
);
3709 * For a specific existing UST session and UST channel, creates the event for
3710 * all registered apps.
3712 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3713 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3716 struct lttng_ht_iter iter
, uiter
;
3717 struct lttng_ht_node_str
*ua_chan_node
;
3718 struct ust_app
*app
;
3719 struct ust_app_session
*ua_sess
;
3720 struct ust_app_channel
*ua_chan
;
3722 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3723 uevent
->attr
.name
, usess
->id
);
3727 /* For all registered applications */
3728 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3729 if (!app
->compatible
) {
3731 * TODO: In time, we should notice the caller of this error by
3732 * telling him that this is a version error.
3736 ua_sess
= lookup_session_by_app(usess
, app
);
3738 /* The application has problem or is probably dead. */
3742 pthread_mutex_lock(&ua_sess
->lock
);
3743 /* Lookup channel in the ust app session */
3744 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3745 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3746 /* If the channel is not found, there is a code flow error */
3747 assert(ua_chan_node
);
3749 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3751 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3752 pthread_mutex_unlock(&ua_sess
->lock
);
3754 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3755 /* Possible value at this point: -ENOMEM. If so, we stop! */
3758 DBG2("UST app event %s already exist on app PID %d",
3759 uevent
->attr
.name
, app
->pid
);
3770 * Start tracing for a specific UST session and app.
3773 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3776 struct ust_app_session
*ua_sess
;
3778 DBG("Starting tracing for ust app pid %d", app
->pid
);
3782 if (!app
->compatible
) {
3786 ua_sess
= lookup_session_by_app(usess
, app
);
3787 if (ua_sess
== NULL
) {
3788 /* The session is in teardown process. Ignore and continue. */
3792 pthread_mutex_lock(&ua_sess
->lock
);
3794 /* Upon restart, we skip the setup, already done */
3795 if (ua_sess
->started
) {
3799 /* Create directories if consumer is LOCAL and has a path defined. */
3800 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3801 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3802 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3803 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3805 if (ret
!= -EEXIST
) {
3806 ERR("Trace directory creation error");
3813 * Create the metadata for the application. This returns gracefully if a
3814 * metadata was already set for the session.
3816 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3821 health_code_update();
3824 /* This start the UST tracing */
3825 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3827 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3828 ERR("Error starting tracing for app pid: %d (ret: %d)",
3831 DBG("UST app start session failed. Application is dead.");
3833 * This is normal behavior, an application can die during the
3834 * creation process. Don't report an error so the execution can
3835 * continue normally.
3837 pthread_mutex_unlock(&ua_sess
->lock
);
3843 /* Indicate that the session has been started once */
3844 ua_sess
->started
= 1;
3846 pthread_mutex_unlock(&ua_sess
->lock
);
3848 health_code_update();
3850 /* Quiescent wait after starting trace */
3851 ret
= ustctl_wait_quiescent(app
->sock
);
3852 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3853 ERR("UST app wait quiescent failed for app pid %d ret %d",
3859 health_code_update();
3863 pthread_mutex_unlock(&ua_sess
->lock
);
3865 health_code_update();
3870 * Stop tracing for a specific UST session and app.
3873 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3876 struct ust_app_session
*ua_sess
;
3877 struct ust_registry_session
*registry
;
3879 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3883 if (!app
->compatible
) {
3884 goto end_no_session
;
3887 ua_sess
= lookup_session_by_app(usess
, app
);
3888 if (ua_sess
== NULL
) {
3889 goto end_no_session
;
3892 pthread_mutex_lock(&ua_sess
->lock
);
3895 * If started = 0, it means that stop trace has been called for a session
3896 * that was never started. It's possible since we can have a fail start
3897 * from either the application manager thread or the command thread. Simply
3898 * indicate that this is a stop error.
3900 if (!ua_sess
->started
) {
3901 goto error_rcu_unlock
;
3904 health_code_update();
3906 /* This inhibits UST tracing */
3907 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3909 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3910 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3913 DBG("UST app stop session failed. Application is dead.");
3915 * This is normal behavior, an application can die during the
3916 * creation process. Don't report an error so the execution can
3917 * continue normally.
3921 goto error_rcu_unlock
;
3924 health_code_update();
3926 /* Quiescent wait after stopping trace */
3927 ret
= ustctl_wait_quiescent(app
->sock
);
3928 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3929 ERR("UST app wait quiescent failed for app pid %d ret %d",
3933 health_code_update();
3935 registry
= get_session_registry(ua_sess
);
3938 if (!registry
->metadata_closed
) {
3939 /* Push metadata for application before freeing the application. */
3940 (void) push_metadata(registry
, ua_sess
->consumer
);
3944 pthread_mutex_unlock(&ua_sess
->lock
);
3947 health_code_update();
3951 pthread_mutex_unlock(&ua_sess
->lock
);
3953 health_code_update();
3958 int ust_app_flush_app_session(struct ust_app
*app
,
3959 struct ust_app_session
*ua_sess
)
3961 int ret
, retval
= 0;
3962 struct lttng_ht_iter iter
;
3963 struct ust_app_channel
*ua_chan
;
3964 struct consumer_socket
*socket
;
3966 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
3970 if (!app
->compatible
) {
3971 goto end_not_compatible
;
3974 pthread_mutex_lock(&ua_sess
->lock
);
3976 health_code_update();
3978 /* Flushing buffers */
3979 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
3981 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3983 health_code_update();
3984 assert(ua_chan
->is_sent
);
3985 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
3987 ERR("Error flushing consumer channel");
3993 health_code_update();
3995 pthread_mutex_unlock(&ua_sess
->lock
);
3998 health_code_update();
4003 * Flush buffers for a specific UST session and app.
4006 int ust_app_flush_session(struct ust_app
*app
, struct ltt_ust_session
*usess
)
4010 struct ust_app_session
*ua_sess
;
4012 DBG("Flushing session buffers for ust app pid %d", app
->pid
);
4016 ua_sess
= lookup_session_by_app(usess
, app
);
4017 if (ua_sess
== NULL
) {
4019 goto end_no_session
;
4021 ret
= ust_app_flush_app_session(app
, ua_sess
);
4025 health_code_update();
4030 * Destroy a specific UST session in apps.
4032 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4035 struct ust_app_session
*ua_sess
;
4036 struct lttng_ht_iter iter
;
4037 struct lttng_ht_node_u64
*node
;
4039 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4043 if (!app
->compatible
) {
4047 __lookup_session_by_app(usess
, app
, &iter
);
4048 node
= lttng_ht_iter_get_node_u64(&iter
);
4050 /* Session is being or is deleted. */
4053 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4055 health_code_update();
4056 destroy_app_session(app
, ua_sess
);
4058 health_code_update();
4060 /* Quiescent wait after stopping trace */
4061 ret
= ustctl_wait_quiescent(app
->sock
);
4062 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4063 ERR("UST app wait quiescent failed for app pid %d ret %d",
4068 health_code_update();
4073 * Start tracing for the UST session.
4075 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4078 struct lttng_ht_iter iter
;
4079 struct ust_app
*app
;
4081 DBG("Starting all UST traces");
4085 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4086 ret
= ust_app_start_trace(usess
, app
);
4088 /* Continue to next apps even on error */
4099 * Start tracing for the UST session.
4101 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4104 struct lttng_ht_iter iter
;
4105 struct ust_app
*app
;
4107 DBG("Stopping all UST traces");
4111 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4112 ret
= ust_app_stop_trace(usess
, app
);
4114 /* Continue to next apps even on error */
4119 /* Flush buffers and push metadata (for UID buffers). */
4120 switch (usess
->buffer_type
) {
4121 case LTTNG_BUFFER_PER_UID
:
4123 struct buffer_reg_uid
*reg
;
4125 /* Flush all per UID buffers associated to that session. */
4126 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4127 struct ust_registry_session
*ust_session_reg
;
4128 struct buffer_reg_channel
*reg_chan
;
4129 struct consumer_socket
*socket
;
4131 /* Get consumer socket to use to push the metadata.*/
4132 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4135 /* Ignore request if no consumer is found for the session. */
4139 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4140 reg_chan
, node
.node
) {
4142 * The following call will print error values so the return
4143 * code is of little importance because whatever happens, we
4144 * have to try them all.
4146 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4149 ust_session_reg
= reg
->registry
->reg
.ust
;
4150 if (!ust_session_reg
->metadata_closed
) {
4151 /* Push metadata. */
4152 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4158 case LTTNG_BUFFER_PER_PID
:
4159 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4160 ret
= ust_app_flush_session(app
, usess
);
4162 /* Continue to next apps even on error */
4178 * Destroy app UST session.
4180 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4183 struct lttng_ht_iter iter
;
4184 struct ust_app
*app
;
4186 DBG("Destroy all UST traces");
4190 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4191 ret
= destroy_trace(usess
, app
);
4193 /* Continue to next apps even on error */
4204 * Add channels/events from UST global domain to registered apps at sock.
4206 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4209 struct lttng_ht_iter iter
, uiter
;
4210 struct ust_app
*app
;
4211 struct ust_app_session
*ua_sess
= NULL
;
4212 struct ust_app_channel
*ua_chan
;
4213 struct ust_app_event
*ua_event
;
4214 struct ust_app_ctx
*ua_ctx
;
4219 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4224 app
= ust_app_find_by_sock(sock
);
4227 * Application can be unregistered before so this is possible hence
4228 * simply stopping the update.
4230 DBG3("UST app update failed to find app sock %d", sock
);
4234 if (!app
->compatible
) {
4238 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4240 /* Tracer is probably gone or ENOMEM. */
4245 pthread_mutex_lock(&ua_sess
->lock
);
4248 * We can iterate safely here over all UST app session since the create ust
4249 * app session above made a shadow copy of the UST global domain from the
4252 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4254 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4257 * Stop everything. On error, the application failed, no more
4258 * file descriptor are available or ENOMEM so stopping here is
4259 * the only thing we can do for now.
4265 * Add context using the list so they are enabled in the same order the
4268 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4269 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4276 /* For each events */
4277 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4279 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4286 pthread_mutex_unlock(&ua_sess
->lock
);
4288 if (usess
->start_trace
) {
4289 ret
= ust_app_start_trace(usess
, app
);
4294 DBG2("UST trace started for app pid %d", app
->pid
);
4297 /* Everything went well at this point. */
4302 pthread_mutex_unlock(&ua_sess
->lock
);
4305 destroy_app_session(app
, ua_sess
);
4312 * Add context to a specific channel for global UST domain.
4314 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4315 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4318 struct lttng_ht_node_str
*ua_chan_node
;
4319 struct lttng_ht_iter iter
, uiter
;
4320 struct ust_app_channel
*ua_chan
= NULL
;
4321 struct ust_app_session
*ua_sess
;
4322 struct ust_app
*app
;
4326 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4327 if (!app
->compatible
) {
4329 * TODO: In time, we should notice the caller of this error by
4330 * telling him that this is a version error.
4334 ua_sess
= lookup_session_by_app(usess
, app
);
4335 if (ua_sess
== NULL
) {
4339 pthread_mutex_lock(&ua_sess
->lock
);
4340 /* Lookup channel in the ust app session */
4341 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4342 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4343 if (ua_chan_node
== NULL
) {
4346 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4348 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4353 pthread_mutex_unlock(&ua_sess
->lock
);
4361 * Enable event for a channel from a UST session for a specific PID.
4363 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4364 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4367 struct lttng_ht_iter iter
;
4368 struct lttng_ht_node_str
*ua_chan_node
;
4369 struct ust_app
*app
;
4370 struct ust_app_session
*ua_sess
;
4371 struct ust_app_channel
*ua_chan
;
4372 struct ust_app_event
*ua_event
;
4374 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4378 app
= ust_app_find_by_pid(pid
);
4380 ERR("UST app enable event per PID %d not found", pid
);
4385 if (!app
->compatible
) {
4390 ua_sess
= lookup_session_by_app(usess
, app
);
4392 /* The application has problem or is probably dead. */
4397 pthread_mutex_lock(&ua_sess
->lock
);
4398 /* Lookup channel in the ust app session */
4399 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4400 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4401 /* If the channel is not found, there is a code flow error */
4402 assert(ua_chan_node
);
4404 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4406 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4407 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4408 if (ua_event
== NULL
) {
4409 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4414 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4421 pthread_mutex_unlock(&ua_sess
->lock
);
4428 * Calibrate registered applications.
4430 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4433 struct lttng_ht_iter iter
;
4434 struct ust_app
*app
;
4438 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4439 if (!app
->compatible
) {
4441 * TODO: In time, we should notice the caller of this error by
4442 * telling him that this is a version error.
4447 health_code_update();
4449 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4453 /* Means that it's not implemented on the tracer side. */
4457 DBG2("Calibrate app PID %d returned with error %d",
4464 DBG("UST app global domain calibration finished");
4468 health_code_update();
4474 * Receive registration and populate the given msg structure.
4476 * On success return 0 else a negative value returned by the ustctl call.
4478 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4481 uint32_t pid
, ppid
, uid
, gid
;
4485 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4486 &pid
, &ppid
, &uid
, &gid
,
4487 &msg
->bits_per_long
,
4488 &msg
->uint8_t_alignment
,
4489 &msg
->uint16_t_alignment
,
4490 &msg
->uint32_t_alignment
,
4491 &msg
->uint64_t_alignment
,
4492 &msg
->long_alignment
,
4499 case LTTNG_UST_ERR_EXITING
:
4500 DBG3("UST app recv reg message failed. Application died");
4502 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4503 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4504 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4505 LTTNG_UST_ABI_MINOR_VERSION
);
4508 ERR("UST app recv reg message failed with ret %d", ret
);
4513 msg
->pid
= (pid_t
) pid
;
4514 msg
->ppid
= (pid_t
) ppid
;
4515 msg
->uid
= (uid_t
) uid
;
4516 msg
->gid
= (gid_t
) gid
;
4523 * Return a ust app channel object using the application object and the channel
4524 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4525 * lock MUST be acquired before calling this function.
4527 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4530 struct lttng_ht_node_ulong
*node
;
4531 struct lttng_ht_iter iter
;
4532 struct ust_app_channel
*ua_chan
= NULL
;
4536 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4537 node
= lttng_ht_iter_get_node_ulong(&iter
);
4539 DBG2("UST app channel find by objd %d not found", objd
);
4543 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4550 * Reply to a register channel notification from an application on the notify
4551 * socket. The channel metadata is also created.
4553 * The session UST registry lock is acquired in this function.
4555 * On success 0 is returned else a negative value.
4557 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4558 size_t nr_fields
, struct ustctl_field
*fields
)
4560 int ret
, ret_code
= 0;
4561 uint32_t chan_id
, reg_count
;
4562 uint64_t chan_reg_key
;
4563 enum ustctl_channel_header type
;
4564 struct ust_app
*app
;
4565 struct ust_app_channel
*ua_chan
;
4566 struct ust_app_session
*ua_sess
;
4567 struct ust_registry_session
*registry
;
4568 struct ust_registry_channel
*chan_reg
;
4572 /* Lookup application. If not found, there is a code flow error. */
4573 app
= find_app_by_notify_sock(sock
);
4575 DBG("Application socket %d is being teardown. Abort event notify",
4579 goto error_rcu_unlock
;
4582 /* Lookup channel by UST object descriptor. */
4583 ua_chan
= find_channel_by_objd(app
, cobjd
);
4585 DBG("Application channel is being teardown. Abort event notify");
4588 goto error_rcu_unlock
;
4591 assert(ua_chan
->session
);
4592 ua_sess
= ua_chan
->session
;
4594 /* Get right session registry depending on the session buffer type. */
4595 registry
= get_session_registry(ua_sess
);
4598 /* Depending on the buffer type, a different channel key is used. */
4599 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4600 chan_reg_key
= ua_chan
->tracing_channel_id
;
4602 chan_reg_key
= ua_chan
->key
;
4605 pthread_mutex_lock(®istry
->lock
);
4607 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4610 if (!chan_reg
->register_done
) {
4611 reg_count
= ust_registry_get_event_count(chan_reg
);
4612 if (reg_count
< 31) {
4613 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4615 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4618 chan_reg
->nr_ctx_fields
= nr_fields
;
4619 chan_reg
->ctx_fields
= fields
;
4620 chan_reg
->header_type
= type
;
4622 /* Get current already assigned values. */
4623 type
= chan_reg
->header_type
;
4625 /* Set to NULL so the error path does not do a double free. */
4628 /* Channel id is set during the object creation. */
4629 chan_id
= chan_reg
->chan_id
;
4631 /* Append to metadata */
4632 if (!chan_reg
->metadata_dumped
) {
4633 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4635 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4641 DBG3("UST app replying to register channel key %" PRIu64
4642 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4645 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4647 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4648 ERR("UST app reply channel failed with ret %d", ret
);
4650 DBG3("UST app reply channel failed. Application died");
4655 /* This channel registry registration is completed. */
4656 chan_reg
->register_done
= 1;
4659 pthread_mutex_unlock(®istry
->lock
);
4669 * Add event to the UST channel registry. When the event is added to the
4670 * registry, the metadata is also created. Once done, this replies to the
4671 * application with the appropriate error code.
4673 * The session UST registry lock is acquired in the function.
4675 * On success 0 is returned else a negative value.
4677 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4678 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4679 char *model_emf_uri
)
4682 uint32_t event_id
= 0;
4683 uint64_t chan_reg_key
;
4684 struct ust_app
*app
;
4685 struct ust_app_channel
*ua_chan
;
4686 struct ust_app_session
*ua_sess
;
4687 struct ust_registry_session
*registry
;
4691 /* Lookup application. If not found, there is a code flow error. */
4692 app
= find_app_by_notify_sock(sock
);
4694 DBG("Application socket %d is being teardown. Abort event notify",
4699 free(model_emf_uri
);
4700 goto error_rcu_unlock
;
4703 /* Lookup channel by UST object descriptor. */
4704 ua_chan
= find_channel_by_objd(app
, cobjd
);
4706 DBG("Application channel is being teardown. Abort event notify");
4710 free(model_emf_uri
);
4711 goto error_rcu_unlock
;
4714 assert(ua_chan
->session
);
4715 ua_sess
= ua_chan
->session
;
4717 registry
= get_session_registry(ua_sess
);
4720 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4721 chan_reg_key
= ua_chan
->tracing_channel_id
;
4723 chan_reg_key
= ua_chan
->key
;
4726 pthread_mutex_lock(®istry
->lock
);
4729 * From this point on, this call acquires the ownership of the sig, fields
4730 * and model_emf_uri meaning any free are done inside it if needed. These
4731 * three variables MUST NOT be read/write after this.
4733 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4734 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4735 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4739 * The return value is returned to ustctl so in case of an error, the
4740 * application can be notified. In case of an error, it's important not to
4741 * return a negative error or else the application will get closed.
4743 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4745 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4746 ERR("UST app reply event failed with ret %d", ret
);
4748 DBG3("UST app reply event failed. Application died");
4751 * No need to wipe the create event since the application socket will
4752 * get close on error hence cleaning up everything by itself.
4757 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4761 pthread_mutex_unlock(®istry
->lock
);
4768 * Handle application notification through the given notify socket.
4770 * Return 0 on success or else a negative value.
4772 int ust_app_recv_notify(int sock
)
4775 enum ustctl_notify_cmd cmd
;
4777 DBG3("UST app receiving notify from sock %d", sock
);
4779 ret
= ustctl_recv_notify(sock
, &cmd
);
4781 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4782 ERR("UST app recv notify failed with ret %d", ret
);
4784 DBG3("UST app recv notify failed. Application died");
4790 case USTCTL_NOTIFY_CMD_EVENT
:
4792 int sobjd
, cobjd
, loglevel
;
4793 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4795 struct ustctl_field
*fields
;
4797 DBG2("UST app ustctl register event received");
4799 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4800 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4802 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4803 ERR("UST app recv event failed with ret %d", ret
);
4805 DBG3("UST app recv event failed. Application died");
4811 * Add event to the UST registry coming from the notify socket. This
4812 * call will free if needed the sig, fields and model_emf_uri. This
4813 * code path loses the ownsership of these variables and transfer them
4814 * to the this function.
4816 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4817 fields
, loglevel
, model_emf_uri
);
4824 case USTCTL_NOTIFY_CMD_CHANNEL
:
4828 struct ustctl_field
*fields
;
4830 DBG2("UST app ustctl register channel received");
4832 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4835 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4836 ERR("UST app recv channel failed with ret %d", ret
);
4838 DBG3("UST app recv channel failed. Application died");
4844 * The fields ownership are transfered to this function call meaning
4845 * that if needed it will be freed. After this, it's invalid to access
4846 * fields or clean it up.
4848 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4857 /* Should NEVER happen. */
4866 * Once the notify socket hangs up, this is called. First, it tries to find the
4867 * corresponding application. On failure, the call_rcu to close the socket is
4868 * executed. If an application is found, it tries to delete it from the notify
4869 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4871 * Note that an object needs to be allocated here so on ENOMEM failure, the
4872 * call RCU is not done but the rest of the cleanup is.
4874 void ust_app_notify_sock_unregister(int sock
)
4877 struct lttng_ht_iter iter
;
4878 struct ust_app
*app
;
4879 struct ust_app_notify_sock_obj
*obj
;
4885 obj
= zmalloc(sizeof(*obj
));
4888 * An ENOMEM is kind of uncool. If this strikes we continue the
4889 * procedure but the call_rcu will not be called. In this case, we
4890 * accept the fd leak rather than possibly creating an unsynchronized
4891 * state between threads.
4893 * TODO: The notify object should be created once the notify socket is
4894 * registered and stored independantely from the ust app object. The
4895 * tricky part is to synchronize the teardown of the application and
4896 * this notify object. Let's keep that in mind so we can avoid this
4897 * kind of shenanigans with ENOMEM in the teardown path.
4904 DBG("UST app notify socket unregister %d", sock
);
4907 * Lookup application by notify socket. If this fails, this means that the
4908 * hash table delete has already been done by the application
4909 * unregistration process so we can safely close the notify socket in a
4912 app
= find_app_by_notify_sock(sock
);
4917 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4920 * Whatever happens here either we fail or succeed, in both cases we have
4921 * to close the socket after a grace period to continue to the call RCU
4922 * here. If the deletion is successful, the application is not visible
4923 * anymore by other threads and is it fails it means that it was already
4924 * deleted from the hash table so either way we just have to close the
4927 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4933 * Close socket after a grace period to avoid for the socket to be reused
4934 * before the application object is freed creating potential race between
4935 * threads trying to add unique in the global hash table.
4938 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4943 * Destroy a ust app data structure and free its memory.
4945 void ust_app_destroy(struct ust_app
*app
)
4951 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4955 * Take a snapshot for a given UST session. The snapshot is sent to the given
4958 * Return 0 on success or else a negative value.
4960 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4961 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4964 unsigned int snapshot_done
= 0;
4965 struct lttng_ht_iter iter
;
4966 struct ust_app
*app
;
4967 char pathname
[PATH_MAX
];
4968 uint64_t max_stream_size
= 0;
4976 * Compute the maximum size of a single stream if a max size is asked by
4979 if (output
->max_size
> 0 && nb_streams
> 0) {
4980 max_stream_size
= output
->max_size
/ nb_streams
;
4983 switch (usess
->buffer_type
) {
4984 case LTTNG_BUFFER_PER_UID
:
4986 struct buffer_reg_uid
*reg
;
4988 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4989 struct buffer_reg_channel
*reg_chan
;
4990 struct consumer_socket
*socket
;
4992 /* Get consumer socket to use to push the metadata.*/
4993 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5000 memset(pathname
, 0, sizeof(pathname
));
5001 ret
= snprintf(pathname
, sizeof(pathname
),
5002 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5003 reg
->uid
, reg
->bits_per_long
);
5005 PERROR("snprintf snapshot path");
5009 /* Add the UST default trace dir to path. */
5010 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5011 reg_chan
, node
.node
) {
5014 * Make sure the maximum stream size is not lower than the
5015 * subbuffer size or else it's an error since we won't be able to
5016 * snapshot anything.
5018 if (max_stream_size
&&
5019 reg_chan
->subbuf_size
> max_stream_size
) {
5021 DBG3("UST app snapshot record maximum stream size %" PRIu64
5022 " is smaller than subbuffer size of %zu",
5023 max_stream_size
, reg_chan
->subbuf_size
);
5026 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5027 usess
->uid
, usess
->gid
, pathname
, wait
,
5033 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5034 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5043 case LTTNG_BUFFER_PER_PID
:
5045 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5046 struct consumer_socket
*socket
;
5047 struct lttng_ht_iter chan_iter
;
5048 struct ust_app_channel
*ua_chan
;
5049 struct ust_app_session
*ua_sess
;
5050 struct ust_registry_session
*registry
;
5052 ua_sess
= lookup_session_by_app(usess
, app
);
5054 /* Session not associated with this app. */
5058 /* Get the right consumer socket for the application. */
5059 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5066 /* Add the UST default trace dir to path. */
5067 memset(pathname
, 0, sizeof(pathname
));
5068 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5071 PERROR("snprintf snapshot path");
5075 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5076 ua_chan
, node
.node
) {
5078 * Make sure the maximum stream size is not lower than the
5079 * subbuffer size or else it's an error since we won't be able to
5080 * snapshot anything.
5082 if (max_stream_size
&&
5083 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5085 DBG3("UST app snapshot record maximum stream size %" PRIu64
5086 " is smaller than subbuffer size of %" PRIu64
,
5087 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5091 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5092 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5099 registry
= get_session_registry(ua_sess
);
5101 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5102 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5116 if (!snapshot_done
) {
5118 * If no snapshot was made and we are not in the error path, this means
5119 * that there are no buffers thus no (prior) application to snapshot
5120 * data from so we have simply NO data.
5131 * Return the number of streams for a UST session.
5133 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5135 unsigned int ret
= 0;
5136 struct ust_app
*app
;
5137 struct lttng_ht_iter iter
;
5141 switch (usess
->buffer_type
) {
5142 case LTTNG_BUFFER_PER_UID
:
5144 struct buffer_reg_uid
*reg
;
5146 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5147 struct buffer_reg_channel
*reg_chan
;
5150 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5151 reg_chan
, node
.node
) {
5152 ret
+= reg_chan
->stream_count
;
5158 case LTTNG_BUFFER_PER_PID
:
5161 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5162 struct ust_app_channel
*ua_chan
;
5163 struct ust_app_session
*ua_sess
;
5164 struct lttng_ht_iter chan_iter
;
5166 ua_sess
= lookup_session_by_app(usess
, app
);
5168 /* Session not associated with this app. */
5172 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5173 ua_chan
, node
.node
) {
5174 ret
+= ua_chan
->streams
.count
;