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
;
444 pthread_mutex_lock(®istry
->lock
);
447 * Means that no metadata was assigned to the session. This can happens if
448 * no start has been done previously.
450 if (!registry
->metadata_key
) {
451 pthread_mutex_unlock(®istry
->lock
);
456 * On a push metadata error either the consumer is dead or the metadata
457 * channel has been destroyed because its endpoint might have died (e.g:
458 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
459 * metadata again which is not valid anymore on the consumer side.
461 if (registry
->metadata_closed
) {
462 pthread_mutex_unlock(®istry
->lock
);
466 offset
= registry
->metadata_len_sent
;
467 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
469 DBG3("No metadata to push for metadata key %" PRIu64
,
470 registry
->metadata_key
);
472 if (send_zero_data
) {
473 DBG("No metadata to push");
479 /* Allocate only what we have to send. */
480 metadata_str
= zmalloc(len
);
482 PERROR("zmalloc ust app metadata string");
486 /* Copy what we haven't send out. */
487 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
488 registry
->metadata_len_sent
+= len
;
491 pthread_mutex_unlock(®istry
->lock
);
492 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
493 metadata_str
, len
, offset
);
496 * There is an acceptable race here between the registry metadata key
497 * assignment and the creation on the consumer. The session daemon can
498 * concurrently push metadata for this registry while being created on
499 * the consumer since the metadata key of the registry is assigned
500 * *before* it is setup to avoid the consumer to ask for metadata that
501 * could possibly be not found in the session daemon.
503 * The metadata will get pushed either by the session being stopped or
504 * the consumer requesting metadata if that race is triggered.
506 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
510 /* Update back the actual metadata len sent since it failed here. */
511 pthread_mutex_lock(®istry
->lock
);
512 registry
->metadata_len_sent
-= len
;
513 pthread_mutex_unlock(®istry
->lock
);
525 * On error, flag the registry that the metadata is closed. We were unable
526 * to push anything and this means that either the consumer is not
527 * responding or the metadata cache has been destroyed on the consumer.
529 registry
->metadata_closed
= 1;
531 pthread_mutex_unlock(®istry
->lock
);
538 * For a given application and session, push metadata to consumer.
539 * Either sock or consumer is required : if sock is NULL, the default
540 * socket to send the metadata is retrieved from consumer, if sock
541 * is not NULL we use it to send the metadata.
542 * RCU read-side lock must be held while calling this function,
543 * therefore ensuring existance of registry.
545 * Return 0 on success else a negative error.
547 static int push_metadata(struct ust_registry_session
*registry
,
548 struct consumer_output
*consumer
)
552 struct consumer_socket
*socket
;
557 pthread_mutex_lock(®istry
->lock
);
559 if (registry
->metadata_closed
) {
560 pthread_mutex_unlock(®istry
->lock
);
564 /* Get consumer socket to use to push the metadata.*/
565 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
567 pthread_mutex_unlock(®istry
->lock
);
574 * TODO: Currently, we hold the socket lock around sampling of the next
575 * metadata segment to ensure we send metadata over the consumer socket in
576 * the correct order. This makes the registry lock nest inside the socket
579 * Please note that this is a temporary measure: we should move this lock
580 * back into ust_consumer_push_metadata() when the consumer gets the
581 * ability to reorder the metadata it receives.
583 pthread_mutex_lock(socket
->lock
);
584 ret
= ust_app_push_metadata(registry
, socket
, 0);
585 pthread_mutex_unlock(socket
->lock
);
598 * Send to the consumer a close metadata command for the given session. Once
599 * done, the metadata channel is deleted and the session metadata pointer is
600 * nullified. The session lock MUST be acquired here unless the application is
601 * in the destroy path.
603 * Return 0 on success else a negative value.
605 static int close_metadata(struct ust_registry_session
*registry
,
606 struct consumer_output
*consumer
)
609 struct consumer_socket
*socket
;
616 pthread_mutex_lock(®istry
->lock
);
618 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
623 /* Get consumer socket to use to push the metadata.*/
624 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
631 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
638 * Metadata closed. Even on error this means that the consumer is not
639 * responding or not found so either way a second close should NOT be emit
642 registry
->metadata_closed
= 1;
644 pthread_mutex_unlock(®istry
->lock
);
650 * We need to execute ht_destroy outside of RCU read-side critical
651 * section and outside of call_rcu thread, so we postpone its execution
652 * using ht_cleanup_push. It is simpler than to change the semantic of
653 * the many callers of delete_ust_app_session().
656 void delete_ust_app_session_rcu(struct rcu_head
*head
)
658 struct ust_app_session
*ua_sess
=
659 caa_container_of(head
, struct ust_app_session
, rcu_head
);
661 ht_cleanup_push(ua_sess
->channels
);
666 * Delete ust app session safely. RCU read lock must be held before calling
670 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
674 struct lttng_ht_iter iter
;
675 struct ust_app_channel
*ua_chan
;
676 struct ust_registry_session
*registry
;
680 pthread_mutex_lock(&ua_sess
->lock
);
682 registry
= get_session_registry(ua_sess
);
684 /* Push metadata for application before freeing the application. */
685 (void) push_metadata(registry
, ua_sess
->consumer
);
688 * Don't ask to close metadata for global per UID buffers. Close
689 * metadata only on destroy trace session in this case. Also, the
690 * previous push metadata could have flag the metadata registry to
691 * close so don't send a close command if closed.
693 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
694 /* And ask to close it for this session registry. */
695 (void) close_metadata(registry
, ua_sess
->consumer
);
699 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
701 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
703 delete_ust_app_channel(sock
, ua_chan
, app
);
706 /* In case of per PID, the registry is kept in the session. */
707 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
708 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
710 buffer_reg_pid_remove(reg_pid
);
711 buffer_reg_pid_destroy(reg_pid
);
715 if (ua_sess
->handle
!= -1) {
716 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
717 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
718 ERR("UST app sock %d release session handle failed with ret %d",
722 pthread_mutex_unlock(&ua_sess
->lock
);
724 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
728 * Delete a traceable application structure from the global list. Never call
729 * this function outside of a call_rcu call.
731 * RCU read side lock should _NOT_ be held when calling this function.
734 void delete_ust_app(struct ust_app
*app
)
737 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
739 /* Delete ust app sessions info */
744 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
746 /* Free every object in the session and the session. */
748 delete_ust_app_session(sock
, ua_sess
, app
);
752 ht_cleanup_push(app
->sessions
);
753 ht_cleanup_push(app
->ust_objd
);
756 * Wait until we have deleted the application from the sock hash table
757 * before closing this socket, otherwise an application could re-use the
758 * socket ID and race with the teardown, using the same hash table entry.
760 * It's OK to leave the close in call_rcu. We want it to stay unique for
761 * all RCU readers that could run concurrently with unregister app,
762 * therefore we _need_ to only close that socket after a grace period. So
763 * it should stay in this RCU callback.
765 * This close() is a very important step of the synchronization model so
766 * every modification to this function must be carefully reviewed.
772 lttng_fd_put(LTTNG_FD_APPS
, 1);
774 DBG2("UST app pid %d deleted", app
->pid
);
779 * URCU intermediate call to delete an UST app.
782 void delete_ust_app_rcu(struct rcu_head
*head
)
784 struct lttng_ht_node_ulong
*node
=
785 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
786 struct ust_app
*app
=
787 caa_container_of(node
, struct ust_app
, pid_n
);
789 DBG3("Call RCU deleting app PID %d", app
->pid
);
794 * Delete the session from the application ht and delete the data structure by
795 * freeing every object inside and releasing them.
797 static void destroy_app_session(struct ust_app
*app
,
798 struct ust_app_session
*ua_sess
)
801 struct lttng_ht_iter iter
;
806 iter
.iter
.node
= &ua_sess
->node
.node
;
807 ret
= lttng_ht_del(app
->sessions
, &iter
);
809 /* Already scheduled for teardown. */
813 /* Once deleted, free the data structure. */
814 delete_ust_app_session(app
->sock
, ua_sess
, app
);
821 * Alloc new UST app session.
824 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
826 struct ust_app_session
*ua_sess
;
828 /* Init most of the default value by allocating and zeroing */
829 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
830 if (ua_sess
== NULL
) {
835 ua_sess
->handle
= -1;
836 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
837 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
838 pthread_mutex_init(&ua_sess
->lock
, NULL
);
847 * Alloc new UST app channel.
850 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
851 struct ust_app_session
*ua_sess
,
852 struct lttng_ust_channel_attr
*attr
)
854 struct ust_app_channel
*ua_chan
;
856 /* Init most of the default value by allocating and zeroing */
857 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
858 if (ua_chan
== NULL
) {
863 /* Setup channel name */
864 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
865 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
867 ua_chan
->enabled
= 1;
868 ua_chan
->handle
= -1;
869 ua_chan
->session
= ua_sess
;
870 ua_chan
->key
= get_next_channel_key();
871 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
872 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
873 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
875 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
876 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
878 /* Copy attributes */
880 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
881 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
882 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
883 ua_chan
->attr
.overwrite
= attr
->overwrite
;
884 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
885 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
886 ua_chan
->attr
.output
= attr
->output
;
888 /* By default, the channel is a per cpu channel. */
889 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
891 DBG3("UST app channel %s allocated", ua_chan
->name
);
900 * Allocate and initialize a UST app stream.
902 * Return newly allocated stream pointer or NULL on error.
904 struct ust_app_stream
*ust_app_alloc_stream(void)
906 struct ust_app_stream
*stream
= NULL
;
908 stream
= zmalloc(sizeof(*stream
));
909 if (stream
== NULL
) {
910 PERROR("zmalloc ust app stream");
914 /* Zero could be a valid value for a handle so flag it to -1. */
922 * Alloc new UST app event.
925 struct ust_app_event
*alloc_ust_app_event(char *name
,
926 struct lttng_ust_event
*attr
)
928 struct ust_app_event
*ua_event
;
930 /* Init most of the default value by allocating and zeroing */
931 ua_event
= zmalloc(sizeof(struct ust_app_event
));
932 if (ua_event
== NULL
) {
937 ua_event
->enabled
= 1;
938 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
939 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
940 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
942 /* Copy attributes */
944 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
947 DBG3("UST app event %s allocated", ua_event
->name
);
956 * Alloc new UST app context.
959 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
961 struct ust_app_ctx
*ua_ctx
;
963 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
964 if (ua_ctx
== NULL
) {
968 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
971 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
974 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
981 * Allocate a filter and copy the given original filter.
983 * Return allocated filter or NULL on error.
985 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
986 struct lttng_ust_filter_bytecode
*orig_f
)
988 struct lttng_ust_filter_bytecode
*filter
= NULL
;
990 /* Copy filter bytecode */
991 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
993 PERROR("zmalloc alloc ust app filter");
997 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1004 * Find an ust_app using the sock and return it. RCU read side lock must be
1005 * held before calling this helper function.
1007 struct ust_app
*ust_app_find_by_sock(int sock
)
1009 struct lttng_ht_node_ulong
*node
;
1010 struct lttng_ht_iter iter
;
1012 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1013 node
= lttng_ht_iter_get_node_ulong(&iter
);
1015 DBG2("UST app find by sock %d not found", sock
);
1019 return caa_container_of(node
, struct ust_app
, sock_n
);
1026 * Find an ust_app using the notify sock and return it. RCU read side lock must
1027 * be held before calling this helper function.
1029 static struct ust_app
*find_app_by_notify_sock(int sock
)
1031 struct lttng_ht_node_ulong
*node
;
1032 struct lttng_ht_iter iter
;
1034 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1036 node
= lttng_ht_iter_get_node_ulong(&iter
);
1038 DBG2("UST app find by notify sock %d not found", sock
);
1042 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1049 * Lookup for an ust app event based on event name, filter bytecode and the
1052 * Return an ust_app_event object or NULL on error.
1054 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1055 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1056 const struct lttng_event_exclusion
*exclusion
)
1058 struct lttng_ht_iter iter
;
1059 struct lttng_ht_node_str
*node
;
1060 struct ust_app_event
*event
= NULL
;
1061 struct ust_app_ht_key key
;
1066 /* Setup key for event lookup. */
1068 key
.filter
= filter
;
1069 key
.loglevel
= loglevel
;
1070 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1071 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1073 /* Lookup using the event name as hash and a custom match fct. */
1074 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1075 ht_match_ust_app_event
, &key
, &iter
.iter
);
1076 node
= lttng_ht_iter_get_node_str(&iter
);
1081 event
= caa_container_of(node
, struct ust_app_event
, node
);
1088 * Create the channel context on the tracer.
1090 * Called with UST app session lock held.
1093 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1094 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1098 health_code_update();
1100 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1101 ua_chan
->obj
, &ua_ctx
->obj
);
1103 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1104 ERR("UST app create channel context failed for app (pid: %d) "
1105 "with ret %d", app
->pid
, ret
);
1108 * This is normal behavior, an application can die during the
1109 * creation process. Don't report an error so the execution can
1110 * continue normally.
1113 DBG3("UST app disable event failed. Application is dead.");
1118 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1120 DBG2("UST app context handle %d created successfully for channel %s",
1121 ua_ctx
->handle
, ua_chan
->name
);
1124 health_code_update();
1129 * Set the filter on the tracer.
1132 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1133 struct ust_app
*app
)
1137 health_code_update();
1139 if (!ua_event
->filter
) {
1144 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1147 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1148 ERR("UST app event %s filter failed for app (pid: %d) "
1149 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1152 * This is normal behavior, an application can die during the
1153 * creation process. Don't report an error so the execution can
1154 * continue normally.
1157 DBG3("UST app filter event failed. Application is dead.");
1162 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1165 health_code_update();
1170 * Set event exclusions on the tracer.
1173 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1174 struct ust_app
*app
)
1178 health_code_update();
1180 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1185 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1188 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1189 ERR("UST app event %s exclusions failed for app (pid: %d) "
1190 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1193 * This is normal behavior, an application can die during the
1194 * creation process. Don't report an error so the execution can
1195 * continue normally.
1198 DBG3("UST app event exclusion failed. Application is dead.");
1203 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1206 health_code_update();
1211 * Disable the specified event on to UST tracer for the UST session.
1213 static int disable_ust_event(struct ust_app
*app
,
1214 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1218 health_code_update();
1220 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1222 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1223 ERR("UST app event %s disable failed for app (pid: %d) "
1224 "and session handle %d with ret %d",
1225 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1228 * This is normal behavior, an application can die during the
1229 * creation process. Don't report an error so the execution can
1230 * continue normally.
1233 DBG3("UST app disable event failed. Application is dead.");
1238 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1239 ua_event
->attr
.name
, app
->pid
);
1242 health_code_update();
1247 * Disable the specified channel on to UST tracer for the UST session.
1249 static int disable_ust_channel(struct ust_app
*app
,
1250 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1254 health_code_update();
1256 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1258 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1259 ERR("UST app channel %s disable failed for app (pid: %d) "
1260 "and session handle %d with ret %d",
1261 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1264 * This is normal behavior, an application can die during the
1265 * creation process. Don't report an error so the execution can
1266 * continue normally.
1269 DBG3("UST app disable channel failed. Application is dead.");
1274 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1275 ua_chan
->name
, app
->pid
);
1278 health_code_update();
1283 * Enable the specified channel on to UST tracer for the UST session.
1285 static int enable_ust_channel(struct ust_app
*app
,
1286 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1290 health_code_update();
1292 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1294 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1295 ERR("UST app channel %s enable failed for app (pid: %d) "
1296 "and session handle %d with ret %d",
1297 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1300 * This is normal behavior, an application can die during the
1301 * creation process. Don't report an error so the execution can
1302 * continue normally.
1305 DBG3("UST app enable channel failed. Application is dead.");
1310 ua_chan
->enabled
= 1;
1312 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1313 ua_chan
->name
, app
->pid
);
1316 health_code_update();
1321 * Enable the specified event on to UST tracer for the UST session.
1323 static int enable_ust_event(struct ust_app
*app
,
1324 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1328 health_code_update();
1330 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1332 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1333 ERR("UST app event %s enable failed for app (pid: %d) "
1334 "and session handle %d with ret %d",
1335 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1338 * This is normal behavior, an application can die during the
1339 * creation process. Don't report an error so the execution can
1340 * continue normally.
1343 DBG3("UST app enable event failed. Application is dead.");
1348 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1349 ua_event
->attr
.name
, app
->pid
);
1352 health_code_update();
1357 * Send channel and stream buffer to application.
1359 * Return 0 on success. On error, a negative value is returned.
1361 static int send_channel_pid_to_ust(struct ust_app
*app
,
1362 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1365 struct ust_app_stream
*stream
, *stmp
;
1371 health_code_update();
1373 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1376 /* Send channel to the application. */
1377 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1382 health_code_update();
1384 /* Send all streams to application. */
1385 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1386 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1390 /* We don't need the stream anymore once sent to the tracer. */
1391 cds_list_del(&stream
->list
);
1392 delete_ust_app_stream(-1, stream
);
1394 /* Flag the channel that it is sent to the application. */
1395 ua_chan
->is_sent
= 1;
1398 health_code_update();
1403 * Create the specified event onto the UST tracer for a UST session.
1405 * Should be called with session mutex held.
1408 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1409 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1413 health_code_update();
1415 /* Create UST event on tracer */
1416 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1419 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1420 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1421 ua_event
->attr
.name
, app
->pid
, ret
);
1424 * This is normal behavior, an application can die during the
1425 * creation process. Don't report an error so the execution can
1426 * continue normally.
1429 DBG3("UST app create event failed. Application is dead.");
1434 ua_event
->handle
= ua_event
->obj
->handle
;
1436 DBG2("UST app event %s created successfully for pid:%d",
1437 ua_event
->attr
.name
, app
->pid
);
1439 health_code_update();
1441 /* Set filter if one is present. */
1442 if (ua_event
->filter
) {
1443 ret
= set_ust_event_filter(ua_event
, app
);
1449 /* Set exclusions for the event */
1450 if (ua_event
->exclusion
) {
1451 ret
= set_ust_event_exclusion(ua_event
, app
);
1457 /* If event not enabled, disable it on the tracer */
1458 if (ua_event
->enabled
) {
1460 * We now need to explicitly enable the event, since it
1461 * is now disabled at creation.
1463 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1466 * If we hit an EPERM, something is wrong with our enable call. If
1467 * we get an EEXIST, there is a problem on the tracer side since we
1471 case -LTTNG_UST_ERR_PERM
:
1472 /* Code flow problem */
1474 case -LTTNG_UST_ERR_EXIST
:
1475 /* It's OK for our use case. */
1484 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1487 * If we hit an EPERM, something is wrong with our disable call. If
1488 * we get an EEXIST, there is a problem on the tracer side since we
1492 case -LTTNG_UST_ERR_PERM
:
1493 /* Code flow problem */
1495 case -LTTNG_UST_ERR_EXIST
:
1496 /* It's OK for our use case. */
1507 health_code_update();
1512 * Copy data between an UST app event and a LTT event.
1514 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1515 struct ltt_ust_event
*uevent
)
1517 size_t exclusion_alloc_size
;
1519 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1520 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1522 ua_event
->enabled
= uevent
->enabled
;
1524 /* Copy event attributes */
1525 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1527 /* Copy filter bytecode */
1528 if (uevent
->filter
) {
1529 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1530 /* Filter might be NULL here in case of ENONEM. */
1533 /* Copy exclusion data */
1534 if (uevent
->exclusion
) {
1535 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1536 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1537 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1538 if (ua_event
->exclusion
== NULL
) {
1541 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1542 exclusion_alloc_size
);
1548 * Copy data between an UST app channel and a LTT channel.
1550 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1551 struct ltt_ust_channel
*uchan
)
1553 struct lttng_ht_iter iter
;
1554 struct ltt_ust_event
*uevent
;
1555 struct ltt_ust_context
*uctx
;
1556 struct ust_app_event
*ua_event
;
1557 struct ust_app_ctx
*ua_ctx
;
1559 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1561 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1562 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1564 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1565 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1567 /* Copy event attributes since the layout is different. */
1568 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1569 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1570 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1571 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1572 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1573 ua_chan
->attr
.output
= uchan
->attr
.output
;
1575 * Note that the attribute channel type is not set since the channel on the
1576 * tracing registry side does not have this information.
1579 ua_chan
->enabled
= uchan
->enabled
;
1580 ua_chan
->tracing_channel_id
= uchan
->id
;
1582 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1583 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1584 if (ua_ctx
== NULL
) {
1587 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1588 (unsigned long) ua_ctx
->ctx
.ctx
);
1589 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1590 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1593 /* Copy all events from ltt ust channel to ust app channel */
1594 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1595 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1596 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1597 if (ua_event
== NULL
) {
1598 DBG2("UST event %s not found on shadow copy channel",
1600 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1601 if (ua_event
== NULL
) {
1604 shadow_copy_event(ua_event
, uevent
);
1605 add_unique_ust_app_event(ua_chan
, ua_event
);
1609 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1613 * Copy data between a UST app session and a regular LTT session.
1615 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1616 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1618 struct lttng_ht_node_str
*ua_chan_node
;
1619 struct lttng_ht_iter iter
;
1620 struct ltt_ust_channel
*uchan
;
1621 struct ust_app_channel
*ua_chan
;
1623 struct tm
*timeinfo
;
1627 /* Get date and time for unique app path */
1629 timeinfo
= localtime(&rawtime
);
1630 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1632 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1634 ua_sess
->tracing_id
= usess
->id
;
1635 ua_sess
->id
= get_next_session_id();
1636 ua_sess
->uid
= app
->uid
;
1637 ua_sess
->gid
= app
->gid
;
1638 ua_sess
->euid
= usess
->uid
;
1639 ua_sess
->egid
= usess
->gid
;
1640 ua_sess
->buffer_type
= usess
->buffer_type
;
1641 ua_sess
->bits_per_long
= app
->bits_per_long
;
1642 /* There is only one consumer object per session possible. */
1643 ua_sess
->consumer
= usess
->consumer
;
1644 ua_sess
->output_traces
= usess
->output_traces
;
1645 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1646 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1647 &usess
->metadata_attr
);
1649 switch (ua_sess
->buffer_type
) {
1650 case LTTNG_BUFFER_PER_PID
:
1651 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1652 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1655 case LTTNG_BUFFER_PER_UID
:
1656 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1657 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1664 PERROR("asprintf UST shadow copy session");
1669 /* Iterate over all channels in global domain. */
1670 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1672 struct lttng_ht_iter uiter
;
1674 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1675 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1676 if (ua_chan_node
!= NULL
) {
1677 /* Session exist. Contiuing. */
1681 DBG2("Channel %s not found on shadow session copy, creating it",
1683 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1684 if (ua_chan
== NULL
) {
1685 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1688 shadow_copy_channel(ua_chan
, uchan
);
1690 * The concept of metadata channel does not exist on the tracing
1691 * registry side of the session daemon so this can only be a per CPU
1692 * channel and not metadata.
1694 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1696 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1704 * Lookup sesison wrapper.
1707 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1708 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1710 /* Get right UST app session from app */
1711 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1715 * Return ust app session from the app session hashtable using the UST session
1718 static struct ust_app_session
*lookup_session_by_app(
1719 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1721 struct lttng_ht_iter iter
;
1722 struct lttng_ht_node_u64
*node
;
1724 __lookup_session_by_app(usess
, app
, &iter
);
1725 node
= lttng_ht_iter_get_node_u64(&iter
);
1730 return caa_container_of(node
, struct ust_app_session
, node
);
1737 * Setup buffer registry per PID for the given session and application. If none
1738 * is found, a new one is created, added to the global registry and
1739 * initialized. If regp is valid, it's set with the newly created object.
1741 * Return 0 on success or else a negative value.
1743 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1744 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1747 struct buffer_reg_pid
*reg_pid
;
1754 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1757 * This is the create channel path meaning that if there is NO
1758 * registry available, we have to create one for this session.
1760 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1764 buffer_reg_pid_add(reg_pid
);
1769 /* Initialize registry. */
1770 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1771 app
->bits_per_long
, app
->uint8_t_alignment
,
1772 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1773 app
->uint64_t_alignment
, app
->long_alignment
,
1774 app
->byte_order
, app
->version
.major
,
1775 app
->version
.minor
);
1780 DBG3("UST app buffer registry per PID created successfully");
1792 * Setup buffer registry per UID for the given session and application. If none
1793 * is found, a new one is created, added to the global registry and
1794 * initialized. If regp is valid, it's set with the newly created object.
1796 * Return 0 on success or else a negative value.
1798 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1799 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1802 struct buffer_reg_uid
*reg_uid
;
1809 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1812 * This is the create channel path meaning that if there is NO
1813 * registry available, we have to create one for this session.
1815 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1816 LTTNG_DOMAIN_UST
, ®_uid
);
1820 buffer_reg_uid_add(reg_uid
);
1825 /* Initialize registry. */
1826 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1827 app
->bits_per_long
, app
->uint8_t_alignment
,
1828 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1829 app
->uint64_t_alignment
, app
->long_alignment
,
1830 app
->byte_order
, app
->version
.major
,
1831 app
->version
.minor
);
1835 /* Add node to teardown list of the session. */
1836 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1838 DBG3("UST app buffer registry per UID created successfully");
1850 * Create a session on the tracer side for the given app.
1852 * On success, ua_sess_ptr is populated with the session pointer or else left
1853 * untouched. If the session was created, is_created is set to 1. On error,
1854 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1857 * Returns 0 on success or else a negative code which is either -ENOMEM or
1858 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1860 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1861 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1864 int ret
, created
= 0;
1865 struct ust_app_session
*ua_sess
;
1869 assert(ua_sess_ptr
);
1871 health_code_update();
1873 ua_sess
= lookup_session_by_app(usess
, app
);
1874 if (ua_sess
== NULL
) {
1875 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1876 app
->pid
, usess
->id
);
1877 ua_sess
= alloc_ust_app_session(app
);
1878 if (ua_sess
== NULL
) {
1879 /* Only malloc can failed so something is really wrong */
1883 shadow_copy_session(ua_sess
, usess
, app
);
1887 switch (usess
->buffer_type
) {
1888 case LTTNG_BUFFER_PER_PID
:
1889 /* Init local registry. */
1890 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1895 case LTTNG_BUFFER_PER_UID
:
1896 /* Look for a global registry. If none exists, create one. */
1897 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1908 health_code_update();
1910 if (ua_sess
->handle
== -1) {
1911 ret
= ustctl_create_session(app
->sock
);
1913 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1914 ERR("Creating session for app pid %d with ret %d",
1917 DBG("UST app creating session failed. Application is dead");
1919 * This is normal behavior, an application can die during the
1920 * creation process. Don't report an error so the execution can
1921 * continue normally. This will get flagged ENOTCONN and the
1922 * caller will handle it.
1926 delete_ust_app_session(-1, ua_sess
, app
);
1927 if (ret
!= -ENOMEM
) {
1929 * Tracer is probably gone or got an internal error so let's
1930 * behave like it will soon unregister or not usable.
1937 ua_sess
->handle
= ret
;
1939 /* Add ust app session to app's HT */
1940 lttng_ht_node_init_u64(&ua_sess
->node
,
1941 ua_sess
->tracing_id
);
1942 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1944 DBG2("UST app session created successfully with handle %d", ret
);
1947 *ua_sess_ptr
= ua_sess
;
1949 *is_created
= created
;
1952 /* Everything went well. */
1956 health_code_update();
1961 * Match function for a hash table lookup of ust_app_ctx.
1963 * It matches an ust app context based on the context type and, in the case
1964 * of perf counters, their name.
1966 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1968 struct ust_app_ctx
*ctx
;
1969 const struct lttng_ust_context
*key
;
1974 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1978 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1982 /* Check the name in the case of perf thread counters. */
1983 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1984 if (strncmp(key
->u
.perf_counter
.name
,
1985 ctx
->ctx
.u
.perf_counter
.name
,
1986 sizeof(key
->u
.perf_counter
.name
))) {
1999 * Lookup for an ust app context from an lttng_ust_context.
2001 * Must be called while holding RCU read side lock.
2002 * Return an ust_app_ctx object or NULL on error.
2005 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2006 struct lttng_ust_context
*uctx
)
2008 struct lttng_ht_iter iter
;
2009 struct lttng_ht_node_ulong
*node
;
2010 struct ust_app_ctx
*app_ctx
= NULL
;
2015 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2016 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2017 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2018 node
= lttng_ht_iter_get_node_ulong(&iter
);
2023 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2030 * Create a context for the channel on the tracer.
2032 * Called with UST app session lock held and a RCU read side lock.
2035 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2036 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2037 struct ust_app
*app
)
2040 struct ust_app_ctx
*ua_ctx
;
2042 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2044 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2050 ua_ctx
= alloc_ust_app_ctx(uctx
);
2051 if (ua_ctx
== NULL
) {
2057 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2058 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2059 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2061 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2071 * Enable on the tracer side a ust app event for the session and channel.
2073 * Called with UST app session lock held.
2076 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2077 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2081 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2086 ua_event
->enabled
= 1;
2093 * Disable on the tracer side a ust app event for the session and channel.
2095 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2096 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2100 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2105 ua_event
->enabled
= 0;
2112 * Lookup ust app channel for session and disable it on the tracer side.
2115 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2116 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2120 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2125 ua_chan
->enabled
= 0;
2132 * Lookup ust app channel for session and enable it on the tracer side. This
2133 * MUST be called with a RCU read side lock acquired.
2135 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2136 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2139 struct lttng_ht_iter iter
;
2140 struct lttng_ht_node_str
*ua_chan_node
;
2141 struct ust_app_channel
*ua_chan
;
2143 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2144 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2145 if (ua_chan_node
== NULL
) {
2146 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2147 uchan
->name
, ua_sess
->tracing_id
);
2151 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2153 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2163 * Ask the consumer to create a channel and get it if successful.
2165 * Return 0 on success or else a negative value.
2167 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2168 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2169 int bitness
, struct ust_registry_session
*registry
)
2172 unsigned int nb_fd
= 0;
2173 struct consumer_socket
*socket
;
2181 health_code_update();
2183 /* Get the right consumer socket for the application. */
2184 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2190 health_code_update();
2192 /* Need one fd for the channel. */
2193 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2195 ERR("Exhausted number of available FD upon create channel");
2200 * Ask consumer to create channel. The consumer will return the number of
2201 * stream we have to expect.
2203 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2210 * Compute the number of fd needed before receiving them. It must be 2 per
2211 * stream (2 being the default value here).
2213 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2215 /* Reserve the amount of file descriptor we need. */
2216 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2218 ERR("Exhausted number of available FD upon create channel");
2219 goto error_fd_get_stream
;
2222 health_code_update();
2225 * Now get the channel from the consumer. This call wil populate the stream
2226 * list of that channel and set the ust objects.
2228 if (usess
->consumer
->enabled
) {
2229 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2239 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2240 error_fd_get_stream
:
2242 * Initiate a destroy channel on the consumer since we had an error
2243 * handling it on our side. The return value is of no importance since we
2244 * already have a ret value set by the previous error that we need to
2247 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2249 lttng_fd_put(LTTNG_FD_APPS
, 1);
2251 health_code_update();
2257 * Duplicate the ust data object of the ust app stream and save it in the
2258 * buffer registry stream.
2260 * Return 0 on success or else a negative value.
2262 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2263 struct ust_app_stream
*stream
)
2270 /* Reserve the amount of file descriptor we need. */
2271 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2273 ERR("Exhausted number of available FD upon duplicate stream");
2277 /* Duplicate object for stream once the original is in the registry. */
2278 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2279 reg_stream
->obj
.ust
);
2281 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2282 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2283 lttng_fd_put(LTTNG_FD_APPS
, 2);
2286 stream
->handle
= stream
->obj
->handle
;
2293 * Duplicate the ust data object of the ust app. channel and save it in the
2294 * buffer registry channel.
2296 * Return 0 on success or else a negative value.
2298 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2299 struct ust_app_channel
*ua_chan
)
2306 /* Need two fds for the channel. */
2307 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2309 ERR("Exhausted number of available FD upon duplicate channel");
2313 /* Duplicate object for stream once the original is in the registry. */
2314 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2316 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2317 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2320 ua_chan
->handle
= ua_chan
->obj
->handle
;
2325 lttng_fd_put(LTTNG_FD_APPS
, 1);
2331 * For a given channel buffer registry, setup all streams of the given ust
2332 * application channel.
2334 * Return 0 on success or else a negative value.
2336 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2337 struct ust_app_channel
*ua_chan
)
2340 struct ust_app_stream
*stream
, *stmp
;
2345 DBG2("UST app setup buffer registry stream");
2347 /* Send all streams to application. */
2348 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2349 struct buffer_reg_stream
*reg_stream
;
2351 ret
= buffer_reg_stream_create(®_stream
);
2357 * Keep original pointer and nullify it in the stream so the delete
2358 * stream call does not release the object.
2360 reg_stream
->obj
.ust
= stream
->obj
;
2362 buffer_reg_stream_add(reg_stream
, reg_chan
);
2364 /* We don't need the streams anymore. */
2365 cds_list_del(&stream
->list
);
2366 delete_ust_app_stream(-1, stream
);
2374 * Create a buffer registry channel for the given session registry and
2375 * application channel object. If regp pointer is valid, it's set with the
2376 * created object. Important, the created object is NOT added to the session
2377 * registry hash table.
2379 * Return 0 on success else a negative value.
2381 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2382 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2385 struct buffer_reg_channel
*reg_chan
= NULL
;
2390 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2392 /* Create buffer registry channel. */
2393 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2398 reg_chan
->consumer_key
= ua_chan
->key
;
2399 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2400 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2402 /* Create and add a channel registry to session. */
2403 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2404 ua_chan
->tracing_channel_id
);
2408 buffer_reg_channel_add(reg_sess
, reg_chan
);
2417 /* Safe because the registry channel object was not added to any HT. */
2418 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2424 * Setup buffer registry channel for the given session registry and application
2425 * channel object. If regp pointer is valid, it's set with the created object.
2427 * Return 0 on success else a negative value.
2429 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2430 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2437 assert(ua_chan
->obj
);
2439 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2441 /* Setup all streams for the registry. */
2442 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2447 reg_chan
->obj
.ust
= ua_chan
->obj
;
2448 ua_chan
->obj
= NULL
;
2453 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2454 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2459 * Send buffer registry channel to the application.
2461 * Return 0 on success else a negative value.
2463 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2464 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2465 struct ust_app_channel
*ua_chan
)
2468 struct buffer_reg_stream
*reg_stream
;
2475 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2477 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2482 /* Send channel to the application. */
2483 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2488 health_code_update();
2490 /* Send all streams to application. */
2491 pthread_mutex_lock(®_chan
->stream_list_lock
);
2492 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2493 struct ust_app_stream stream
;
2495 ret
= duplicate_stream_object(reg_stream
, &stream
);
2497 goto error_stream_unlock
;
2500 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2502 (void) release_ust_app_stream(-1, &stream
);
2503 goto error_stream_unlock
;
2507 * The return value is not important here. This function will output an
2510 (void) release_ust_app_stream(-1, &stream
);
2512 ua_chan
->is_sent
= 1;
2514 error_stream_unlock
:
2515 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2521 * Create and send to the application the created buffers with per UID buffers.
2523 * Return 0 on success else a negative value.
2525 static int create_channel_per_uid(struct ust_app
*app
,
2526 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2527 struct ust_app_channel
*ua_chan
)
2530 struct buffer_reg_uid
*reg_uid
;
2531 struct buffer_reg_channel
*reg_chan
;
2538 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2540 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2542 * The session creation handles the creation of this global registry
2543 * object. If none can be find, there is a code flow problem or a
2548 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2551 /* Create the buffer registry channel object. */
2552 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2559 * Create the buffers on the consumer side. This call populates the
2560 * ust app channel object with all streams and data object.
2562 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2563 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2566 * Let's remove the previously created buffer registry channel so
2567 * it's not visible anymore in the session registry.
2569 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2570 ua_chan
->tracing_channel_id
);
2571 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2572 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2577 * Setup the streams and add it to the session registry.
2579 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2586 /* Send buffers to the application. */
2587 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2597 * Create and send to the application the created buffers with per PID buffers.
2599 * Return 0 on success else a negative value.
2601 static int create_channel_per_pid(struct ust_app
*app
,
2602 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2603 struct ust_app_channel
*ua_chan
)
2606 struct ust_registry_session
*registry
;
2613 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2617 registry
= get_session_registry(ua_sess
);
2620 /* Create and add a new channel registry to session. */
2621 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2626 /* Create and get channel on the consumer side. */
2627 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2628 app
->bits_per_long
, registry
);
2633 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2644 * From an already allocated ust app channel, create the channel buffers if
2645 * need and send it to the application. This MUST be called with a RCU read
2646 * side lock acquired.
2648 * Return 0 on success or else a negative value.
2650 static int do_create_channel(struct ust_app
*app
,
2651 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2652 struct ust_app_channel
*ua_chan
)
2661 /* Handle buffer type before sending the channel to the application. */
2662 switch (usess
->buffer_type
) {
2663 case LTTNG_BUFFER_PER_UID
:
2665 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2671 case LTTNG_BUFFER_PER_PID
:
2673 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2685 /* Initialize ust objd object using the received handle and add it. */
2686 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2687 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2689 /* If channel is not enabled, disable it on the tracer */
2690 if (!ua_chan
->enabled
) {
2691 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2702 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2703 * newly created channel if not NULL.
2705 * Called with UST app session lock and RCU read-side lock held.
2707 * Return 0 on success or else a negative value.
2709 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2710 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2711 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2712 struct ust_app_channel
**ua_chanp
)
2715 struct lttng_ht_iter iter
;
2716 struct lttng_ht_node_str
*ua_chan_node
;
2717 struct ust_app_channel
*ua_chan
;
2719 /* Lookup channel in the ust app session */
2720 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2721 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2722 if (ua_chan_node
!= NULL
) {
2723 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2727 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2728 if (ua_chan
== NULL
) {
2729 /* Only malloc can fail here */
2733 shadow_copy_channel(ua_chan
, uchan
);
2735 /* Set channel type. */
2736 ua_chan
->attr
.type
= type
;
2738 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2743 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2746 /* Only add the channel if successful on the tracer side. */
2747 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2751 *ua_chanp
= ua_chan
;
2754 /* Everything went well. */
2758 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2764 * Create UST app event and create it on the tracer side.
2766 * Called with ust app session mutex held.
2769 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2770 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2771 struct ust_app
*app
)
2774 struct ust_app_event
*ua_event
;
2776 /* Get event node */
2777 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2778 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2779 if (ua_event
!= NULL
) {
2784 /* Does not exist so create one */
2785 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2786 if (ua_event
== NULL
) {
2787 /* Only malloc can failed so something is really wrong */
2791 shadow_copy_event(ua_event
, uevent
);
2793 /* Create it on the tracer side */
2794 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2796 /* Not found previously means that it does not exist on the tracer */
2797 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2801 add_unique_ust_app_event(ua_chan
, ua_event
);
2803 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2810 /* Valid. Calling here is already in a read side lock */
2811 delete_ust_app_event(-1, ua_event
);
2816 * Create UST metadata and open it on the tracer side.
2818 * Called with UST app session lock held and RCU read side lock.
2820 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2821 struct ust_app
*app
, struct consumer_output
*consumer
)
2824 struct ust_app_channel
*metadata
;
2825 struct consumer_socket
*socket
;
2826 struct ust_registry_session
*registry
;
2832 registry
= get_session_registry(ua_sess
);
2835 pthread_mutex_lock(®istry
->lock
);
2837 /* Metadata already exists for this registry or it was closed previously */
2838 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2843 /* Allocate UST metadata */
2844 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2846 /* malloc() failed */
2851 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2853 /* Need one fd for the channel. */
2854 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2856 ERR("Exhausted number of available FD upon create metadata");
2860 /* Get the right consumer socket for the application. */
2861 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2864 goto error_consumer
;
2868 * Keep metadata key so we can identify it on the consumer side. Assign it
2869 * to the registry *before* we ask the consumer so we avoid the race of the
2870 * consumer requesting the metadata and the ask_channel call on our side
2871 * did not returned yet.
2873 registry
->metadata_key
= metadata
->key
;
2876 * Ask the metadata channel creation to the consumer. The metadata object
2877 * will be created by the consumer and kept their. However, the stream is
2878 * never added or monitored until we do a first push metadata to the
2881 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2884 /* Nullify the metadata key so we don't try to close it later on. */
2885 registry
->metadata_key
= 0;
2886 goto error_consumer
;
2890 * The setup command will make the metadata stream be sent to the relayd,
2891 * if applicable, and the thread managing the metadatas. This is important
2892 * because after this point, if an error occurs, the only way the stream
2893 * can be deleted is to be monitored in the consumer.
2895 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2897 /* Nullify the metadata key so we don't try to close it later on. */
2898 registry
->metadata_key
= 0;
2899 goto error_consumer
;
2902 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2903 metadata
->key
, app
->pid
);
2906 lttng_fd_put(LTTNG_FD_APPS
, 1);
2907 delete_ust_app_channel(-1, metadata
, app
);
2909 pthread_mutex_unlock(®istry
->lock
);
2914 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2915 * acquired before calling this function.
2917 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2919 struct ust_app
*app
= NULL
;
2920 struct lttng_ht_node_ulong
*node
;
2921 struct lttng_ht_iter iter
;
2923 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2924 node
= lttng_ht_iter_get_node_ulong(&iter
);
2926 DBG2("UST app no found with pid %d", pid
);
2930 DBG2("Found UST app by pid %d", pid
);
2932 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2939 * Allocate and init an UST app object using the registration information and
2940 * the command socket. This is called when the command socket connects to the
2943 * The object is returned on success or else NULL.
2945 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2947 struct ust_app
*lta
= NULL
;
2952 DBG3("UST app creating application for socket %d", sock
);
2954 if ((msg
->bits_per_long
== 64 &&
2955 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2956 || (msg
->bits_per_long
== 32 &&
2957 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2958 ERR("Registration failed: application \"%s\" (pid: %d) has "
2959 "%d-bit long, but no consumerd for this size is available.\n",
2960 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2964 lta
= zmalloc(sizeof(struct ust_app
));
2970 lta
->ppid
= msg
->ppid
;
2971 lta
->uid
= msg
->uid
;
2972 lta
->gid
= msg
->gid
;
2974 lta
->bits_per_long
= msg
->bits_per_long
;
2975 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2976 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2977 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2978 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2979 lta
->long_alignment
= msg
->long_alignment
;
2980 lta
->byte_order
= msg
->byte_order
;
2982 lta
->v_major
= msg
->major
;
2983 lta
->v_minor
= msg
->minor
;
2984 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2985 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2986 lta
->notify_sock
= -1;
2988 /* Copy name and make sure it's NULL terminated. */
2989 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2990 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2993 * Before this can be called, when receiving the registration information,
2994 * the application compatibility is checked. So, at this point, the
2995 * application can work with this session daemon.
2997 lta
->compatible
= 1;
2999 lta
->pid
= msg
->pid
;
3000 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3002 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3004 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3011 * For a given application object, add it to every hash table.
3013 void ust_app_add(struct ust_app
*app
)
3016 assert(app
->notify_sock
>= 0);
3021 * On a re-registration, we want to kick out the previous registration of
3024 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3027 * The socket _should_ be unique until _we_ call close. So, a add_unique
3028 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3029 * already in the table.
3031 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3033 /* Add application to the notify socket hash table. */
3034 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3035 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3037 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3038 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3039 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3046 * Set the application version into the object.
3048 * Return 0 on success else a negative value either an errno code or a
3049 * LTTng-UST error code.
3051 int ust_app_version(struct ust_app
*app
)
3057 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3059 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3060 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3062 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3070 * Unregister app by removing it from the global traceable app list and freeing
3073 * The socket is already closed at this point so no close to sock.
3075 void ust_app_unregister(int sock
)
3077 struct ust_app
*lta
;
3078 struct lttng_ht_node_ulong
*node
;
3079 struct lttng_ht_iter ust_app_sock_iter
;
3080 struct lttng_ht_iter iter
;
3081 struct ust_app_session
*ua_sess
;
3086 /* Get the node reference for a call_rcu */
3087 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3088 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3091 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3092 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3095 * For per-PID buffers, perform "push metadata" and flush all
3096 * application streams before removing app from hash tables,
3097 * ensuring proper behavior of data_pending check.
3098 * Remove sessions so they are not visible during deletion.
3100 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3102 struct ust_registry_session
*registry
;
3104 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3106 /* The session was already removed so scheduled for teardown. */
3110 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3111 (void) ust_app_flush_app_session(lta
, ua_sess
);
3115 * Add session to list for teardown. This is safe since at this point we
3116 * are the only one using this list.
3118 pthread_mutex_lock(&ua_sess
->lock
);
3121 * Normally, this is done in the delete session process which is
3122 * executed in the call rcu below. However, upon registration we can't
3123 * afford to wait for the grace period before pushing data or else the
3124 * data pending feature can race between the unregistration and stop
3125 * command where the data pending command is sent *before* the grace
3128 * The close metadata below nullifies the metadata pointer in the
3129 * session so the delete session will NOT push/close a second time.
3131 registry
= get_session_registry(ua_sess
);
3133 /* Push metadata for application before freeing the application. */
3134 (void) push_metadata(registry
, ua_sess
->consumer
);
3137 * Don't ask to close metadata for global per UID buffers. Close
3138 * metadata only on destroy trace session in this case. Also, the
3139 * previous push metadata could have flag the metadata registry to
3140 * close so don't send a close command if closed.
3142 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3143 /* And ask to close it for this session registry. */
3144 (void) close_metadata(registry
, ua_sess
->consumer
);
3147 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3149 pthread_mutex_unlock(&ua_sess
->lock
);
3152 /* Remove application from PID hash table */
3153 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3157 * Remove application from notify hash table. The thread handling the
3158 * notify socket could have deleted the node so ignore on error because
3159 * either way it's valid. The close of that socket is handled by the other
3162 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3163 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3166 * Ignore return value since the node might have been removed before by an
3167 * add replace during app registration because the PID can be reassigned by
3170 iter
.iter
.node
= <a
->pid_n
.node
;
3171 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3173 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3178 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3185 * Fill events array with all events name of all registered apps.
3187 int ust_app_list_events(struct lttng_event
**events
)
3190 size_t nbmem
, count
= 0;
3191 struct lttng_ht_iter iter
;
3192 struct ust_app
*app
;
3193 struct lttng_event
*tmp_event
;
3195 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3196 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3197 if (tmp_event
== NULL
) {
3198 PERROR("zmalloc ust app events");
3205 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3206 struct lttng_ust_tracepoint_iter uiter
;
3208 health_code_update();
3210 if (!app
->compatible
) {
3212 * TODO: In time, we should notice the caller of this error by
3213 * telling him that this is a version error.
3217 handle
= ustctl_tracepoint_list(app
->sock
);
3219 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3220 ERR("UST app list events getting handle failed for app pid %d",
3226 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3227 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3228 /* Handle ustctl error. */
3230 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3231 ERR("UST app tp list get failed for app %d with ret %d",
3234 DBG3("UST app tp list get failed. Application is dead");
3236 * This is normal behavior, an application can die during the
3237 * creation process. Don't report an error so the execution can
3238 * continue normally. Continue normal execution.
3246 health_code_update();
3247 if (count
>= nbmem
) {
3248 /* In case the realloc fails, we free the memory */
3249 struct lttng_event
*new_tmp_event
;
3252 new_nbmem
= nbmem
<< 1;
3253 DBG2("Reallocating event list from %zu to %zu entries",
3255 new_tmp_event
= realloc(tmp_event
,
3256 new_nbmem
* sizeof(struct lttng_event
));
3257 if (new_tmp_event
== NULL
) {
3258 PERROR("realloc ust app events");
3263 /* Zero the new memory */
3264 memset(new_tmp_event
+ nbmem
, 0,
3265 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3267 tmp_event
= new_tmp_event
;
3269 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3270 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3271 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3272 tmp_event
[count
].pid
= app
->pid
;
3273 tmp_event
[count
].enabled
= -1;
3279 *events
= tmp_event
;
3281 DBG2("UST app list events done (%zu events)", count
);
3286 health_code_update();
3291 * Fill events array with all events name of all registered apps.
3293 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3296 size_t nbmem
, count
= 0;
3297 struct lttng_ht_iter iter
;
3298 struct ust_app
*app
;
3299 struct lttng_event_field
*tmp_event
;
3301 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3302 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3303 if (tmp_event
== NULL
) {
3304 PERROR("zmalloc ust app event fields");
3311 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3312 struct lttng_ust_field_iter uiter
;
3314 health_code_update();
3316 if (!app
->compatible
) {
3318 * TODO: In time, we should notice the caller of this error by
3319 * telling him that this is a version error.
3323 handle
= ustctl_tracepoint_field_list(app
->sock
);
3325 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3326 ERR("UST app list field getting handle failed for app pid %d",
3332 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3333 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3334 /* Handle ustctl error. */
3336 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3337 ERR("UST app tp list field failed for app %d with ret %d",
3340 DBG3("UST app tp list field failed. Application is dead");
3342 * This is normal behavior, an application can die during the
3343 * creation process. Don't report an error so the execution can
3344 * continue normally. Reset list and count for next app.
3352 health_code_update();
3353 if (count
>= nbmem
) {
3354 /* In case the realloc fails, we free the memory */
3355 struct lttng_event_field
*new_tmp_event
;
3358 new_nbmem
= nbmem
<< 1;
3359 DBG2("Reallocating event field list from %zu to %zu entries",
3361 new_tmp_event
= realloc(tmp_event
,
3362 new_nbmem
* sizeof(struct lttng_event_field
));
3363 if (new_tmp_event
== NULL
) {
3364 PERROR("realloc ust app event fields");
3369 /* Zero the new memory */
3370 memset(new_tmp_event
+ nbmem
, 0,
3371 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3373 tmp_event
= new_tmp_event
;
3376 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3377 /* Mapping between these enums matches 1 to 1. */
3378 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3379 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3381 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3382 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3383 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3384 tmp_event
[count
].event
.pid
= app
->pid
;
3385 tmp_event
[count
].event
.enabled
= -1;
3391 *fields
= tmp_event
;
3393 DBG2("UST app list event fields done (%zu events)", count
);
3398 health_code_update();
3403 * Free and clean all traceable apps of the global list.
3405 * Should _NOT_ be called with RCU read-side lock held.
3407 void ust_app_clean_list(void)
3410 struct ust_app
*app
;
3411 struct lttng_ht_iter iter
;
3413 DBG2("UST app cleaning registered apps hash table");
3417 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3418 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3420 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3423 /* Cleanup socket hash table */
3424 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3426 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3430 /* Cleanup notify socket hash table */
3431 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3432 notify_sock_n
.node
) {
3433 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3438 /* Destroy is done only when the ht is empty */
3439 ht_cleanup_push(ust_app_ht
);
3440 ht_cleanup_push(ust_app_ht_by_sock
);
3441 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3445 * Init UST app hash table.
3447 void ust_app_ht_alloc(void)
3449 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3450 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3451 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3455 * For a specific UST session, disable the channel for all registered apps.
3457 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3458 struct ltt_ust_channel
*uchan
)
3461 struct lttng_ht_iter iter
;
3462 struct lttng_ht_node_str
*ua_chan_node
;
3463 struct ust_app
*app
;
3464 struct ust_app_session
*ua_sess
;
3465 struct ust_app_channel
*ua_chan
;
3467 if (usess
== NULL
|| uchan
== NULL
) {
3468 ERR("Disabling UST global channel with NULL values");
3473 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3474 uchan
->name
, usess
->id
);
3478 /* For every registered applications */
3479 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3480 struct lttng_ht_iter uiter
;
3481 if (!app
->compatible
) {
3483 * TODO: In time, we should notice the caller of this error by
3484 * telling him that this is a version error.
3488 ua_sess
= lookup_session_by_app(usess
, app
);
3489 if (ua_sess
== NULL
) {
3494 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3495 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3496 /* If the session if found for the app, the channel must be there */
3497 assert(ua_chan_node
);
3499 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3500 /* The channel must not be already disabled */
3501 assert(ua_chan
->enabled
== 1);
3503 /* Disable channel onto application */
3504 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3506 /* XXX: We might want to report this error at some point... */
3518 * For a specific UST session, enable the channel for all registered apps.
3520 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3521 struct ltt_ust_channel
*uchan
)
3524 struct lttng_ht_iter iter
;
3525 struct ust_app
*app
;
3526 struct ust_app_session
*ua_sess
;
3528 if (usess
== NULL
|| uchan
== NULL
) {
3529 ERR("Adding UST global channel to NULL values");
3534 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3535 uchan
->name
, usess
->id
);
3539 /* For every registered applications */
3540 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3541 if (!app
->compatible
) {
3543 * TODO: In time, we should notice the caller of this error by
3544 * telling him that this is a version error.
3548 ua_sess
= lookup_session_by_app(usess
, app
);
3549 if (ua_sess
== NULL
) {
3553 /* Enable channel onto application */
3554 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3556 /* XXX: We might want to report this error at some point... */
3568 * Disable an event in a channel and for a specific session.
3570 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3571 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3574 struct lttng_ht_iter iter
, uiter
;
3575 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3576 struct ust_app
*app
;
3577 struct ust_app_session
*ua_sess
;
3578 struct ust_app_channel
*ua_chan
;
3579 struct ust_app_event
*ua_event
;
3581 DBG("UST app disabling event %s for all apps in channel "
3582 "%s for session id %" PRIu64
,
3583 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3587 /* For all registered applications */
3588 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3589 if (!app
->compatible
) {
3591 * TODO: In time, we should notice the caller of this error by
3592 * telling him that this is a version error.
3596 ua_sess
= lookup_session_by_app(usess
, app
);
3597 if (ua_sess
== NULL
) {
3602 /* Lookup channel in the ust app session */
3603 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3604 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3605 if (ua_chan_node
== NULL
) {
3606 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3607 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3610 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3612 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3613 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3614 if (ua_event_node
== NULL
) {
3615 DBG2("Event %s not found in channel %s for app pid %d."
3616 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3619 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3621 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3623 /* XXX: Report error someday... */
3634 * For a specific UST session, create the channel for all registered apps.
3636 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3637 struct ltt_ust_channel
*uchan
)
3639 int ret
= 0, created
;
3640 struct lttng_ht_iter iter
;
3641 struct ust_app
*app
;
3642 struct ust_app_session
*ua_sess
= NULL
;
3644 /* Very wrong code flow */
3648 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3649 uchan
->name
, usess
->id
);
3653 /* For every registered applications */
3654 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3655 if (!app
->compatible
) {
3657 * TODO: In time, we should notice the caller of this error by
3658 * telling him that this is a version error.
3663 * Create session on the tracer side and add it to app session HT. Note
3664 * that if session exist, it will simply return a pointer to the ust
3667 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3672 * The application's socket is not valid. Either a bad socket
3673 * or a timeout on it. We can't inform the caller that for a
3674 * specific app, the session failed so lets continue here.
3679 goto error_rcu_unlock
;
3684 pthread_mutex_lock(&ua_sess
->lock
);
3685 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3686 sizeof(uchan
->name
))) {
3687 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3690 /* Create channel onto application. We don't need the chan ref. */
3691 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3692 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3694 pthread_mutex_unlock(&ua_sess
->lock
);
3696 if (ret
== -ENOMEM
) {
3697 /* No more memory is a fatal error. Stop right now. */
3698 goto error_rcu_unlock
;
3700 /* Cleanup the created session if it's the case. */
3702 destroy_app_session(app
, ua_sess
);
3713 * Enable event for a specific session and channel on the tracer.
3715 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3716 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3719 struct lttng_ht_iter iter
, uiter
;
3720 struct lttng_ht_node_str
*ua_chan_node
;
3721 struct ust_app
*app
;
3722 struct ust_app_session
*ua_sess
;
3723 struct ust_app_channel
*ua_chan
;
3724 struct ust_app_event
*ua_event
;
3726 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3727 uevent
->attr
.name
, usess
->id
);
3730 * NOTE: At this point, this function is called only if the session and
3731 * channel passed are already created for all apps. and enabled on the
3737 /* For all registered applications */
3738 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3739 if (!app
->compatible
) {
3741 * TODO: In time, we should notice the caller of this error by
3742 * telling him that this is a version error.
3746 ua_sess
= lookup_session_by_app(usess
, app
);
3748 /* The application has problem or is probably dead. */
3752 pthread_mutex_lock(&ua_sess
->lock
);
3754 /* Lookup channel in the ust app session */
3755 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3756 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3757 /* If the channel is not found, there is a code flow error */
3758 assert(ua_chan_node
);
3760 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3762 /* Get event node */
3763 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3764 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3765 if (ua_event
== NULL
) {
3766 DBG3("UST app enable event %s not found for app PID %d."
3767 "Skipping app", uevent
->attr
.name
, app
->pid
);
3771 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3773 pthread_mutex_unlock(&ua_sess
->lock
);
3777 pthread_mutex_unlock(&ua_sess
->lock
);
3786 * For a specific existing UST session and UST channel, creates the event for
3787 * all registered apps.
3789 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3790 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3793 struct lttng_ht_iter iter
, uiter
;
3794 struct lttng_ht_node_str
*ua_chan_node
;
3795 struct ust_app
*app
;
3796 struct ust_app_session
*ua_sess
;
3797 struct ust_app_channel
*ua_chan
;
3799 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3800 uevent
->attr
.name
, usess
->id
);
3804 /* For all registered applications */
3805 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3806 if (!app
->compatible
) {
3808 * TODO: In time, we should notice the caller of this error by
3809 * telling him that this is a version error.
3813 ua_sess
= lookup_session_by_app(usess
, app
);
3815 /* The application has problem or is probably dead. */
3819 pthread_mutex_lock(&ua_sess
->lock
);
3820 /* Lookup channel in the ust app session */
3821 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3822 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3823 /* If the channel is not found, there is a code flow error */
3824 assert(ua_chan_node
);
3826 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3828 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3829 pthread_mutex_unlock(&ua_sess
->lock
);
3831 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3832 /* Possible value at this point: -ENOMEM. If so, we stop! */
3835 DBG2("UST app event %s already exist on app PID %d",
3836 uevent
->attr
.name
, app
->pid
);
3847 * Start tracing for a specific UST session and app.
3850 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3853 struct ust_app_session
*ua_sess
;
3855 DBG("Starting tracing for ust app pid %d", app
->pid
);
3859 if (!app
->compatible
) {
3863 ua_sess
= lookup_session_by_app(usess
, app
);
3864 if (ua_sess
== NULL
) {
3865 /* The session is in teardown process. Ignore and continue. */
3869 pthread_mutex_lock(&ua_sess
->lock
);
3871 /* Upon restart, we skip the setup, already done */
3872 if (ua_sess
->started
) {
3876 /* Create directories if consumer is LOCAL and has a path defined. */
3877 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3878 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3879 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3880 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3882 if (ret
!= -EEXIST
) {
3883 ERR("Trace directory creation error");
3890 * Create the metadata for the application. This returns gracefully if a
3891 * metadata was already set for the session.
3893 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3898 health_code_update();
3901 /* This start the UST tracing */
3902 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3904 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3905 ERR("Error starting tracing for app pid: %d (ret: %d)",
3908 DBG("UST app start session failed. Application is dead.");
3910 * This is normal behavior, an application can die during the
3911 * creation process. Don't report an error so the execution can
3912 * continue normally.
3914 pthread_mutex_unlock(&ua_sess
->lock
);
3920 /* Indicate that the session has been started once */
3921 ua_sess
->started
= 1;
3923 pthread_mutex_unlock(&ua_sess
->lock
);
3925 health_code_update();
3927 /* Quiescent wait after starting trace */
3928 ret
= ustctl_wait_quiescent(app
->sock
);
3929 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3930 ERR("UST app wait quiescent failed for app pid %d ret %d",
3936 health_code_update();
3940 pthread_mutex_unlock(&ua_sess
->lock
);
3942 health_code_update();
3947 * Stop tracing for a specific UST session and app.
3950 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3953 struct ust_app_session
*ua_sess
;
3954 struct ust_registry_session
*registry
;
3956 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3960 if (!app
->compatible
) {
3961 goto end_no_session
;
3964 ua_sess
= lookup_session_by_app(usess
, app
);
3965 if (ua_sess
== NULL
) {
3966 goto end_no_session
;
3969 pthread_mutex_lock(&ua_sess
->lock
);
3972 * If started = 0, it means that stop trace has been called for a session
3973 * that was never started. It's possible since we can have a fail start
3974 * from either the application manager thread or the command thread. Simply
3975 * indicate that this is a stop error.
3977 if (!ua_sess
->started
) {
3978 goto error_rcu_unlock
;
3981 health_code_update();
3983 /* This inhibits UST tracing */
3984 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3986 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3987 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3990 DBG("UST app stop session failed. Application is dead.");
3992 * This is normal behavior, an application can die during the
3993 * creation process. Don't report an error so the execution can
3994 * continue normally.
3998 goto error_rcu_unlock
;
4001 health_code_update();
4003 /* Quiescent wait after stopping trace */
4004 ret
= ustctl_wait_quiescent(app
->sock
);
4005 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4006 ERR("UST app wait quiescent failed for app pid %d ret %d",
4010 health_code_update();
4012 registry
= get_session_registry(ua_sess
);
4015 /* Push metadata for application before freeing the application. */
4016 (void) push_metadata(registry
, ua_sess
->consumer
);
4019 pthread_mutex_unlock(&ua_sess
->lock
);
4022 health_code_update();
4026 pthread_mutex_unlock(&ua_sess
->lock
);
4028 health_code_update();
4033 int ust_app_flush_app_session(struct ust_app
*app
,
4034 struct ust_app_session
*ua_sess
)
4036 int ret
, retval
= 0;
4037 struct lttng_ht_iter iter
;
4038 struct ust_app_channel
*ua_chan
;
4039 struct consumer_socket
*socket
;
4041 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4045 if (!app
->compatible
) {
4046 goto end_not_compatible
;
4049 pthread_mutex_lock(&ua_sess
->lock
);
4051 health_code_update();
4053 /* Flushing buffers */
4054 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4057 /* Flush buffers and push metadata. */
4058 switch (ua_sess
->buffer_type
) {
4059 case LTTNG_BUFFER_PER_PID
:
4060 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4062 health_code_update();
4063 assert(ua_chan
->is_sent
);
4064 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4066 ERR("Error flushing consumer channel");
4072 case LTTNG_BUFFER_PER_UID
:
4078 health_code_update();
4080 pthread_mutex_unlock(&ua_sess
->lock
);
4084 health_code_update();
4089 * Flush buffers for all applications for a specific UST session.
4090 * Called with UST session lock held.
4093 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4098 DBG("Flushing session buffers for all ust apps");
4102 /* Flush buffers and push metadata. */
4103 switch (usess
->buffer_type
) {
4104 case LTTNG_BUFFER_PER_UID
:
4106 struct buffer_reg_uid
*reg
;
4107 struct lttng_ht_iter iter
;
4109 /* Flush all per UID buffers associated to that session. */
4110 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4111 struct ust_registry_session
*ust_session_reg
;
4112 struct buffer_reg_channel
*reg_chan
;
4113 struct consumer_socket
*socket
;
4115 /* Get consumer socket to use to push the metadata.*/
4116 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4119 /* Ignore request if no consumer is found for the session. */
4123 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4124 reg_chan
, node
.node
) {
4126 * The following call will print error values so the return
4127 * code is of little importance because whatever happens, we
4128 * have to try them all.
4130 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4133 ust_session_reg
= reg
->registry
->reg
.ust
;
4134 /* Push metadata. */
4135 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4139 case LTTNG_BUFFER_PER_PID
:
4141 struct ust_app_session
*ua_sess
;
4142 struct lttng_ht_iter iter
;
4143 struct ust_app
*app
;
4145 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4146 ua_sess
= lookup_session_by_app(usess
, app
);
4147 if (ua_sess
== NULL
) {
4150 (void) ust_app_flush_app_session(app
, ua_sess
);
4161 health_code_update();
4166 * Destroy a specific UST session in apps.
4168 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4171 struct ust_app_session
*ua_sess
;
4172 struct lttng_ht_iter iter
;
4173 struct lttng_ht_node_u64
*node
;
4175 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4179 if (!app
->compatible
) {
4183 __lookup_session_by_app(usess
, app
, &iter
);
4184 node
= lttng_ht_iter_get_node_u64(&iter
);
4186 /* Session is being or is deleted. */
4189 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4191 health_code_update();
4192 destroy_app_session(app
, ua_sess
);
4194 health_code_update();
4196 /* Quiescent wait after stopping trace */
4197 ret
= ustctl_wait_quiescent(app
->sock
);
4198 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4199 ERR("UST app wait quiescent failed for app pid %d ret %d",
4204 health_code_update();
4209 * Start tracing for the UST session.
4211 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4214 struct lttng_ht_iter iter
;
4215 struct ust_app
*app
;
4217 DBG("Starting all UST traces");
4221 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4222 ret
= ust_app_start_trace(usess
, app
);
4224 /* Continue to next apps even on error */
4235 * Start tracing for the UST session.
4236 * Called with UST session lock held.
4238 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4241 struct lttng_ht_iter iter
;
4242 struct ust_app
*app
;
4244 DBG("Stopping all UST traces");
4248 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4249 ret
= ust_app_stop_trace(usess
, app
);
4251 /* Continue to next apps even on error */
4256 (void) ust_app_flush_session(usess
);
4264 * Destroy app UST session.
4266 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4269 struct lttng_ht_iter iter
;
4270 struct ust_app
*app
;
4272 DBG("Destroy all UST traces");
4276 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4277 ret
= destroy_trace(usess
, app
);
4279 /* Continue to next apps even on error */
4290 * Add channels/events from UST global domain to registered apps at sock.
4292 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4295 struct lttng_ht_iter iter
, uiter
;
4296 struct ust_app
*app
;
4297 struct ust_app_session
*ua_sess
= NULL
;
4298 struct ust_app_channel
*ua_chan
;
4299 struct ust_app_event
*ua_event
;
4300 struct ust_app_ctx
*ua_ctx
;
4305 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4310 app
= ust_app_find_by_sock(sock
);
4313 * Application can be unregistered before so this is possible hence
4314 * simply stopping the update.
4316 DBG3("UST app update failed to find app sock %d", sock
);
4320 if (!app
->compatible
) {
4324 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4326 /* Tracer is probably gone or ENOMEM. */
4331 pthread_mutex_lock(&ua_sess
->lock
);
4334 * We can iterate safely here over all UST app session since the create ust
4335 * app session above made a shadow copy of the UST global domain from the
4338 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4340 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4343 * Stop everything. On error, the application failed, no more
4344 * file descriptor are available or ENOMEM so stopping here is
4345 * the only thing we can do for now.
4351 * Add context using the list so they are enabled in the same order the
4354 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4355 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4362 /* For each events */
4363 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4365 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4372 pthread_mutex_unlock(&ua_sess
->lock
);
4374 if (usess
->active
) {
4375 ret
= ust_app_start_trace(usess
, app
);
4380 DBG2("UST trace started for app pid %d", app
->pid
);
4383 /* Everything went well at this point. */
4388 pthread_mutex_unlock(&ua_sess
->lock
);
4391 destroy_app_session(app
, ua_sess
);
4398 * Add context to a specific channel for global UST domain.
4400 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4401 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4404 struct lttng_ht_node_str
*ua_chan_node
;
4405 struct lttng_ht_iter iter
, uiter
;
4406 struct ust_app_channel
*ua_chan
= NULL
;
4407 struct ust_app_session
*ua_sess
;
4408 struct ust_app
*app
;
4412 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4413 if (!app
->compatible
) {
4415 * TODO: In time, we should notice the caller of this error by
4416 * telling him that this is a version error.
4420 ua_sess
= lookup_session_by_app(usess
, app
);
4421 if (ua_sess
== NULL
) {
4425 pthread_mutex_lock(&ua_sess
->lock
);
4426 /* Lookup channel in the ust app session */
4427 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4428 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4429 if (ua_chan_node
== NULL
) {
4432 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4434 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4439 pthread_mutex_unlock(&ua_sess
->lock
);
4447 * Enable event for a channel from a UST session for a specific PID.
4449 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4450 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4453 struct lttng_ht_iter iter
;
4454 struct lttng_ht_node_str
*ua_chan_node
;
4455 struct ust_app
*app
;
4456 struct ust_app_session
*ua_sess
;
4457 struct ust_app_channel
*ua_chan
;
4458 struct ust_app_event
*ua_event
;
4460 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4464 app
= ust_app_find_by_pid(pid
);
4466 ERR("UST app enable event per PID %d not found", pid
);
4471 if (!app
->compatible
) {
4476 ua_sess
= lookup_session_by_app(usess
, app
);
4478 /* The application has problem or is probably dead. */
4483 pthread_mutex_lock(&ua_sess
->lock
);
4484 /* Lookup channel in the ust app session */
4485 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4486 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4487 /* If the channel is not found, there is a code flow error */
4488 assert(ua_chan_node
);
4490 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4492 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4493 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4494 if (ua_event
== NULL
) {
4495 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4500 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4507 pthread_mutex_unlock(&ua_sess
->lock
);
4514 * Calibrate registered applications.
4516 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4519 struct lttng_ht_iter iter
;
4520 struct ust_app
*app
;
4524 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4525 if (!app
->compatible
) {
4527 * TODO: In time, we should notice the caller of this error by
4528 * telling him that this is a version error.
4533 health_code_update();
4535 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4539 /* Means that it's not implemented on the tracer side. */
4543 DBG2("Calibrate app PID %d returned with error %d",
4550 DBG("UST app global domain calibration finished");
4554 health_code_update();
4560 * Receive registration and populate the given msg structure.
4562 * On success return 0 else a negative value returned by the ustctl call.
4564 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4567 uint32_t pid
, ppid
, uid
, gid
;
4571 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4572 &pid
, &ppid
, &uid
, &gid
,
4573 &msg
->bits_per_long
,
4574 &msg
->uint8_t_alignment
,
4575 &msg
->uint16_t_alignment
,
4576 &msg
->uint32_t_alignment
,
4577 &msg
->uint64_t_alignment
,
4578 &msg
->long_alignment
,
4585 case LTTNG_UST_ERR_EXITING
:
4586 DBG3("UST app recv reg message failed. Application died");
4588 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4589 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4590 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4591 LTTNG_UST_ABI_MINOR_VERSION
);
4594 ERR("UST app recv reg message failed with ret %d", ret
);
4599 msg
->pid
= (pid_t
) pid
;
4600 msg
->ppid
= (pid_t
) ppid
;
4601 msg
->uid
= (uid_t
) uid
;
4602 msg
->gid
= (gid_t
) gid
;
4609 * Return a ust app channel object using the application object and the channel
4610 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4611 * lock MUST be acquired before calling this function.
4613 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4616 struct lttng_ht_node_ulong
*node
;
4617 struct lttng_ht_iter iter
;
4618 struct ust_app_channel
*ua_chan
= NULL
;
4622 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4623 node
= lttng_ht_iter_get_node_ulong(&iter
);
4625 DBG2("UST app channel find by objd %d not found", objd
);
4629 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4636 * Reply to a register channel notification from an application on the notify
4637 * socket. The channel metadata is also created.
4639 * The session UST registry lock is acquired in this function.
4641 * On success 0 is returned else a negative value.
4643 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4644 size_t nr_fields
, struct ustctl_field
*fields
)
4646 int ret
, ret_code
= 0;
4647 uint32_t chan_id
, reg_count
;
4648 uint64_t chan_reg_key
;
4649 enum ustctl_channel_header type
;
4650 struct ust_app
*app
;
4651 struct ust_app_channel
*ua_chan
;
4652 struct ust_app_session
*ua_sess
;
4653 struct ust_registry_session
*registry
;
4654 struct ust_registry_channel
*chan_reg
;
4658 /* Lookup application. If not found, there is a code flow error. */
4659 app
= find_app_by_notify_sock(sock
);
4661 DBG("Application socket %d is being teardown. Abort event notify",
4665 goto error_rcu_unlock
;
4668 /* Lookup channel by UST object descriptor. */
4669 ua_chan
= find_channel_by_objd(app
, cobjd
);
4671 DBG("Application channel is being teardown. Abort event notify");
4674 goto error_rcu_unlock
;
4677 assert(ua_chan
->session
);
4678 ua_sess
= ua_chan
->session
;
4680 /* Get right session registry depending on the session buffer type. */
4681 registry
= get_session_registry(ua_sess
);
4684 /* Depending on the buffer type, a different channel key is used. */
4685 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4686 chan_reg_key
= ua_chan
->tracing_channel_id
;
4688 chan_reg_key
= ua_chan
->key
;
4691 pthread_mutex_lock(®istry
->lock
);
4693 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4696 if (!chan_reg
->register_done
) {
4697 reg_count
= ust_registry_get_event_count(chan_reg
);
4698 if (reg_count
< 31) {
4699 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4701 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4704 chan_reg
->nr_ctx_fields
= nr_fields
;
4705 chan_reg
->ctx_fields
= fields
;
4706 chan_reg
->header_type
= type
;
4708 /* Get current already assigned values. */
4709 type
= chan_reg
->header_type
;
4711 /* Set to NULL so the error path does not do a double free. */
4714 /* Channel id is set during the object creation. */
4715 chan_id
= chan_reg
->chan_id
;
4717 /* Append to metadata */
4718 if (!chan_reg
->metadata_dumped
) {
4719 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4721 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4727 DBG3("UST app replying to register channel key %" PRIu64
4728 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4731 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4733 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4734 ERR("UST app reply channel failed with ret %d", ret
);
4736 DBG3("UST app reply channel failed. Application died");
4741 /* This channel registry registration is completed. */
4742 chan_reg
->register_done
= 1;
4745 pthread_mutex_unlock(®istry
->lock
);
4755 * Add event to the UST channel registry. When the event is added to the
4756 * registry, the metadata is also created. Once done, this replies to the
4757 * application with the appropriate error code.
4759 * The session UST registry lock is acquired in the function.
4761 * On success 0 is returned else a negative value.
4763 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4764 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4765 char *model_emf_uri
)
4768 uint32_t event_id
= 0;
4769 uint64_t chan_reg_key
;
4770 struct ust_app
*app
;
4771 struct ust_app_channel
*ua_chan
;
4772 struct ust_app_session
*ua_sess
;
4773 struct ust_registry_session
*registry
;
4777 /* Lookup application. If not found, there is a code flow error. */
4778 app
= find_app_by_notify_sock(sock
);
4780 DBG("Application socket %d is being teardown. Abort event notify",
4785 free(model_emf_uri
);
4786 goto error_rcu_unlock
;
4789 /* Lookup channel by UST object descriptor. */
4790 ua_chan
= find_channel_by_objd(app
, cobjd
);
4792 DBG("Application channel is being teardown. Abort event notify");
4796 free(model_emf_uri
);
4797 goto error_rcu_unlock
;
4800 assert(ua_chan
->session
);
4801 ua_sess
= ua_chan
->session
;
4803 registry
= get_session_registry(ua_sess
);
4806 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4807 chan_reg_key
= ua_chan
->tracing_channel_id
;
4809 chan_reg_key
= ua_chan
->key
;
4812 pthread_mutex_lock(®istry
->lock
);
4815 * From this point on, this call acquires the ownership of the sig, fields
4816 * and model_emf_uri meaning any free are done inside it if needed. These
4817 * three variables MUST NOT be read/write after this.
4819 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4820 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4821 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4825 * The return value is returned to ustctl so in case of an error, the
4826 * application can be notified. In case of an error, it's important not to
4827 * return a negative error or else the application will get closed.
4829 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4831 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4832 ERR("UST app reply event failed with ret %d", ret
);
4834 DBG3("UST app reply event failed. Application died");
4837 * No need to wipe the create event since the application socket will
4838 * get close on error hence cleaning up everything by itself.
4843 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4847 pthread_mutex_unlock(®istry
->lock
);
4854 * Handle application notification through the given notify socket.
4856 * Return 0 on success or else a negative value.
4858 int ust_app_recv_notify(int sock
)
4861 enum ustctl_notify_cmd cmd
;
4863 DBG3("UST app receiving notify from sock %d", sock
);
4865 ret
= ustctl_recv_notify(sock
, &cmd
);
4867 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4868 ERR("UST app recv notify failed with ret %d", ret
);
4870 DBG3("UST app recv notify failed. Application died");
4876 case USTCTL_NOTIFY_CMD_EVENT
:
4878 int sobjd
, cobjd
, loglevel
;
4879 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4881 struct ustctl_field
*fields
;
4883 DBG2("UST app ustctl register event received");
4885 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4886 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4888 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4889 ERR("UST app recv event failed with ret %d", ret
);
4891 DBG3("UST app recv event failed. Application died");
4897 * Add event to the UST registry coming from the notify socket. This
4898 * call will free if needed the sig, fields and model_emf_uri. This
4899 * code path loses the ownsership of these variables and transfer them
4900 * to the this function.
4902 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4903 fields
, loglevel
, model_emf_uri
);
4910 case USTCTL_NOTIFY_CMD_CHANNEL
:
4914 struct ustctl_field
*fields
;
4916 DBG2("UST app ustctl register channel received");
4918 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4921 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4922 ERR("UST app recv channel failed with ret %d", ret
);
4924 DBG3("UST app recv channel failed. Application died");
4930 * The fields ownership are transfered to this function call meaning
4931 * that if needed it will be freed. After this, it's invalid to access
4932 * fields or clean it up.
4934 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4943 /* Should NEVER happen. */
4952 * Once the notify socket hangs up, this is called. First, it tries to find the
4953 * corresponding application. On failure, the call_rcu to close the socket is
4954 * executed. If an application is found, it tries to delete it from the notify
4955 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4957 * Note that an object needs to be allocated here so on ENOMEM failure, the
4958 * call RCU is not done but the rest of the cleanup is.
4960 void ust_app_notify_sock_unregister(int sock
)
4963 struct lttng_ht_iter iter
;
4964 struct ust_app
*app
;
4965 struct ust_app_notify_sock_obj
*obj
;
4971 obj
= zmalloc(sizeof(*obj
));
4974 * An ENOMEM is kind of uncool. If this strikes we continue the
4975 * procedure but the call_rcu will not be called. In this case, we
4976 * accept the fd leak rather than possibly creating an unsynchronized
4977 * state between threads.
4979 * TODO: The notify object should be created once the notify socket is
4980 * registered and stored independantely from the ust app object. The
4981 * tricky part is to synchronize the teardown of the application and
4982 * this notify object. Let's keep that in mind so we can avoid this
4983 * kind of shenanigans with ENOMEM in the teardown path.
4990 DBG("UST app notify socket unregister %d", sock
);
4993 * Lookup application by notify socket. If this fails, this means that the
4994 * hash table delete has already been done by the application
4995 * unregistration process so we can safely close the notify socket in a
4998 app
= find_app_by_notify_sock(sock
);
5003 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5006 * Whatever happens here either we fail or succeed, in both cases we have
5007 * to close the socket after a grace period to continue to the call RCU
5008 * here. If the deletion is successful, the application is not visible
5009 * anymore by other threads and is it fails it means that it was already
5010 * deleted from the hash table so either way we just have to close the
5013 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5019 * Close socket after a grace period to avoid for the socket to be reused
5020 * before the application object is freed creating potential race between
5021 * threads trying to add unique in the global hash table.
5024 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5029 * Destroy a ust app data structure and free its memory.
5031 void ust_app_destroy(struct ust_app
*app
)
5037 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5041 * Take a snapshot for a given UST session. The snapshot is sent to the given
5044 * Return 0 on success or else a negative value.
5046 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5047 struct snapshot_output
*output
, int wait
,
5048 uint64_t nb_packets_per_stream
)
5051 unsigned int snapshot_done
= 0;
5052 struct lttng_ht_iter iter
;
5053 struct ust_app
*app
;
5054 char pathname
[PATH_MAX
];
5061 switch (usess
->buffer_type
) {
5062 case LTTNG_BUFFER_PER_UID
:
5064 struct buffer_reg_uid
*reg
;
5066 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5067 struct buffer_reg_channel
*reg_chan
;
5068 struct consumer_socket
*socket
;
5070 /* Get consumer socket to use to push the metadata.*/
5071 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5078 memset(pathname
, 0, sizeof(pathname
));
5079 ret
= snprintf(pathname
, sizeof(pathname
),
5080 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5081 reg
->uid
, reg
->bits_per_long
);
5083 PERROR("snprintf snapshot path");
5087 /* Add the UST default trace dir to path. */
5088 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5089 reg_chan
, node
.node
) {
5090 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5091 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5092 nb_packets_per_stream
);
5097 ret
= consumer_snapshot_channel(socket
,
5098 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5099 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5107 case LTTNG_BUFFER_PER_PID
:
5109 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5110 struct consumer_socket
*socket
;
5111 struct lttng_ht_iter chan_iter
;
5112 struct ust_app_channel
*ua_chan
;
5113 struct ust_app_session
*ua_sess
;
5114 struct ust_registry_session
*registry
;
5116 ua_sess
= lookup_session_by_app(usess
, app
);
5118 /* Session not associated with this app. */
5122 /* Get the right consumer socket for the application. */
5123 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5130 /* Add the UST default trace dir to path. */
5131 memset(pathname
, 0, sizeof(pathname
));
5132 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5135 PERROR("snprintf snapshot path");
5139 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5140 ua_chan
, node
.node
) {
5141 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5142 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5143 nb_packets_per_stream
);
5149 registry
= get_session_registry(ua_sess
);
5151 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5152 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5165 if (!snapshot_done
) {
5167 * If no snapshot was made and we are not in the error path, this means
5168 * that there are no buffers thus no (prior) application to snapshot
5169 * data from so we have simply NO data.
5180 * Return the size taken by one more packet per stream.
5182 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5183 uint64_t cur_nr_packets
)
5185 uint64_t tot_size
= 0;
5186 struct ust_app
*app
;
5187 struct lttng_ht_iter iter
;
5191 switch (usess
->buffer_type
) {
5192 case LTTNG_BUFFER_PER_UID
:
5194 struct buffer_reg_uid
*reg
;
5196 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5197 struct buffer_reg_channel
*reg_chan
;
5200 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5201 reg_chan
, node
.node
) {
5202 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5204 * Don't take channel into account if we
5205 * already grab all its packets.
5209 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5215 case LTTNG_BUFFER_PER_PID
:
5218 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5219 struct ust_app_channel
*ua_chan
;
5220 struct ust_app_session
*ua_sess
;
5221 struct lttng_ht_iter chan_iter
;
5223 ua_sess
= lookup_session_by_app(usess
, app
);
5225 /* Session not associated with this app. */
5229 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5230 ua_chan
, node
.node
) {
5231 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5233 * Don't take channel into account if we
5234 * already grab all its packets.
5238 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;