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.
27 #include <sys/types.h>
29 #include <urcu/compiler.h>
30 #include <lttng/ust-error.h>
33 #include <common/common.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
36 #include "buffer-registry.h"
38 #include "health-sessiond.h"
40 #include "ust-consumer.h"
45 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
47 /* Next available channel key. Access under next_channel_key_lock. */
48 static uint64_t _next_channel_key
;
49 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 /* Next available session ID. Access under next_session_id_lock. */
52 static uint64_t _next_session_id
;
53 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
56 * Return the incremented value of next_channel_key.
58 static uint64_t get_next_channel_key(void)
62 pthread_mutex_lock(&next_channel_key_lock
);
63 ret
= ++_next_channel_key
;
64 pthread_mutex_unlock(&next_channel_key_lock
);
69 * Return the atomically incremented value of next_session_id.
71 static uint64_t get_next_session_id(void)
75 pthread_mutex_lock(&next_session_id_lock
);
76 ret
= ++_next_session_id
;
77 pthread_mutex_unlock(&next_session_id_lock
);
81 static void copy_channel_attr_to_ustctl(
82 struct ustctl_consumer_channel_attr
*attr
,
83 struct lttng_ust_channel_attr
*uattr
)
85 /* Copy event attributes since the layout is different. */
86 attr
->subbuf_size
= uattr
->subbuf_size
;
87 attr
->num_subbuf
= uattr
->num_subbuf
;
88 attr
->overwrite
= uattr
->overwrite
;
89 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
90 attr
->read_timer_interval
= uattr
->read_timer_interval
;
91 attr
->output
= uattr
->output
;
95 * Match function for the hash table lookup.
97 * It matches an ust app event based on three attributes which are the event
98 * name, the filter bytecode and the loglevel.
100 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
102 struct ust_app_event
*event
;
103 const struct ust_app_ht_key
*key
;
108 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
111 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
114 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
118 /* Event loglevel. */
119 if (event
->attr
.loglevel
!= key
->loglevel
) {
120 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
121 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
123 * Match is accepted. This is because on event creation, the
124 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
125 * -1 are accepted for this loglevel type since 0 is the one set by
126 * the API when receiving an enable event.
133 /* One of the filters is NULL, fail. */
134 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
138 if (key
->filter
&& event
->filter
) {
139 /* Both filters exists, check length followed by the bytecode. */
140 if (event
->filter
->len
!= key
->filter
->len
||
141 memcmp(event
->filter
->data
, key
->filter
->data
,
142 event
->filter
->len
) != 0) {
147 /* One of the exclusions is NULL, fail. */
148 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
152 if (key
->exclusion
&& event
->exclusion
) {
153 /* Both exclusions exists, check count followed by the names. */
154 if (event
->exclusion
->count
!= key
->exclusion
->count
||
155 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
156 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
170 * Unique add of an ust app event in the given ht. This uses the custom
171 * ht_match_ust_app_event match function and the event name as hash.
173 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
174 struct ust_app_event
*event
)
176 struct cds_lfht_node
*node_ptr
;
177 struct ust_app_ht_key key
;
181 assert(ua_chan
->events
);
184 ht
= ua_chan
->events
;
185 key
.name
= event
->attr
.name
;
186 key
.filter
= event
->filter
;
187 key
.loglevel
= event
->attr
.loglevel
;
188 key
.exclusion
= event
->exclusion
;
190 node_ptr
= cds_lfht_add_unique(ht
->ht
,
191 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
192 ht_match_ust_app_event
, &key
, &event
->node
.node
);
193 assert(node_ptr
== &event
->node
.node
);
197 * Close the notify socket from the given RCU head object. This MUST be called
198 * through a call_rcu().
200 static void close_notify_sock_rcu(struct rcu_head
*head
)
203 struct ust_app_notify_sock_obj
*obj
=
204 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
206 /* Must have a valid fd here. */
207 assert(obj
->fd
>= 0);
209 ret
= close(obj
->fd
);
211 ERR("close notify sock %d RCU", obj
->fd
);
213 lttng_fd_put(LTTNG_FD_APPS
, 1);
219 * Return the session registry according to the buffer type of the given
222 * A registry per UID object MUST exists before calling this function or else
223 * it assert() if not found. RCU read side lock must be acquired.
225 static struct ust_registry_session
*get_session_registry(
226 struct ust_app_session
*ua_sess
)
228 struct ust_registry_session
*registry
= NULL
;
232 switch (ua_sess
->buffer_type
) {
233 case LTTNG_BUFFER_PER_PID
:
235 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
239 registry
= reg_pid
->registry
->reg
.ust
;
242 case LTTNG_BUFFER_PER_UID
:
244 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
245 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
249 registry
= reg_uid
->registry
->reg
.ust
;
261 * Delete ust context safely. RCU read lock must be held before calling
265 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
272 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
273 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
274 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
275 sock
, ua_ctx
->obj
->handle
, ret
);
283 * Delete ust app event safely. RCU read lock must be held before calling
287 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
293 free(ua_event
->filter
);
294 if (ua_event
->exclusion
!= NULL
)
295 free(ua_event
->exclusion
);
296 if (ua_event
->obj
!= NULL
) {
297 ret
= ustctl_release_object(sock
, ua_event
->obj
);
298 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
299 ERR("UST app sock %d release event obj failed with ret %d",
308 * Release ust data object of the given stream.
310 * Return 0 on success or else a negative value.
312 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 ret
= ustctl_release_object(sock
, stream
->obj
);
320 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
321 ERR("UST app sock %d release stream obj failed with ret %d",
324 lttng_fd_put(LTTNG_FD_APPS
, 2);
332 * Delete ust app stream safely. RCU read lock must be held before calling
336 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
340 (void) release_ust_app_stream(sock
, stream
);
345 * We need to execute ht_destroy outside of RCU read-side critical
346 * section and outside of call_rcu thread, so we postpone its execution
347 * using ht_cleanup_push. It is simpler than to change the semantic of
348 * the many callers of delete_ust_app_session().
351 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
353 struct ust_app_channel
*ua_chan
=
354 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
356 ht_cleanup_push(ua_chan
->ctx
);
357 ht_cleanup_push(ua_chan
->events
);
362 * Delete ust app channel safely. RCU read lock must be held before calling
366 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
370 struct lttng_ht_iter iter
;
371 struct ust_app_event
*ua_event
;
372 struct ust_app_ctx
*ua_ctx
;
373 struct ust_app_stream
*stream
, *stmp
;
374 struct ust_registry_session
*registry
;
378 DBG3("UST app deleting channel %s", ua_chan
->name
);
381 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
382 cds_list_del(&stream
->list
);
383 delete_ust_app_stream(sock
, stream
);
387 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
388 cds_list_del(&ua_ctx
->list
);
389 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
391 delete_ust_app_ctx(sock
, ua_ctx
);
395 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
397 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
399 delete_ust_app_event(sock
, ua_event
);
402 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
403 /* Wipe and free registry from session registry. */
404 registry
= get_session_registry(ua_chan
->session
);
406 ust_registry_channel_del_free(registry
, ua_chan
->key
);
410 if (ua_chan
->obj
!= NULL
) {
411 /* Remove channel from application UST object descriptor. */
412 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
413 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
415 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
416 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
417 ERR("UST app sock %d release channel obj failed with ret %d",
420 lttng_fd_put(LTTNG_FD_APPS
, 1);
423 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
427 * Push metadata to consumer socket.
429 * RCU read-side lock must be held to guarantee existance of socket.
430 * Must be called with the ust app session lock held.
431 * Must be called with the registry lock held.
433 * On success, return the len of metadata pushed or else a negative value.
435 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
436 struct consumer_socket
*socket
, int send_zero_data
)
439 char *metadata_str
= NULL
;
447 * Means that no metadata was assigned to the session. This can
448 * happens if no start has been done previously.
450 if (!registry
->metadata_key
) {
455 * On a push metadata error either the consumer is dead or the
456 * metadata channel has been destroyed because its endpoint
457 * might have died (e.g: relayd). If so, the metadata closed
458 * flag is set to 1 so we deny pushing metadata again which is
459 * not valid anymore on the consumer side.
461 if (registry
->metadata_closed
) {
465 offset
= registry
->metadata_len_sent
;
466 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
468 DBG3("No metadata to push for metadata key %" PRIu64
,
469 registry
->metadata_key
);
471 if (send_zero_data
) {
472 DBG("No metadata to push");
478 /* Allocate only what we have to send. */
479 metadata_str
= zmalloc(len
);
481 PERROR("zmalloc ust app metadata string");
485 /* Copy what we haven't send out. */
486 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
487 registry
->metadata_len_sent
+= len
;
490 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
491 metadata_str
, len
, offset
);
494 * There is an acceptable race here between the registry
495 * metadata key assignment and the creation on the
496 * consumer. The session daemon can concurrently push
497 * metadata for this registry while being created on the
498 * consumer since the metadata key of the registry is
499 * assigned *before* it is setup to avoid the consumer
500 * to ask for metadata that could possibly be not found
501 * in the session daemon.
503 * The metadata will get pushed either by the session
504 * being stopped or the consumer requesting metadata if
505 * that race is triggered.
507 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
512 * Update back the actual metadata len sent since it
515 registry
->metadata_len_sent
-= len
;
527 * On error, flag the registry that the metadata is
528 * closed. We were unable to push anything and this
529 * means that either the consumer is not responding or
530 * the metadata cache has been destroyed on the
533 registry
->metadata_closed
= 1;
541 * For a given application and session, push metadata to consumer.
542 * Either sock or consumer is required : if sock is NULL, the default
543 * socket to send the metadata is retrieved from consumer, if sock
544 * is not NULL we use it to send the metadata.
545 * RCU read-side lock must be held while calling this function,
546 * therefore ensuring existance of registry. It also ensures existance
547 * of socket throughout this function.
549 * Return 0 on success else a negative error.
551 static int push_metadata(struct ust_registry_session
*registry
,
552 struct consumer_output
*consumer
)
556 struct consumer_socket
*socket
;
561 pthread_mutex_lock(®istry
->lock
);
562 if (registry
->metadata_closed
) {
567 /* Get consumer socket to use to push the metadata.*/
568 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
575 ret
= ust_app_push_metadata(registry
, socket
, 0);
580 pthread_mutex_unlock(®istry
->lock
);
584 pthread_mutex_unlock(®istry
->lock
);
589 * Send to the consumer a close metadata command for the given session. Once
590 * done, the metadata channel is deleted and the session metadata pointer is
591 * nullified. The session lock MUST be held unless the application is
592 * in the destroy path.
594 * Return 0 on success else a negative value.
596 static int close_metadata(struct ust_registry_session
*registry
,
597 struct consumer_output
*consumer
)
600 struct consumer_socket
*socket
;
607 pthread_mutex_lock(®istry
->lock
);
609 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
614 /* Get consumer socket to use to push the metadata.*/
615 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
622 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
629 * Metadata closed. Even on error this means that the consumer is not
630 * responding or not found so either way a second close should NOT be emit
633 registry
->metadata_closed
= 1;
635 pthread_mutex_unlock(®istry
->lock
);
641 * We need to execute ht_destroy outside of RCU read-side critical
642 * section and outside of call_rcu thread, so we postpone its execution
643 * using ht_cleanup_push. It is simpler than to change the semantic of
644 * the many callers of delete_ust_app_session().
647 void delete_ust_app_session_rcu(struct rcu_head
*head
)
649 struct ust_app_session
*ua_sess
=
650 caa_container_of(head
, struct ust_app_session
, rcu_head
);
652 ht_cleanup_push(ua_sess
->channels
);
657 * Delete ust app session safely. RCU read lock must be held before calling
661 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
665 struct lttng_ht_iter iter
;
666 struct ust_app_channel
*ua_chan
;
667 struct ust_registry_session
*registry
;
671 pthread_mutex_lock(&ua_sess
->lock
);
673 registry
= get_session_registry(ua_sess
);
675 /* Push metadata for application before freeing the application. */
676 (void) push_metadata(registry
, ua_sess
->consumer
);
679 * Don't ask to close metadata for global per UID buffers. Close
680 * metadata only on destroy trace session in this case. Also, the
681 * previous push metadata could have flag the metadata registry to
682 * close so don't send a close command if closed.
684 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
685 /* And ask to close it for this session registry. */
686 (void) close_metadata(registry
, ua_sess
->consumer
);
690 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
692 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
694 delete_ust_app_channel(sock
, ua_chan
, app
);
697 /* In case of per PID, the registry is kept in the session. */
698 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
699 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
701 buffer_reg_pid_remove(reg_pid
);
702 buffer_reg_pid_destroy(reg_pid
);
706 if (ua_sess
->handle
!= -1) {
707 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
708 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
709 ERR("UST app sock %d release session handle failed with ret %d",
713 pthread_mutex_unlock(&ua_sess
->lock
);
715 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
719 * Delete a traceable application structure from the global list. Never call
720 * this function outside of a call_rcu call.
722 * RCU read side lock should _NOT_ be held when calling this function.
725 void delete_ust_app(struct ust_app
*app
)
728 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
730 /* Delete ust app sessions info */
735 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
737 /* Free every object in the session and the session. */
739 delete_ust_app_session(sock
, ua_sess
, app
);
743 ht_cleanup_push(app
->sessions
);
744 ht_cleanup_push(app
->ust_objd
);
747 * Wait until we have deleted the application from the sock hash table
748 * before closing this socket, otherwise an application could re-use the
749 * socket ID and race with the teardown, using the same hash table entry.
751 * It's OK to leave the close in call_rcu. We want it to stay unique for
752 * all RCU readers that could run concurrently with unregister app,
753 * therefore we _need_ to only close that socket after a grace period. So
754 * it should stay in this RCU callback.
756 * This close() is a very important step of the synchronization model so
757 * every modification to this function must be carefully reviewed.
763 lttng_fd_put(LTTNG_FD_APPS
, 1);
765 DBG2("UST app pid %d deleted", app
->pid
);
770 * URCU intermediate call to delete an UST app.
773 void delete_ust_app_rcu(struct rcu_head
*head
)
775 struct lttng_ht_node_ulong
*node
=
776 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
777 struct ust_app
*app
=
778 caa_container_of(node
, struct ust_app
, pid_n
);
780 DBG3("Call RCU deleting app PID %d", app
->pid
);
785 * Delete the session from the application ht and delete the data structure by
786 * freeing every object inside and releasing them.
788 static void destroy_app_session(struct ust_app
*app
,
789 struct ust_app_session
*ua_sess
)
792 struct lttng_ht_iter iter
;
797 iter
.iter
.node
= &ua_sess
->node
.node
;
798 ret
= lttng_ht_del(app
->sessions
, &iter
);
800 /* Already scheduled for teardown. */
804 /* Once deleted, free the data structure. */
805 delete_ust_app_session(app
->sock
, ua_sess
, app
);
812 * Alloc new UST app session.
815 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
817 struct ust_app_session
*ua_sess
;
819 /* Init most of the default value by allocating and zeroing */
820 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
821 if (ua_sess
== NULL
) {
826 ua_sess
->handle
= -1;
827 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
828 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
829 pthread_mutex_init(&ua_sess
->lock
, NULL
);
838 * Alloc new UST app channel.
841 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
842 struct ust_app_session
*ua_sess
,
843 struct lttng_ust_channel_attr
*attr
)
845 struct ust_app_channel
*ua_chan
;
847 /* Init most of the default value by allocating and zeroing */
848 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
849 if (ua_chan
== NULL
) {
854 /* Setup channel name */
855 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
856 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
858 ua_chan
->enabled
= 1;
859 ua_chan
->handle
= -1;
860 ua_chan
->session
= ua_sess
;
861 ua_chan
->key
= get_next_channel_key();
862 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
863 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
864 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
866 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
867 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
869 /* Copy attributes */
871 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
872 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
873 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
874 ua_chan
->attr
.overwrite
= attr
->overwrite
;
875 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
876 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
877 ua_chan
->attr
.output
= attr
->output
;
879 /* By default, the channel is a per cpu channel. */
880 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
882 DBG3("UST app channel %s allocated", ua_chan
->name
);
891 * Allocate and initialize a UST app stream.
893 * Return newly allocated stream pointer or NULL on error.
895 struct ust_app_stream
*ust_app_alloc_stream(void)
897 struct ust_app_stream
*stream
= NULL
;
899 stream
= zmalloc(sizeof(*stream
));
900 if (stream
== NULL
) {
901 PERROR("zmalloc ust app stream");
905 /* Zero could be a valid value for a handle so flag it to -1. */
913 * Alloc new UST app event.
916 struct ust_app_event
*alloc_ust_app_event(char *name
,
917 struct lttng_ust_event
*attr
)
919 struct ust_app_event
*ua_event
;
921 /* Init most of the default value by allocating and zeroing */
922 ua_event
= zmalloc(sizeof(struct ust_app_event
));
923 if (ua_event
== NULL
) {
928 ua_event
->enabled
= 1;
929 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
930 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
931 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
933 /* Copy attributes */
935 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
938 DBG3("UST app event %s allocated", ua_event
->name
);
947 * Alloc new UST app context.
950 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
952 struct ust_app_ctx
*ua_ctx
;
954 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
955 if (ua_ctx
== NULL
) {
959 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
962 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
965 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
972 * Allocate a filter and copy the given original filter.
974 * Return allocated filter or NULL on error.
976 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
977 struct lttng_ust_filter_bytecode
*orig_f
)
979 struct lttng_ust_filter_bytecode
*filter
= NULL
;
981 /* Copy filter bytecode */
982 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
984 PERROR("zmalloc alloc ust app filter");
988 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
995 * Find an ust_app using the sock and return it. RCU read side lock must be
996 * held before calling this helper function.
998 struct ust_app
*ust_app_find_by_sock(int sock
)
1000 struct lttng_ht_node_ulong
*node
;
1001 struct lttng_ht_iter iter
;
1003 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1004 node
= lttng_ht_iter_get_node_ulong(&iter
);
1006 DBG2("UST app find by sock %d not found", sock
);
1010 return caa_container_of(node
, struct ust_app
, sock_n
);
1017 * Find an ust_app using the notify sock and return it. RCU read side lock must
1018 * be held before calling this helper function.
1020 static struct ust_app
*find_app_by_notify_sock(int sock
)
1022 struct lttng_ht_node_ulong
*node
;
1023 struct lttng_ht_iter iter
;
1025 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1027 node
= lttng_ht_iter_get_node_ulong(&iter
);
1029 DBG2("UST app find by notify sock %d not found", sock
);
1033 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1040 * Lookup for an ust app event based on event name, filter bytecode and the
1043 * Return an ust_app_event object or NULL on error.
1045 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1046 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1047 const struct lttng_event_exclusion
*exclusion
)
1049 struct lttng_ht_iter iter
;
1050 struct lttng_ht_node_str
*node
;
1051 struct ust_app_event
*event
= NULL
;
1052 struct ust_app_ht_key key
;
1057 /* Setup key for event lookup. */
1059 key
.filter
= filter
;
1060 key
.loglevel
= loglevel
;
1061 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1062 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1064 /* Lookup using the event name as hash and a custom match fct. */
1065 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1066 ht_match_ust_app_event
, &key
, &iter
.iter
);
1067 node
= lttng_ht_iter_get_node_str(&iter
);
1072 event
= caa_container_of(node
, struct ust_app_event
, node
);
1079 * Create the channel context on the tracer.
1081 * Called with UST app session lock held.
1084 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1085 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1089 health_code_update();
1091 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1092 ua_chan
->obj
, &ua_ctx
->obj
);
1094 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1095 ERR("UST app create channel context failed for app (pid: %d) "
1096 "with ret %d", app
->pid
, ret
);
1099 * This is normal behavior, an application can die during the
1100 * creation process. Don't report an error so the execution can
1101 * continue normally.
1104 DBG3("UST app disable event failed. Application is dead.");
1109 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1111 DBG2("UST app context handle %d created successfully for channel %s",
1112 ua_ctx
->handle
, ua_chan
->name
);
1115 health_code_update();
1120 * Set the filter on the tracer.
1123 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1124 struct ust_app
*app
)
1128 health_code_update();
1130 if (!ua_event
->filter
) {
1135 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1138 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1139 ERR("UST app event %s filter failed for app (pid: %d) "
1140 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1143 * This is normal behavior, an application can die during the
1144 * creation process. Don't report an error so the execution can
1145 * continue normally.
1148 DBG3("UST app filter event failed. Application is dead.");
1153 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1156 health_code_update();
1161 * Set event exclusions on the tracer.
1164 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1165 struct ust_app
*app
)
1169 health_code_update();
1171 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1176 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1179 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1180 ERR("UST app event %s exclusions failed for app (pid: %d) "
1181 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1184 * This is normal behavior, an application can die during the
1185 * creation process. Don't report an error so the execution can
1186 * continue normally.
1189 DBG3("UST app event exclusion failed. Application is dead.");
1194 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1197 health_code_update();
1202 * Disable the specified event on to UST tracer for the UST session.
1204 static int disable_ust_event(struct ust_app
*app
,
1205 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1209 health_code_update();
1211 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1213 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1214 ERR("UST app event %s disable failed for app (pid: %d) "
1215 "and session handle %d with ret %d",
1216 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1219 * This is normal behavior, an application can die during the
1220 * creation process. Don't report an error so the execution can
1221 * continue normally.
1224 DBG3("UST app disable event failed. Application is dead.");
1229 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1230 ua_event
->attr
.name
, app
->pid
);
1233 health_code_update();
1238 * Disable the specified channel on to UST tracer for the UST session.
1240 static int disable_ust_channel(struct ust_app
*app
,
1241 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1245 health_code_update();
1247 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1249 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1250 ERR("UST app channel %s disable failed for app (pid: %d) "
1251 "and session handle %d with ret %d",
1252 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1255 * This is normal behavior, an application can die during the
1256 * creation process. Don't report an error so the execution can
1257 * continue normally.
1260 DBG3("UST app disable channel failed. Application is dead.");
1265 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1266 ua_chan
->name
, app
->pid
);
1269 health_code_update();
1274 * Enable the specified channel on to UST tracer for the UST session.
1276 static int enable_ust_channel(struct ust_app
*app
,
1277 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1281 health_code_update();
1283 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1285 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1286 ERR("UST app channel %s enable failed for app (pid: %d) "
1287 "and session handle %d with ret %d",
1288 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1291 * This is normal behavior, an application can die during the
1292 * creation process. Don't report an error so the execution can
1293 * continue normally.
1296 DBG3("UST app enable channel failed. Application is dead.");
1301 ua_chan
->enabled
= 1;
1303 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1304 ua_chan
->name
, app
->pid
);
1307 health_code_update();
1312 * Enable the specified event on to UST tracer for the UST session.
1314 static int enable_ust_event(struct ust_app
*app
,
1315 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1319 health_code_update();
1321 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1323 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1324 ERR("UST app event %s enable failed for app (pid: %d) "
1325 "and session handle %d with ret %d",
1326 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1329 * This is normal behavior, an application can die during the
1330 * creation process. Don't report an error so the execution can
1331 * continue normally.
1334 DBG3("UST app enable event failed. Application is dead.");
1339 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1340 ua_event
->attr
.name
, app
->pid
);
1343 health_code_update();
1348 * Send channel and stream buffer to application.
1350 * Return 0 on success. On error, a negative value is returned.
1352 static int send_channel_pid_to_ust(struct ust_app
*app
,
1353 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1356 struct ust_app_stream
*stream
, *stmp
;
1362 health_code_update();
1364 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1367 /* Send channel to the application. */
1368 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1373 health_code_update();
1375 /* Send all streams to application. */
1376 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1377 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1381 /* We don't need the stream anymore once sent to the tracer. */
1382 cds_list_del(&stream
->list
);
1383 delete_ust_app_stream(-1, stream
);
1385 /* Flag the channel that it is sent to the application. */
1386 ua_chan
->is_sent
= 1;
1389 health_code_update();
1394 * Create the specified event onto the UST tracer for a UST session.
1396 * Should be called with session mutex held.
1399 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1400 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1404 health_code_update();
1406 /* Create UST event on tracer */
1407 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1410 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1411 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1412 ua_event
->attr
.name
, app
->pid
, ret
);
1415 * This is normal behavior, an application can die during the
1416 * creation process. Don't report an error so the execution can
1417 * continue normally.
1420 DBG3("UST app create event failed. Application is dead.");
1425 ua_event
->handle
= ua_event
->obj
->handle
;
1427 DBG2("UST app event %s created successfully for pid:%d",
1428 ua_event
->attr
.name
, app
->pid
);
1430 health_code_update();
1432 /* Set filter if one is present. */
1433 if (ua_event
->filter
) {
1434 ret
= set_ust_event_filter(ua_event
, app
);
1440 /* Set exclusions for the event */
1441 if (ua_event
->exclusion
) {
1442 ret
= set_ust_event_exclusion(ua_event
, app
);
1448 /* If event not enabled, disable it on the tracer */
1449 if (ua_event
->enabled
) {
1451 * We now need to explicitly enable the event, since it
1452 * is now disabled at creation.
1454 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1457 * If we hit an EPERM, something is wrong with our enable call. If
1458 * we get an EEXIST, there is a problem on the tracer side since we
1462 case -LTTNG_UST_ERR_PERM
:
1463 /* Code flow problem */
1465 case -LTTNG_UST_ERR_EXIST
:
1466 /* It's OK for our use case. */
1477 health_code_update();
1482 * Copy data between an UST app event and a LTT event.
1484 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1485 struct ltt_ust_event
*uevent
)
1487 size_t exclusion_alloc_size
;
1489 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1490 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1492 ua_event
->enabled
= uevent
->enabled
;
1494 /* Copy event attributes */
1495 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1497 /* Copy filter bytecode */
1498 if (uevent
->filter
) {
1499 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1500 /* Filter might be NULL here in case of ENONEM. */
1503 /* Copy exclusion data */
1504 if (uevent
->exclusion
) {
1505 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1506 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1507 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1508 if (ua_event
->exclusion
== NULL
) {
1511 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1512 exclusion_alloc_size
);
1518 * Copy data between an UST app channel and a LTT channel.
1520 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1521 struct ltt_ust_channel
*uchan
)
1523 struct lttng_ht_iter iter
;
1524 struct ltt_ust_event
*uevent
;
1525 struct ltt_ust_context
*uctx
;
1526 struct ust_app_event
*ua_event
;
1527 struct ust_app_ctx
*ua_ctx
;
1529 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1531 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1532 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1534 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1535 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1537 /* Copy event attributes since the layout is different. */
1538 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1539 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1540 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1541 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1542 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1543 ua_chan
->attr
.output
= uchan
->attr
.output
;
1545 * Note that the attribute channel type is not set since the channel on the
1546 * tracing registry side does not have this information.
1549 ua_chan
->enabled
= uchan
->enabled
;
1550 ua_chan
->tracing_channel_id
= uchan
->id
;
1552 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1553 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1554 if (ua_ctx
== NULL
) {
1557 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1558 (unsigned long) ua_ctx
->ctx
.ctx
);
1559 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1560 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1563 /* Copy all events from ltt ust channel to ust app channel */
1564 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1565 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1566 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1567 if (ua_event
== NULL
) {
1568 DBG2("UST event %s not found on shadow copy channel",
1570 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1571 if (ua_event
== NULL
) {
1574 shadow_copy_event(ua_event
, uevent
);
1575 add_unique_ust_app_event(ua_chan
, ua_event
);
1579 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1583 * Copy data between a UST app session and a regular LTT session.
1585 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1586 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1588 struct lttng_ht_node_str
*ua_chan_node
;
1589 struct lttng_ht_iter iter
;
1590 struct ltt_ust_channel
*uchan
;
1591 struct ust_app_channel
*ua_chan
;
1593 struct tm
*timeinfo
;
1597 /* Get date and time for unique app path */
1599 timeinfo
= localtime(&rawtime
);
1600 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1602 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1604 ua_sess
->tracing_id
= usess
->id
;
1605 ua_sess
->id
= get_next_session_id();
1606 ua_sess
->uid
= app
->uid
;
1607 ua_sess
->gid
= app
->gid
;
1608 ua_sess
->euid
= usess
->uid
;
1609 ua_sess
->egid
= usess
->gid
;
1610 ua_sess
->buffer_type
= usess
->buffer_type
;
1611 ua_sess
->bits_per_long
= app
->bits_per_long
;
1612 /* There is only one consumer object per session possible. */
1613 ua_sess
->consumer
= usess
->consumer
;
1614 ua_sess
->output_traces
= usess
->output_traces
;
1615 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1616 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1617 &usess
->metadata_attr
);
1619 switch (ua_sess
->buffer_type
) {
1620 case LTTNG_BUFFER_PER_PID
:
1621 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1622 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1625 case LTTNG_BUFFER_PER_UID
:
1626 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1627 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1634 PERROR("asprintf UST shadow copy session");
1639 /* Iterate over all channels in global domain. */
1640 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1642 struct lttng_ht_iter uiter
;
1644 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1645 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1646 if (ua_chan_node
!= NULL
) {
1647 /* Session exist. Contiuing. */
1651 DBG2("Channel %s not found on shadow session copy, creating it",
1653 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1654 if (ua_chan
== NULL
) {
1655 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1658 shadow_copy_channel(ua_chan
, uchan
);
1660 * The concept of metadata channel does not exist on the tracing
1661 * registry side of the session daemon so this can only be a per CPU
1662 * channel and not metadata.
1664 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1666 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1674 * Lookup sesison wrapper.
1677 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1678 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1680 /* Get right UST app session from app */
1681 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1685 * Return ust app session from the app session hashtable using the UST session
1688 static struct ust_app_session
*lookup_session_by_app(
1689 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1691 struct lttng_ht_iter iter
;
1692 struct lttng_ht_node_u64
*node
;
1694 __lookup_session_by_app(usess
, app
, &iter
);
1695 node
= lttng_ht_iter_get_node_u64(&iter
);
1700 return caa_container_of(node
, struct ust_app_session
, node
);
1707 * Setup buffer registry per PID for the given session and application. If none
1708 * is found, a new one is created, added to the global registry and
1709 * initialized. If regp is valid, it's set with the newly created object.
1711 * Return 0 on success or else a negative value.
1713 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1714 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1717 struct buffer_reg_pid
*reg_pid
;
1724 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1727 * This is the create channel path meaning that if there is NO
1728 * registry available, we have to create one for this session.
1730 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1738 /* Initialize registry. */
1739 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1740 app
->bits_per_long
, app
->uint8_t_alignment
,
1741 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1742 app
->uint64_t_alignment
, app
->long_alignment
,
1743 app
->byte_order
, app
->version
.major
,
1744 app
->version
.minor
);
1747 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1748 * destroy the buffer registry, because it is always expected
1749 * that if the buffer registry can be found, its ust registry is
1752 buffer_reg_pid_destroy(reg_pid
);
1756 buffer_reg_pid_add(reg_pid
);
1758 DBG3("UST app buffer registry per PID created successfully");
1770 * Setup buffer registry per UID for the given session and application. If none
1771 * is found, a new one is created, added to the global registry and
1772 * initialized. If regp is valid, it's set with the newly created object.
1774 * Return 0 on success or else a negative value.
1776 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1777 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1780 struct buffer_reg_uid
*reg_uid
;
1787 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1790 * This is the create channel path meaning that if there is NO
1791 * registry available, we have to create one for this session.
1793 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1794 LTTNG_DOMAIN_UST
, ®_uid
);
1802 /* Initialize registry. */
1803 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1804 app
->bits_per_long
, app
->uint8_t_alignment
,
1805 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1806 app
->uint64_t_alignment
, app
->long_alignment
,
1807 app
->byte_order
, app
->version
.major
,
1808 app
->version
.minor
);
1811 * reg_uid->registry->reg.ust is NULL upon error, so we need to
1812 * destroy the buffer registry, because it is always expected
1813 * that if the buffer registry can be found, its ust registry is
1816 buffer_reg_uid_destroy(reg_uid
, NULL
);
1819 /* Add node to teardown list of the session. */
1820 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1822 buffer_reg_uid_add(reg_uid
);
1824 DBG3("UST app buffer registry per UID created successfully");
1835 * Create a session on the tracer side for the given app.
1837 * On success, ua_sess_ptr is populated with the session pointer or else left
1838 * untouched. If the session was created, is_created is set to 1. On error,
1839 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1842 * Returns 0 on success or else a negative code which is either -ENOMEM or
1843 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1845 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1846 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1849 int ret
, created
= 0;
1850 struct ust_app_session
*ua_sess
;
1854 assert(ua_sess_ptr
);
1856 health_code_update();
1858 ua_sess
= lookup_session_by_app(usess
, app
);
1859 if (ua_sess
== NULL
) {
1860 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1861 app
->pid
, usess
->id
);
1862 ua_sess
= alloc_ust_app_session(app
);
1863 if (ua_sess
== NULL
) {
1864 /* Only malloc can failed so something is really wrong */
1868 shadow_copy_session(ua_sess
, usess
, app
);
1872 switch (usess
->buffer_type
) {
1873 case LTTNG_BUFFER_PER_PID
:
1874 /* Init local registry. */
1875 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1877 delete_ust_app_session(-1, ua_sess
, app
);
1881 case LTTNG_BUFFER_PER_UID
:
1882 /* Look for a global registry. If none exists, create one. */
1883 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1885 delete_ust_app_session(-1, ua_sess
, app
);
1895 health_code_update();
1897 if (ua_sess
->handle
== -1) {
1898 ret
= ustctl_create_session(app
->sock
);
1900 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1901 ERR("Creating session for app pid %d with ret %d",
1904 DBG("UST app creating session failed. Application is dead");
1906 * This is normal behavior, an application can die during the
1907 * creation process. Don't report an error so the execution can
1908 * continue normally. This will get flagged ENOTCONN and the
1909 * caller will handle it.
1913 delete_ust_app_session(-1, ua_sess
, app
);
1914 if (ret
!= -ENOMEM
) {
1916 * Tracer is probably gone or got an internal error so let's
1917 * behave like it will soon unregister or not usable.
1924 ua_sess
->handle
= ret
;
1926 /* Add ust app session to app's HT */
1927 lttng_ht_node_init_u64(&ua_sess
->node
,
1928 ua_sess
->tracing_id
);
1929 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1931 DBG2("UST app session created successfully with handle %d", ret
);
1934 *ua_sess_ptr
= ua_sess
;
1936 *is_created
= created
;
1939 /* Everything went well. */
1943 health_code_update();
1948 * Match function for a hash table lookup of ust_app_ctx.
1950 * It matches an ust app context based on the context type and, in the case
1951 * of perf counters, their name.
1953 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1955 struct ust_app_ctx
*ctx
;
1956 const struct lttng_ust_context
*key
;
1961 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1965 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1969 /* Check the name in the case of perf thread counters. */
1970 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1971 if (strncmp(key
->u
.perf_counter
.name
,
1972 ctx
->ctx
.u
.perf_counter
.name
,
1973 sizeof(key
->u
.perf_counter
.name
))) {
1986 * Lookup for an ust app context from an lttng_ust_context.
1988 * Must be called while holding RCU read side lock.
1989 * Return an ust_app_ctx object or NULL on error.
1992 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
1993 struct lttng_ust_context
*uctx
)
1995 struct lttng_ht_iter iter
;
1996 struct lttng_ht_node_ulong
*node
;
1997 struct ust_app_ctx
*app_ctx
= NULL
;
2002 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2003 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2004 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2005 node
= lttng_ht_iter_get_node_ulong(&iter
);
2010 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2017 * Create a context for the channel on the tracer.
2019 * Called with UST app session lock held and a RCU read side lock.
2022 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2023 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2024 struct ust_app
*app
)
2027 struct ust_app_ctx
*ua_ctx
;
2029 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2031 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2037 ua_ctx
= alloc_ust_app_ctx(uctx
);
2038 if (ua_ctx
== NULL
) {
2044 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2045 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2046 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2048 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2058 * Enable on the tracer side a ust app event for the session and channel.
2060 * Called with UST app session lock held.
2063 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2064 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2068 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2073 ua_event
->enabled
= 1;
2080 * Disable on the tracer side a ust app event for the session and channel.
2082 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2083 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2087 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2092 ua_event
->enabled
= 0;
2099 * Lookup ust app channel for session and disable it on the tracer side.
2102 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2103 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2107 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2112 ua_chan
->enabled
= 0;
2119 * Lookup ust app channel for session and enable it on the tracer side. This
2120 * MUST be called with a RCU read side lock acquired.
2122 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2123 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2126 struct lttng_ht_iter iter
;
2127 struct lttng_ht_node_str
*ua_chan_node
;
2128 struct ust_app_channel
*ua_chan
;
2130 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2131 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2132 if (ua_chan_node
== NULL
) {
2133 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2134 uchan
->name
, ua_sess
->tracing_id
);
2138 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2140 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2150 * Ask the consumer to create a channel and get it if successful.
2152 * Return 0 on success or else a negative value.
2154 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2155 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2156 int bitness
, struct ust_registry_session
*registry
)
2159 unsigned int nb_fd
= 0;
2160 struct consumer_socket
*socket
;
2168 health_code_update();
2170 /* Get the right consumer socket for the application. */
2171 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2177 health_code_update();
2179 /* Need one fd for the channel. */
2180 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2182 ERR("Exhausted number of available FD upon create channel");
2187 * Ask consumer to create channel. The consumer will return the number of
2188 * stream we have to expect.
2190 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2197 * Compute the number of fd needed before receiving them. It must be 2 per
2198 * stream (2 being the default value here).
2200 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2202 /* Reserve the amount of file descriptor we need. */
2203 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2205 ERR("Exhausted number of available FD upon create channel");
2206 goto error_fd_get_stream
;
2209 health_code_update();
2212 * Now get the channel from the consumer. This call wil populate the stream
2213 * list of that channel and set the ust objects.
2215 if (usess
->consumer
->enabled
) {
2216 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2226 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2227 error_fd_get_stream
:
2229 * Initiate a destroy channel on the consumer since we had an error
2230 * handling it on our side. The return value is of no importance since we
2231 * already have a ret value set by the previous error that we need to
2234 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2236 lttng_fd_put(LTTNG_FD_APPS
, 1);
2238 health_code_update();
2244 * Duplicate the ust data object of the ust app stream and save it in the
2245 * buffer registry stream.
2247 * Return 0 on success or else a negative value.
2249 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2250 struct ust_app_stream
*stream
)
2257 /* Reserve the amount of file descriptor we need. */
2258 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2260 ERR("Exhausted number of available FD upon duplicate stream");
2264 /* Duplicate object for stream once the original is in the registry. */
2265 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2266 reg_stream
->obj
.ust
);
2268 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2269 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2270 lttng_fd_put(LTTNG_FD_APPS
, 2);
2273 stream
->handle
= stream
->obj
->handle
;
2280 * Duplicate the ust data object of the ust app. channel and save it in the
2281 * buffer registry channel.
2283 * Return 0 on success or else a negative value.
2285 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2286 struct ust_app_channel
*ua_chan
)
2293 /* Need two fds for the channel. */
2294 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2296 ERR("Exhausted number of available FD upon duplicate channel");
2300 /* Duplicate object for stream once the original is in the registry. */
2301 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2303 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2304 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2307 ua_chan
->handle
= ua_chan
->obj
->handle
;
2312 lttng_fd_put(LTTNG_FD_APPS
, 1);
2318 * For a given channel buffer registry, setup all streams of the given ust
2319 * application channel.
2321 * Return 0 on success or else a negative value.
2323 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2324 struct ust_app_channel
*ua_chan
)
2327 struct ust_app_stream
*stream
, *stmp
;
2332 DBG2("UST app setup buffer registry stream");
2334 /* Send all streams to application. */
2335 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2336 struct buffer_reg_stream
*reg_stream
;
2338 ret
= buffer_reg_stream_create(®_stream
);
2344 * Keep original pointer and nullify it in the stream so the delete
2345 * stream call does not release the object.
2347 reg_stream
->obj
.ust
= stream
->obj
;
2349 buffer_reg_stream_add(reg_stream
, reg_chan
);
2351 /* We don't need the streams anymore. */
2352 cds_list_del(&stream
->list
);
2353 delete_ust_app_stream(-1, stream
);
2361 * Create a buffer registry channel for the given session registry and
2362 * application channel object. If regp pointer is valid, it's set with the
2363 * created object. Important, the created object is NOT added to the session
2364 * registry hash table.
2366 * Return 0 on success else a negative value.
2368 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2369 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2372 struct buffer_reg_channel
*reg_chan
= NULL
;
2377 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2379 /* Create buffer registry channel. */
2380 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2385 reg_chan
->consumer_key
= ua_chan
->key
;
2386 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2387 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2389 /* Create and add a channel registry to session. */
2390 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2391 ua_chan
->tracing_channel_id
);
2395 buffer_reg_channel_add(reg_sess
, reg_chan
);
2404 /* Safe because the registry channel object was not added to any HT. */
2405 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2411 * Setup buffer registry channel for the given session registry and application
2412 * channel object. If regp pointer is valid, it's set with the created object.
2414 * Return 0 on success else a negative value.
2416 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2417 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2424 assert(ua_chan
->obj
);
2426 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2428 /* Setup all streams for the registry. */
2429 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2434 reg_chan
->obj
.ust
= ua_chan
->obj
;
2435 ua_chan
->obj
= NULL
;
2440 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2441 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2446 * Send buffer registry channel to the application.
2448 * Return 0 on success else a negative value.
2450 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2451 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2452 struct ust_app_channel
*ua_chan
)
2455 struct buffer_reg_stream
*reg_stream
;
2462 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2464 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2469 /* Send channel to the application. */
2470 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2475 health_code_update();
2477 /* Send all streams to application. */
2478 pthread_mutex_lock(®_chan
->stream_list_lock
);
2479 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2480 struct ust_app_stream stream
;
2482 ret
= duplicate_stream_object(reg_stream
, &stream
);
2484 goto error_stream_unlock
;
2487 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2489 (void) release_ust_app_stream(-1, &stream
);
2490 goto error_stream_unlock
;
2494 * The return value is not important here. This function will output an
2497 (void) release_ust_app_stream(-1, &stream
);
2499 ua_chan
->is_sent
= 1;
2501 error_stream_unlock
:
2502 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2508 * Create and send to the application the created buffers with per UID buffers.
2510 * Return 0 on success else a negative value.
2512 static int create_channel_per_uid(struct ust_app
*app
,
2513 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2514 struct ust_app_channel
*ua_chan
)
2517 struct buffer_reg_uid
*reg_uid
;
2518 struct buffer_reg_channel
*reg_chan
;
2525 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2527 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2529 * The session creation handles the creation of this global registry
2530 * object. If none can be find, there is a code flow problem or a
2535 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2538 /* Create the buffer registry channel object. */
2539 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2541 ERR("Error creating the UST channel \"%s\" registry instance",
2548 * Create the buffers on the consumer side. This call populates the
2549 * ust app channel object with all streams and data object.
2551 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2552 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2554 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2558 * Let's remove the previously created buffer registry channel so
2559 * it's not visible anymore in the session registry.
2561 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2562 ua_chan
->tracing_channel_id
);
2563 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2564 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2569 * Setup the streams and add it to the session registry.
2571 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2573 ERR("Error setting up UST channel \"%s\"",
2580 /* Send buffers to the application. */
2581 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2584 * Don't report error to the console, since it may be
2585 * caused by application concurrently exiting.
2595 * Create and send to the application the created buffers with per PID buffers.
2597 * Return 0 on success else a negative value.
2599 static int create_channel_per_pid(struct ust_app
*app
,
2600 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2601 struct ust_app_channel
*ua_chan
)
2604 struct ust_registry_session
*registry
;
2611 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2615 registry
= get_session_registry(ua_sess
);
2618 /* Create and add a new channel registry to session. */
2619 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2621 ERR("Error creating the UST channel \"%s\" registry instance",
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
);
2630 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2635 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2638 * Don't report error to the console, since it may be
2639 * caused by application concurrently exiting.
2650 * From an already allocated ust app channel, create the channel buffers if
2651 * need and send it to the application. This MUST be called with a RCU read
2652 * side lock acquired.
2654 * Return 0 on success or else a negative value.
2656 static int do_create_channel(struct ust_app
*app
,
2657 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2658 struct ust_app_channel
*ua_chan
)
2667 /* Handle buffer type before sending the channel to the application. */
2668 switch (usess
->buffer_type
) {
2669 case LTTNG_BUFFER_PER_UID
:
2671 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2677 case LTTNG_BUFFER_PER_PID
:
2679 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2691 /* Initialize ust objd object using the received handle and add it. */
2692 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2693 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2695 /* If channel is not enabled, disable it on the tracer */
2696 if (!ua_chan
->enabled
) {
2697 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2708 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2709 * newly created channel if not NULL.
2711 * Called with UST app session lock and RCU read-side lock held.
2713 * Return 0 on success or else a negative value.
2715 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2716 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2717 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2718 struct ust_app_channel
**ua_chanp
)
2721 struct lttng_ht_iter iter
;
2722 struct lttng_ht_node_str
*ua_chan_node
;
2723 struct ust_app_channel
*ua_chan
;
2725 /* Lookup channel in the ust app session */
2726 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2727 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2728 if (ua_chan_node
!= NULL
) {
2729 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2733 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2734 if (ua_chan
== NULL
) {
2735 /* Only malloc can fail here */
2739 shadow_copy_channel(ua_chan
, uchan
);
2741 /* Set channel type. */
2742 ua_chan
->attr
.type
= type
;
2744 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2749 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2752 /* Only add the channel if successful on the tracer side. */
2753 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2757 *ua_chanp
= ua_chan
;
2760 /* Everything went well. */
2764 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2770 * Create UST app event and create it on the tracer side.
2772 * Called with ust app session mutex held.
2775 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2776 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2777 struct ust_app
*app
)
2780 struct ust_app_event
*ua_event
;
2782 /* Get event node */
2783 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2784 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2785 if (ua_event
!= NULL
) {
2790 /* Does not exist so create one */
2791 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2792 if (ua_event
== NULL
) {
2793 /* Only malloc can failed so something is really wrong */
2797 shadow_copy_event(ua_event
, uevent
);
2799 /* Create it on the tracer side */
2800 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2802 /* Not found previously means that it does not exist on the tracer */
2803 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2807 add_unique_ust_app_event(ua_chan
, ua_event
);
2809 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2816 /* Valid. Calling here is already in a read side lock */
2817 delete_ust_app_event(-1, ua_event
);
2822 * Create UST metadata and open it on the tracer side.
2824 * Called with UST app session lock held and RCU read side lock.
2826 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2827 struct ust_app
*app
, struct consumer_output
*consumer
)
2830 struct ust_app_channel
*metadata
;
2831 struct consumer_socket
*socket
;
2832 struct ust_registry_session
*registry
;
2838 registry
= get_session_registry(ua_sess
);
2841 pthread_mutex_lock(®istry
->lock
);
2843 /* Metadata already exists for this registry or it was closed previously */
2844 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2849 /* Allocate UST metadata */
2850 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2852 /* malloc() failed */
2857 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2859 /* Need one fd for the channel. */
2860 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2862 ERR("Exhausted number of available FD upon create metadata");
2866 /* Get the right consumer socket for the application. */
2867 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2870 goto error_consumer
;
2874 * Keep metadata key so we can identify it on the consumer side. Assign it
2875 * to the registry *before* we ask the consumer so we avoid the race of the
2876 * consumer requesting the metadata and the ask_channel call on our side
2877 * did not returned yet.
2879 registry
->metadata_key
= metadata
->key
;
2882 * Ask the metadata channel creation to the consumer. The metadata object
2883 * will be created by the consumer and kept their. However, the stream is
2884 * never added or monitored until we do a first push metadata to the
2887 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2890 /* Nullify the metadata key so we don't try to close it later on. */
2891 registry
->metadata_key
= 0;
2892 goto error_consumer
;
2896 * The setup command will make the metadata stream be sent to the relayd,
2897 * if applicable, and the thread managing the metadatas. This is important
2898 * because after this point, if an error occurs, the only way the stream
2899 * can be deleted is to be monitored in the consumer.
2901 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2903 /* Nullify the metadata key so we don't try to close it later on. */
2904 registry
->metadata_key
= 0;
2905 goto error_consumer
;
2908 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2909 metadata
->key
, app
->pid
);
2912 lttng_fd_put(LTTNG_FD_APPS
, 1);
2913 delete_ust_app_channel(-1, metadata
, app
);
2915 pthread_mutex_unlock(®istry
->lock
);
2920 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2921 * acquired before calling this function.
2923 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2925 struct ust_app
*app
= NULL
;
2926 struct lttng_ht_node_ulong
*node
;
2927 struct lttng_ht_iter iter
;
2929 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2930 node
= lttng_ht_iter_get_node_ulong(&iter
);
2932 DBG2("UST app no found with pid %d", pid
);
2936 DBG2("Found UST app by pid %d", pid
);
2938 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2945 * Allocate and init an UST app object using the registration information and
2946 * the command socket. This is called when the command socket connects to the
2949 * The object is returned on success or else NULL.
2951 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2953 struct ust_app
*lta
= NULL
;
2958 DBG3("UST app creating application for socket %d", sock
);
2960 if ((msg
->bits_per_long
== 64 &&
2961 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2962 || (msg
->bits_per_long
== 32 &&
2963 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2964 ERR("Registration failed: application \"%s\" (pid: %d) has "
2965 "%d-bit long, but no consumerd for this size is available.\n",
2966 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2970 lta
= zmalloc(sizeof(struct ust_app
));
2976 lta
->ppid
= msg
->ppid
;
2977 lta
->uid
= msg
->uid
;
2978 lta
->gid
= msg
->gid
;
2980 lta
->bits_per_long
= msg
->bits_per_long
;
2981 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2982 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2983 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2984 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2985 lta
->long_alignment
= msg
->long_alignment
;
2986 lta
->byte_order
= msg
->byte_order
;
2988 lta
->v_major
= msg
->major
;
2989 lta
->v_minor
= msg
->minor
;
2990 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2991 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2992 lta
->notify_sock
= -1;
2994 /* Copy name and make sure it's NULL terminated. */
2995 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2996 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2999 * Before this can be called, when receiving the registration information,
3000 * the application compatibility is checked. So, at this point, the
3001 * application can work with this session daemon.
3003 lta
->compatible
= 1;
3005 lta
->pid
= msg
->pid
;
3006 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3008 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3010 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3017 * For a given application object, add it to every hash table.
3019 void ust_app_add(struct ust_app
*app
)
3022 assert(app
->notify_sock
>= 0);
3027 * On a re-registration, we want to kick out the previous registration of
3030 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3033 * The socket _should_ be unique until _we_ call close. So, a add_unique
3034 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3035 * already in the table.
3037 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3039 /* Add application to the notify socket hash table. */
3040 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3041 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3043 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3044 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3045 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3052 * Set the application version into the object.
3054 * Return 0 on success else a negative value either an errno code or a
3055 * LTTng-UST error code.
3057 int ust_app_version(struct ust_app
*app
)
3063 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3065 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3066 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3068 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3076 * Unregister app by removing it from the global traceable app list and freeing
3079 * The socket is already closed at this point so no close to sock.
3081 void ust_app_unregister(int sock
)
3083 struct ust_app
*lta
;
3084 struct lttng_ht_node_ulong
*node
;
3085 struct lttng_ht_iter ust_app_sock_iter
;
3086 struct lttng_ht_iter iter
;
3087 struct ust_app_session
*ua_sess
;
3092 /* Get the node reference for a call_rcu */
3093 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3094 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3097 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3098 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3101 * For per-PID buffers, perform "push metadata" and flush all
3102 * application streams before removing app from hash tables,
3103 * ensuring proper behavior of data_pending check.
3104 * Remove sessions so they are not visible during deletion.
3106 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3108 struct ust_registry_session
*registry
;
3110 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3112 /* The session was already removed so scheduled for teardown. */
3116 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3117 (void) ust_app_flush_app_session(lta
, ua_sess
);
3121 * Add session to list for teardown. This is safe since at this point we
3122 * are the only one using this list.
3124 pthread_mutex_lock(&ua_sess
->lock
);
3127 * Normally, this is done in the delete session process which is
3128 * executed in the call rcu below. However, upon registration we can't
3129 * afford to wait for the grace period before pushing data or else the
3130 * data pending feature can race between the unregistration and stop
3131 * command where the data pending command is sent *before* the grace
3134 * The close metadata below nullifies the metadata pointer in the
3135 * session so the delete session will NOT push/close a second time.
3137 registry
= get_session_registry(ua_sess
);
3139 /* Push metadata for application before freeing the application. */
3140 (void) push_metadata(registry
, ua_sess
->consumer
);
3143 * Don't ask to close metadata for global per UID buffers. Close
3144 * metadata only on destroy trace session in this case. Also, the
3145 * previous push metadata could have flag the metadata registry to
3146 * close so don't send a close command if closed.
3148 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3149 /* And ask to close it for this session registry. */
3150 (void) close_metadata(registry
, ua_sess
->consumer
);
3153 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3155 pthread_mutex_unlock(&ua_sess
->lock
);
3158 /* Remove application from PID hash table */
3159 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3163 * Remove application from notify hash table. The thread handling the
3164 * notify socket could have deleted the node so ignore on error because
3165 * either way it's valid. The close of that socket is handled by the other
3168 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3169 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3172 * Ignore return value since the node might have been removed before by an
3173 * add replace during app registration because the PID can be reassigned by
3176 iter
.iter
.node
= <a
->pid_n
.node
;
3177 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3179 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3184 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3191 * Fill events array with all events name of all registered apps.
3193 int ust_app_list_events(struct lttng_event
**events
)
3196 size_t nbmem
, count
= 0;
3197 struct lttng_ht_iter iter
;
3198 struct ust_app
*app
;
3199 struct lttng_event
*tmp_event
;
3201 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3202 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3203 if (tmp_event
== NULL
) {
3204 PERROR("zmalloc ust app events");
3211 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3212 struct lttng_ust_tracepoint_iter uiter
;
3214 health_code_update();
3216 if (!app
->compatible
) {
3218 * TODO: In time, we should notice the caller of this error by
3219 * telling him that this is a version error.
3223 handle
= ustctl_tracepoint_list(app
->sock
);
3225 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3226 ERR("UST app list events getting handle failed for app pid %d",
3232 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3233 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3234 /* Handle ustctl error. */
3236 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3237 ERR("UST app tp list get failed for app %d with ret %d",
3240 DBG3("UST app tp list get failed. Application is dead");
3242 * This is normal behavior, an application can die during the
3243 * creation process. Don't report an error so the execution can
3244 * continue normally. Continue normal execution.
3252 health_code_update();
3253 if (count
>= nbmem
) {
3254 /* In case the realloc fails, we free the memory */
3255 struct lttng_event
*new_tmp_event
;
3258 new_nbmem
= nbmem
<< 1;
3259 DBG2("Reallocating event list from %zu to %zu entries",
3261 new_tmp_event
= realloc(tmp_event
,
3262 new_nbmem
* sizeof(struct lttng_event
));
3263 if (new_tmp_event
== NULL
) {
3264 PERROR("realloc ust app events");
3269 /* Zero the new memory */
3270 memset(new_tmp_event
+ nbmem
, 0,
3271 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3273 tmp_event
= new_tmp_event
;
3275 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3276 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3277 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3278 tmp_event
[count
].pid
= app
->pid
;
3279 tmp_event
[count
].enabled
= -1;
3285 *events
= tmp_event
;
3287 DBG2("UST app list events done (%zu events)", count
);
3292 health_code_update();
3297 * Fill events array with all events name of all registered apps.
3299 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3302 size_t nbmem
, count
= 0;
3303 struct lttng_ht_iter iter
;
3304 struct ust_app
*app
;
3305 struct lttng_event_field
*tmp_event
;
3307 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3308 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3309 if (tmp_event
== NULL
) {
3310 PERROR("zmalloc ust app event fields");
3317 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3318 struct lttng_ust_field_iter uiter
;
3320 health_code_update();
3322 if (!app
->compatible
) {
3324 * TODO: In time, we should notice the caller of this error by
3325 * telling him that this is a version error.
3329 handle
= ustctl_tracepoint_field_list(app
->sock
);
3331 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3332 ERR("UST app list field getting handle failed for app pid %d",
3338 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3339 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3340 /* Handle ustctl error. */
3342 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3343 ERR("UST app tp list field failed for app %d with ret %d",
3346 DBG3("UST app tp list field failed. Application is dead");
3348 * This is normal behavior, an application can die during the
3349 * creation process. Don't report an error so the execution can
3350 * continue normally. Reset list and count for next app.
3358 health_code_update();
3359 if (count
>= nbmem
) {
3360 /* In case the realloc fails, we free the memory */
3361 struct lttng_event_field
*new_tmp_event
;
3364 new_nbmem
= nbmem
<< 1;
3365 DBG2("Reallocating event field list from %zu to %zu entries",
3367 new_tmp_event
= realloc(tmp_event
,
3368 new_nbmem
* sizeof(struct lttng_event_field
));
3369 if (new_tmp_event
== NULL
) {
3370 PERROR("realloc ust app event fields");
3375 /* Zero the new memory */
3376 memset(new_tmp_event
+ nbmem
, 0,
3377 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3379 tmp_event
= new_tmp_event
;
3382 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3383 /* Mapping between these enums matches 1 to 1. */
3384 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3385 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3387 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3388 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3389 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3390 tmp_event
[count
].event
.pid
= app
->pid
;
3391 tmp_event
[count
].event
.enabled
= -1;
3397 *fields
= tmp_event
;
3399 DBG2("UST app list event fields done (%zu events)", count
);
3404 health_code_update();
3409 * Free and clean all traceable apps of the global list.
3411 * Should _NOT_ be called with RCU read-side lock held.
3413 void ust_app_clean_list(void)
3416 struct ust_app
*app
;
3417 struct lttng_ht_iter iter
;
3419 DBG2("UST app cleaning registered apps hash table");
3424 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3425 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3427 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3431 /* Cleanup socket hash table */
3432 if (ust_app_ht_by_sock
) {
3433 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3435 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3440 /* Cleanup notify socket hash table */
3441 if (ust_app_ht_by_notify_sock
) {
3442 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3443 notify_sock_n
.node
) {
3444 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3450 /* Destroy is done only when the ht is empty */
3452 ht_cleanup_push(ust_app_ht
);
3454 if (ust_app_ht_by_sock
) {
3455 ht_cleanup_push(ust_app_ht_by_sock
);
3457 if (ust_app_ht_by_notify_sock
) {
3458 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3463 * Init UST app hash table.
3465 int ust_app_ht_alloc(void)
3467 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3471 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3472 if (!ust_app_ht_by_sock
) {
3475 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3476 if (!ust_app_ht_by_notify_sock
) {
3483 * For a specific UST session, disable the channel for all registered apps.
3485 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3486 struct ltt_ust_channel
*uchan
)
3489 struct lttng_ht_iter iter
;
3490 struct lttng_ht_node_str
*ua_chan_node
;
3491 struct ust_app
*app
;
3492 struct ust_app_session
*ua_sess
;
3493 struct ust_app_channel
*ua_chan
;
3495 if (usess
== NULL
|| uchan
== NULL
) {
3496 ERR("Disabling UST global channel with NULL values");
3501 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3502 uchan
->name
, usess
->id
);
3506 /* For every registered applications */
3507 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3508 struct lttng_ht_iter uiter
;
3509 if (!app
->compatible
) {
3511 * TODO: In time, we should notice the caller of this error by
3512 * telling him that this is a version error.
3516 ua_sess
= lookup_session_by_app(usess
, app
);
3517 if (ua_sess
== NULL
) {
3522 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3523 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3524 /* If the session if found for the app, the channel must be there */
3525 assert(ua_chan_node
);
3527 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3528 /* The channel must not be already disabled */
3529 assert(ua_chan
->enabled
== 1);
3531 /* Disable channel onto application */
3532 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3534 /* XXX: We might want to report this error at some point... */
3546 * For a specific UST session, enable the channel for all registered apps.
3548 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3549 struct ltt_ust_channel
*uchan
)
3552 struct lttng_ht_iter iter
;
3553 struct ust_app
*app
;
3554 struct ust_app_session
*ua_sess
;
3556 if (usess
== NULL
|| uchan
== NULL
) {
3557 ERR("Adding UST global channel to NULL values");
3562 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3563 uchan
->name
, usess
->id
);
3567 /* For every registered applications */
3568 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3569 if (!app
->compatible
) {
3571 * TODO: In time, we should notice the caller of this error by
3572 * telling him that this is a version error.
3576 ua_sess
= lookup_session_by_app(usess
, app
);
3577 if (ua_sess
== NULL
) {
3581 /* Enable channel onto application */
3582 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3584 /* XXX: We might want to report this error at some point... */
3596 * Disable an event in a channel and for a specific session.
3598 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3599 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3602 struct lttng_ht_iter iter
, uiter
;
3603 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3604 struct ust_app
*app
;
3605 struct ust_app_session
*ua_sess
;
3606 struct ust_app_channel
*ua_chan
;
3607 struct ust_app_event
*ua_event
;
3609 DBG("UST app disabling event %s for all apps in channel "
3610 "%s for session id %" PRIu64
,
3611 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3615 /* For all registered applications */
3616 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3617 if (!app
->compatible
) {
3619 * TODO: In time, we should notice the caller of this error by
3620 * telling him that this is a version error.
3624 ua_sess
= lookup_session_by_app(usess
, app
);
3625 if (ua_sess
== NULL
) {
3630 /* Lookup channel in the ust app session */
3631 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3632 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3633 if (ua_chan_node
== NULL
) {
3634 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3635 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3638 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3640 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3641 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3642 if (ua_event_node
== NULL
) {
3643 DBG2("Event %s not found in channel %s for app pid %d."
3644 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3647 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3649 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3651 /* XXX: Report error someday... */
3662 * For a specific UST session, create the channel for all registered apps.
3664 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3665 struct ltt_ust_channel
*uchan
)
3667 int ret
= 0, created
;
3668 struct lttng_ht_iter iter
;
3669 struct ust_app
*app
;
3670 struct ust_app_session
*ua_sess
= NULL
;
3672 /* Very wrong code flow */
3676 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3677 uchan
->name
, usess
->id
);
3681 /* For every registered applications */
3682 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3683 if (!app
->compatible
) {
3685 * TODO: In time, we should notice the caller of this error by
3686 * telling him that this is a version error.
3691 * Create session on the tracer side and add it to app session HT. Note
3692 * that if session exist, it will simply return a pointer to the ust
3695 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3700 * The application's socket is not valid. Either a bad socket
3701 * or a timeout on it. We can't inform the caller that for a
3702 * specific app, the session failed so lets continue here.
3707 goto error_rcu_unlock
;
3712 pthread_mutex_lock(&ua_sess
->lock
);
3713 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3714 sizeof(uchan
->name
))) {
3715 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3718 /* Create channel onto application. We don't need the chan ref. */
3719 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3720 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3722 pthread_mutex_unlock(&ua_sess
->lock
);
3724 if (ret
== -ENOMEM
) {
3725 /* No more memory is a fatal error. Stop right now. */
3726 goto error_rcu_unlock
;
3728 /* Cleanup the created session if it's the case. */
3730 destroy_app_session(app
, ua_sess
);
3741 * Enable event for a specific session and channel on the tracer.
3743 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3744 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3747 struct lttng_ht_iter iter
, uiter
;
3748 struct lttng_ht_node_str
*ua_chan_node
;
3749 struct ust_app
*app
;
3750 struct ust_app_session
*ua_sess
;
3751 struct ust_app_channel
*ua_chan
;
3752 struct ust_app_event
*ua_event
;
3754 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3755 uevent
->attr
.name
, usess
->id
);
3758 * NOTE: At this point, this function is called only if the session and
3759 * channel passed are already created for all apps. and enabled on the
3765 /* For all registered applications */
3766 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3767 if (!app
->compatible
) {
3769 * TODO: In time, we should notice the caller of this error by
3770 * telling him that this is a version error.
3774 ua_sess
= lookup_session_by_app(usess
, app
);
3776 /* The application has problem or is probably dead. */
3780 pthread_mutex_lock(&ua_sess
->lock
);
3782 /* Lookup channel in the ust app session */
3783 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3784 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3785 /* If the channel is not found, there is a code flow error */
3786 assert(ua_chan_node
);
3788 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3790 /* Get event node */
3791 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3792 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3793 if (ua_event
== NULL
) {
3794 DBG3("UST app enable event %s not found for app PID %d."
3795 "Skipping app", uevent
->attr
.name
, app
->pid
);
3799 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3801 pthread_mutex_unlock(&ua_sess
->lock
);
3805 pthread_mutex_unlock(&ua_sess
->lock
);
3814 * For a specific existing UST session and UST channel, creates the event for
3815 * all registered apps.
3817 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3818 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3821 struct lttng_ht_iter iter
, uiter
;
3822 struct lttng_ht_node_str
*ua_chan_node
;
3823 struct ust_app
*app
;
3824 struct ust_app_session
*ua_sess
;
3825 struct ust_app_channel
*ua_chan
;
3827 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3828 uevent
->attr
.name
, usess
->id
);
3832 /* For all registered applications */
3833 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3834 if (!app
->compatible
) {
3836 * TODO: In time, we should notice the caller of this error by
3837 * telling him that this is a version error.
3841 ua_sess
= lookup_session_by_app(usess
, app
);
3843 /* The application has problem or is probably dead. */
3847 pthread_mutex_lock(&ua_sess
->lock
);
3848 /* Lookup channel in the ust app session */
3849 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3850 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3851 /* If the channel is not found, there is a code flow error */
3852 assert(ua_chan_node
);
3854 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3856 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3857 pthread_mutex_unlock(&ua_sess
->lock
);
3859 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3860 /* Possible value at this point: -ENOMEM. If so, we stop! */
3863 DBG2("UST app event %s already exist on app PID %d",
3864 uevent
->attr
.name
, app
->pid
);
3875 * Start tracing for a specific UST session and app.
3878 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3881 struct ust_app_session
*ua_sess
;
3883 DBG("Starting tracing for ust app pid %d", app
->pid
);
3887 if (!app
->compatible
) {
3891 ua_sess
= lookup_session_by_app(usess
, app
);
3892 if (ua_sess
== NULL
) {
3893 /* The session is in teardown process. Ignore and continue. */
3897 pthread_mutex_lock(&ua_sess
->lock
);
3899 /* Upon restart, we skip the setup, already done */
3900 if (ua_sess
->started
) {
3904 /* Create directories if consumer is LOCAL and has a path defined. */
3905 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3906 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3907 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3908 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3910 if (ret
!= -EEXIST
) {
3911 ERR("Trace directory creation error");
3918 * Create the metadata for the application. This returns gracefully if a
3919 * metadata was already set for the session.
3921 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3926 health_code_update();
3929 /* This start the UST tracing */
3930 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3932 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3933 ERR("Error starting tracing for app pid: %d (ret: %d)",
3936 DBG("UST app start session failed. Application is dead.");
3938 * This is normal behavior, an application can die during the
3939 * creation process. Don't report an error so the execution can
3940 * continue normally.
3942 pthread_mutex_unlock(&ua_sess
->lock
);
3948 /* Indicate that the session has been started once */
3949 ua_sess
->started
= 1;
3951 pthread_mutex_unlock(&ua_sess
->lock
);
3953 health_code_update();
3955 /* Quiescent wait after starting trace */
3956 ret
= ustctl_wait_quiescent(app
->sock
);
3957 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3958 ERR("UST app wait quiescent failed for app pid %d ret %d",
3964 health_code_update();
3968 pthread_mutex_unlock(&ua_sess
->lock
);
3970 health_code_update();
3975 * Stop tracing for a specific UST session and app.
3978 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3981 struct ust_app_session
*ua_sess
;
3982 struct ust_registry_session
*registry
;
3984 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3988 if (!app
->compatible
) {
3989 goto end_no_session
;
3992 ua_sess
= lookup_session_by_app(usess
, app
);
3993 if (ua_sess
== NULL
) {
3994 goto end_no_session
;
3997 pthread_mutex_lock(&ua_sess
->lock
);
4000 * If started = 0, it means that stop trace has been called for a session
4001 * that was never started. It's possible since we can have a fail start
4002 * from either the application manager thread or the command thread. Simply
4003 * indicate that this is a stop error.
4005 if (!ua_sess
->started
) {
4006 goto error_rcu_unlock
;
4009 health_code_update();
4011 /* This inhibits UST tracing */
4012 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4014 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4015 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4018 DBG("UST app stop session failed. Application is dead.");
4020 * This is normal behavior, an application can die during the
4021 * creation process. Don't report an error so the execution can
4022 * continue normally.
4026 goto error_rcu_unlock
;
4029 health_code_update();
4031 /* Quiescent wait after stopping trace */
4032 ret
= ustctl_wait_quiescent(app
->sock
);
4033 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4034 ERR("UST app wait quiescent failed for app pid %d ret %d",
4038 health_code_update();
4040 registry
= get_session_registry(ua_sess
);
4043 /* Push metadata for application before freeing the application. */
4044 (void) push_metadata(registry
, ua_sess
->consumer
);
4047 pthread_mutex_unlock(&ua_sess
->lock
);
4050 health_code_update();
4054 pthread_mutex_unlock(&ua_sess
->lock
);
4056 health_code_update();
4061 int ust_app_flush_app_session(struct ust_app
*app
,
4062 struct ust_app_session
*ua_sess
)
4064 int ret
, retval
= 0;
4065 struct lttng_ht_iter iter
;
4066 struct ust_app_channel
*ua_chan
;
4067 struct consumer_socket
*socket
;
4069 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4073 if (!app
->compatible
) {
4074 goto end_not_compatible
;
4077 pthread_mutex_lock(&ua_sess
->lock
);
4079 health_code_update();
4081 /* Flushing buffers */
4082 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4085 /* Flush buffers and push metadata. */
4086 switch (ua_sess
->buffer_type
) {
4087 case LTTNG_BUFFER_PER_PID
:
4088 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4090 health_code_update();
4091 assert(ua_chan
->is_sent
);
4092 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4094 ERR("Error flushing consumer channel");
4100 case LTTNG_BUFFER_PER_UID
:
4106 health_code_update();
4108 pthread_mutex_unlock(&ua_sess
->lock
);
4112 health_code_update();
4117 * Flush buffers for all applications for a specific UST session.
4118 * Called with UST session lock held.
4121 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4126 DBG("Flushing session buffers for all ust apps");
4130 /* Flush buffers and push metadata. */
4131 switch (usess
->buffer_type
) {
4132 case LTTNG_BUFFER_PER_UID
:
4134 struct buffer_reg_uid
*reg
;
4135 struct lttng_ht_iter iter
;
4137 /* Flush all per UID buffers associated to that session. */
4138 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4139 struct ust_registry_session
*ust_session_reg
;
4140 struct buffer_reg_channel
*reg_chan
;
4141 struct consumer_socket
*socket
;
4143 /* Get consumer socket to use to push the metadata.*/
4144 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4147 /* Ignore request if no consumer is found for the session. */
4151 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4152 reg_chan
, node
.node
) {
4154 * The following call will print error values so the return
4155 * code is of little importance because whatever happens, we
4156 * have to try them all.
4158 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4161 ust_session_reg
= reg
->registry
->reg
.ust
;
4162 /* Push metadata. */
4163 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4167 case LTTNG_BUFFER_PER_PID
:
4169 struct ust_app_session
*ua_sess
;
4170 struct lttng_ht_iter iter
;
4171 struct ust_app
*app
;
4173 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4174 ua_sess
= lookup_session_by_app(usess
, app
);
4175 if (ua_sess
== NULL
) {
4178 (void) ust_app_flush_app_session(app
, ua_sess
);
4189 health_code_update();
4194 * Destroy a specific UST session in apps.
4196 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4199 struct ust_app_session
*ua_sess
;
4200 struct lttng_ht_iter iter
;
4201 struct lttng_ht_node_u64
*node
;
4203 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4207 if (!app
->compatible
) {
4211 __lookup_session_by_app(usess
, app
, &iter
);
4212 node
= lttng_ht_iter_get_node_u64(&iter
);
4214 /* Session is being or is deleted. */
4217 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4219 health_code_update();
4220 destroy_app_session(app
, ua_sess
);
4222 health_code_update();
4224 /* Quiescent wait after stopping trace */
4225 ret
= ustctl_wait_quiescent(app
->sock
);
4226 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4227 ERR("UST app wait quiescent failed for app pid %d ret %d",
4232 health_code_update();
4237 * Start tracing for the UST session.
4239 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4242 struct lttng_ht_iter iter
;
4243 struct ust_app
*app
;
4245 DBG("Starting all UST traces");
4249 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4250 ret
= ust_app_start_trace(usess
, app
);
4252 /* Continue to next apps even on error */
4263 * Start tracing for the UST session.
4264 * Called with UST session lock held.
4266 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4269 struct lttng_ht_iter iter
;
4270 struct ust_app
*app
;
4272 DBG("Stopping all UST traces");
4276 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4277 ret
= ust_app_stop_trace(usess
, app
);
4279 /* Continue to next apps even on error */
4284 (void) ust_app_flush_session(usess
);
4292 * Destroy app UST session.
4294 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4297 struct lttng_ht_iter iter
;
4298 struct ust_app
*app
;
4300 DBG("Destroy all UST traces");
4304 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4305 ret
= destroy_trace(usess
, app
);
4307 /* Continue to next apps even on error */
4318 * Add channels/events from UST global domain to registered apps at sock.
4320 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4323 struct lttng_ht_iter iter
, uiter
;
4324 struct ust_app
*app
;
4325 struct ust_app_session
*ua_sess
= NULL
;
4326 struct ust_app_channel
*ua_chan
;
4327 struct ust_app_event
*ua_event
;
4328 struct ust_app_ctx
*ua_ctx
;
4333 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4338 app
= ust_app_find_by_sock(sock
);
4341 * Application can be unregistered before so this is possible hence
4342 * simply stopping the update.
4344 DBG3("UST app update failed to find app sock %d", sock
);
4348 if (!app
->compatible
) {
4352 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4354 /* Tracer is probably gone or ENOMEM. */
4359 pthread_mutex_lock(&ua_sess
->lock
);
4362 * We can iterate safely here over all UST app session since the create ust
4363 * app session above made a shadow copy of the UST global domain from the
4366 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4368 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4371 * Stop everything. On error, the application failed, no more
4372 * file descriptor are available or ENOMEM so stopping here is
4373 * the only thing we can do for now.
4379 * Add context using the list so they are enabled in the same order the
4382 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4383 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4390 /* For each events */
4391 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4393 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4400 pthread_mutex_unlock(&ua_sess
->lock
);
4402 if (usess
->active
) {
4403 ret
= ust_app_start_trace(usess
, app
);
4408 DBG2("UST trace started for app pid %d", app
->pid
);
4411 /* Everything went well at this point. */
4416 pthread_mutex_unlock(&ua_sess
->lock
);
4419 destroy_app_session(app
, ua_sess
);
4426 * Add context to a specific channel for global UST domain.
4428 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4429 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4432 struct lttng_ht_node_str
*ua_chan_node
;
4433 struct lttng_ht_iter iter
, uiter
;
4434 struct ust_app_channel
*ua_chan
= NULL
;
4435 struct ust_app_session
*ua_sess
;
4436 struct ust_app
*app
;
4440 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4441 if (!app
->compatible
) {
4443 * TODO: In time, we should notice the caller of this error by
4444 * telling him that this is a version error.
4448 ua_sess
= lookup_session_by_app(usess
, app
);
4449 if (ua_sess
== NULL
) {
4453 pthread_mutex_lock(&ua_sess
->lock
);
4454 /* Lookup channel in the ust app session */
4455 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4456 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4457 if (ua_chan_node
== NULL
) {
4460 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4462 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4467 pthread_mutex_unlock(&ua_sess
->lock
);
4475 * Enable event for a channel from a UST session for a specific PID.
4477 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4478 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4481 struct lttng_ht_iter iter
;
4482 struct lttng_ht_node_str
*ua_chan_node
;
4483 struct ust_app
*app
;
4484 struct ust_app_session
*ua_sess
;
4485 struct ust_app_channel
*ua_chan
;
4486 struct ust_app_event
*ua_event
;
4488 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4492 app
= ust_app_find_by_pid(pid
);
4494 ERR("UST app enable event per PID %d not found", pid
);
4499 if (!app
->compatible
) {
4504 ua_sess
= lookup_session_by_app(usess
, app
);
4506 /* The application has problem or is probably dead. */
4511 pthread_mutex_lock(&ua_sess
->lock
);
4512 /* Lookup channel in the ust app session */
4513 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4514 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4515 /* If the channel is not found, there is a code flow error */
4516 assert(ua_chan_node
);
4518 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4520 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4521 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4522 if (ua_event
== NULL
) {
4523 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4528 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4535 pthread_mutex_unlock(&ua_sess
->lock
);
4542 * Calibrate registered applications.
4544 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4547 struct lttng_ht_iter iter
;
4548 struct ust_app
*app
;
4552 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4553 if (!app
->compatible
) {
4555 * TODO: In time, we should notice the caller of this error by
4556 * telling him that this is a version error.
4561 health_code_update();
4563 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4567 /* Means that it's not implemented on the tracer side. */
4571 DBG2("Calibrate app PID %d returned with error %d",
4578 DBG("UST app global domain calibration finished");
4582 health_code_update();
4588 * Receive registration and populate the given msg structure.
4590 * On success return 0 else a negative value returned by the ustctl call.
4592 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4595 uint32_t pid
, ppid
, uid
, gid
;
4599 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4600 &pid
, &ppid
, &uid
, &gid
,
4601 &msg
->bits_per_long
,
4602 &msg
->uint8_t_alignment
,
4603 &msg
->uint16_t_alignment
,
4604 &msg
->uint32_t_alignment
,
4605 &msg
->uint64_t_alignment
,
4606 &msg
->long_alignment
,
4613 case LTTNG_UST_ERR_EXITING
:
4614 DBG3("UST app recv reg message failed. Application died");
4616 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4617 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4618 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4619 LTTNG_UST_ABI_MINOR_VERSION
);
4622 ERR("UST app recv reg message failed with ret %d", ret
);
4627 msg
->pid
= (pid_t
) pid
;
4628 msg
->ppid
= (pid_t
) ppid
;
4629 msg
->uid
= (uid_t
) uid
;
4630 msg
->gid
= (gid_t
) gid
;
4637 * Return a ust app channel object using the application object and the channel
4638 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4639 * lock MUST be acquired before calling this function.
4641 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4644 struct lttng_ht_node_ulong
*node
;
4645 struct lttng_ht_iter iter
;
4646 struct ust_app_channel
*ua_chan
= NULL
;
4650 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4651 node
= lttng_ht_iter_get_node_ulong(&iter
);
4653 DBG2("UST app channel find by objd %d not found", objd
);
4657 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4664 * Reply to a register channel notification from an application on the notify
4665 * socket. The channel metadata is also created.
4667 * The session UST registry lock is acquired in this function.
4669 * On success 0 is returned else a negative value.
4671 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4672 size_t nr_fields
, struct ustctl_field
*fields
)
4674 int ret
, ret_code
= 0;
4675 uint32_t chan_id
, reg_count
;
4676 uint64_t chan_reg_key
;
4677 enum ustctl_channel_header type
;
4678 struct ust_app
*app
;
4679 struct ust_app_channel
*ua_chan
;
4680 struct ust_app_session
*ua_sess
;
4681 struct ust_registry_session
*registry
;
4682 struct ust_registry_channel
*chan_reg
;
4686 /* Lookup application. If not found, there is a code flow error. */
4687 app
= find_app_by_notify_sock(sock
);
4689 DBG("Application socket %d is being teardown. Abort event notify",
4693 goto error_rcu_unlock
;
4696 /* Lookup channel by UST object descriptor. */
4697 ua_chan
= find_channel_by_objd(app
, cobjd
);
4699 DBG("Application channel is being teardown. Abort event notify");
4702 goto error_rcu_unlock
;
4705 assert(ua_chan
->session
);
4706 ua_sess
= ua_chan
->session
;
4708 /* Get right session registry depending on the session buffer type. */
4709 registry
= get_session_registry(ua_sess
);
4712 /* Depending on the buffer type, a different channel key is used. */
4713 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4714 chan_reg_key
= ua_chan
->tracing_channel_id
;
4716 chan_reg_key
= ua_chan
->key
;
4719 pthread_mutex_lock(®istry
->lock
);
4721 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4724 if (!chan_reg
->register_done
) {
4725 reg_count
= ust_registry_get_event_count(chan_reg
);
4726 if (reg_count
< 31) {
4727 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4729 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4732 chan_reg
->nr_ctx_fields
= nr_fields
;
4733 chan_reg
->ctx_fields
= fields
;
4734 chan_reg
->header_type
= type
;
4736 /* Get current already assigned values. */
4737 type
= chan_reg
->header_type
;
4739 /* Set to NULL so the error path does not do a double free. */
4742 /* Channel id is set during the object creation. */
4743 chan_id
= chan_reg
->chan_id
;
4745 /* Append to metadata */
4746 if (!chan_reg
->metadata_dumped
) {
4747 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4749 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4755 DBG3("UST app replying to register channel key %" PRIu64
4756 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4759 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4761 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4762 ERR("UST app reply channel failed with ret %d", ret
);
4764 DBG3("UST app reply channel failed. Application died");
4769 /* This channel registry registration is completed. */
4770 chan_reg
->register_done
= 1;
4773 pthread_mutex_unlock(®istry
->lock
);
4783 * Add event to the UST channel registry. When the event is added to the
4784 * registry, the metadata is also created. Once done, this replies to the
4785 * application with the appropriate error code.
4787 * The session UST registry lock is acquired in the function.
4789 * On success 0 is returned else a negative value.
4791 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4792 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4793 char *model_emf_uri
)
4796 uint32_t event_id
= 0;
4797 uint64_t chan_reg_key
;
4798 struct ust_app
*app
;
4799 struct ust_app_channel
*ua_chan
;
4800 struct ust_app_session
*ua_sess
;
4801 struct ust_registry_session
*registry
;
4805 /* Lookup application. If not found, there is a code flow error. */
4806 app
= find_app_by_notify_sock(sock
);
4808 DBG("Application socket %d is being teardown. Abort event notify",
4813 free(model_emf_uri
);
4814 goto error_rcu_unlock
;
4817 /* Lookup channel by UST object descriptor. */
4818 ua_chan
= find_channel_by_objd(app
, cobjd
);
4820 DBG("Application channel is being teardown. Abort event notify");
4824 free(model_emf_uri
);
4825 goto error_rcu_unlock
;
4828 assert(ua_chan
->session
);
4829 ua_sess
= ua_chan
->session
;
4831 registry
= get_session_registry(ua_sess
);
4834 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4835 chan_reg_key
= ua_chan
->tracing_channel_id
;
4837 chan_reg_key
= ua_chan
->key
;
4840 pthread_mutex_lock(®istry
->lock
);
4843 * From this point on, this call acquires the ownership of the sig, fields
4844 * and model_emf_uri meaning any free are done inside it if needed. These
4845 * three variables MUST NOT be read/write after this.
4847 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4848 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4849 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4853 * The return value is returned to ustctl so in case of an error, the
4854 * application can be notified. In case of an error, it's important not to
4855 * return a negative error or else the application will get closed.
4857 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4859 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4860 ERR("UST app reply event failed with ret %d", ret
);
4862 DBG3("UST app reply event failed. Application died");
4865 * No need to wipe the create event since the application socket will
4866 * get close on error hence cleaning up everything by itself.
4871 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4875 pthread_mutex_unlock(®istry
->lock
);
4882 * Handle application notification through the given notify socket.
4884 * Return 0 on success or else a negative value.
4886 int ust_app_recv_notify(int sock
)
4889 enum ustctl_notify_cmd cmd
;
4891 DBG3("UST app receiving notify from sock %d", sock
);
4893 ret
= ustctl_recv_notify(sock
, &cmd
);
4895 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4896 ERR("UST app recv notify failed with ret %d", ret
);
4898 DBG3("UST app recv notify failed. Application died");
4904 case USTCTL_NOTIFY_CMD_EVENT
:
4906 int sobjd
, cobjd
, loglevel
;
4907 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4909 struct ustctl_field
*fields
;
4911 DBG2("UST app ustctl register event received");
4913 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4914 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4916 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4917 ERR("UST app recv event failed with ret %d", ret
);
4919 DBG3("UST app recv event failed. Application died");
4925 * Add event to the UST registry coming from the notify socket. This
4926 * call will free if needed the sig, fields and model_emf_uri. This
4927 * code path loses the ownsership of these variables and transfer them
4928 * to the this function.
4930 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4931 fields
, loglevel
, model_emf_uri
);
4938 case USTCTL_NOTIFY_CMD_CHANNEL
:
4942 struct ustctl_field
*fields
;
4944 DBG2("UST app ustctl register channel received");
4946 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4949 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4950 ERR("UST app recv channel failed with ret %d", ret
);
4952 DBG3("UST app recv channel failed. Application died");
4958 * The fields ownership are transfered to this function call meaning
4959 * that if needed it will be freed. After this, it's invalid to access
4960 * fields or clean it up.
4962 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4971 /* Should NEVER happen. */
4980 * Once the notify socket hangs up, this is called. First, it tries to find the
4981 * corresponding application. On failure, the call_rcu to close the socket is
4982 * executed. If an application is found, it tries to delete it from the notify
4983 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4985 * Note that an object needs to be allocated here so on ENOMEM failure, the
4986 * call RCU is not done but the rest of the cleanup is.
4988 void ust_app_notify_sock_unregister(int sock
)
4991 struct lttng_ht_iter iter
;
4992 struct ust_app
*app
;
4993 struct ust_app_notify_sock_obj
*obj
;
4999 obj
= zmalloc(sizeof(*obj
));
5002 * An ENOMEM is kind of uncool. If this strikes we continue the
5003 * procedure but the call_rcu will not be called. In this case, we
5004 * accept the fd leak rather than possibly creating an unsynchronized
5005 * state between threads.
5007 * TODO: The notify object should be created once the notify socket is
5008 * registered and stored independantely from the ust app object. The
5009 * tricky part is to synchronize the teardown of the application and
5010 * this notify object. Let's keep that in mind so we can avoid this
5011 * kind of shenanigans with ENOMEM in the teardown path.
5018 DBG("UST app notify socket unregister %d", sock
);
5021 * Lookup application by notify socket. If this fails, this means that the
5022 * hash table delete has already been done by the application
5023 * unregistration process so we can safely close the notify socket in a
5026 app
= find_app_by_notify_sock(sock
);
5031 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5034 * Whatever happens here either we fail or succeed, in both cases we have
5035 * to close the socket after a grace period to continue to the call RCU
5036 * here. If the deletion is successful, the application is not visible
5037 * anymore by other threads and is it fails it means that it was already
5038 * deleted from the hash table so either way we just have to close the
5041 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5047 * Close socket after a grace period to avoid for the socket to be reused
5048 * before the application object is freed creating potential race between
5049 * threads trying to add unique in the global hash table.
5052 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5057 * Destroy a ust app data structure and free its memory.
5059 void ust_app_destroy(struct ust_app
*app
)
5065 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5069 * Take a snapshot for a given UST session. The snapshot is sent to the given
5072 * Return 0 on success or else a negative value.
5074 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5075 struct snapshot_output
*output
, int wait
,
5076 uint64_t nb_packets_per_stream
)
5079 unsigned int snapshot_done
= 0;
5080 struct lttng_ht_iter iter
;
5081 struct ust_app
*app
;
5082 char pathname
[PATH_MAX
];
5089 switch (usess
->buffer_type
) {
5090 case LTTNG_BUFFER_PER_UID
:
5092 struct buffer_reg_uid
*reg
;
5094 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5095 struct buffer_reg_channel
*reg_chan
;
5096 struct consumer_socket
*socket
;
5098 /* Get consumer socket to use to push the metadata.*/
5099 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5106 memset(pathname
, 0, sizeof(pathname
));
5107 ret
= snprintf(pathname
, sizeof(pathname
),
5108 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5109 reg
->uid
, reg
->bits_per_long
);
5111 PERROR("snprintf snapshot path");
5115 /* Add the UST default trace dir to path. */
5116 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5117 reg_chan
, node
.node
) {
5118 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5119 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5120 nb_packets_per_stream
);
5125 ret
= consumer_snapshot_channel(socket
,
5126 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5127 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5135 case LTTNG_BUFFER_PER_PID
:
5137 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5138 struct consumer_socket
*socket
;
5139 struct lttng_ht_iter chan_iter
;
5140 struct ust_app_channel
*ua_chan
;
5141 struct ust_app_session
*ua_sess
;
5142 struct ust_registry_session
*registry
;
5144 ua_sess
= lookup_session_by_app(usess
, app
);
5146 /* Session not associated with this app. */
5150 /* Get the right consumer socket for the application. */
5151 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5158 /* Add the UST default trace dir to path. */
5159 memset(pathname
, 0, sizeof(pathname
));
5160 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5163 PERROR("snprintf snapshot path");
5167 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5168 ua_chan
, node
.node
) {
5169 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5170 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5171 nb_packets_per_stream
);
5177 registry
= get_session_registry(ua_sess
);
5179 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5180 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5193 if (!snapshot_done
) {
5195 * If no snapshot was made and we are not in the error path, this means
5196 * that there are no buffers thus no (prior) application to snapshot
5197 * data from so we have simply NO data.
5208 * Return the size taken by one more packet per stream.
5210 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5211 uint64_t cur_nr_packets
)
5213 uint64_t tot_size
= 0;
5214 struct ust_app
*app
;
5215 struct lttng_ht_iter iter
;
5219 switch (usess
->buffer_type
) {
5220 case LTTNG_BUFFER_PER_UID
:
5222 struct buffer_reg_uid
*reg
;
5224 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5225 struct buffer_reg_channel
*reg_chan
;
5228 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5229 reg_chan
, node
.node
) {
5230 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5232 * Don't take channel into account if we
5233 * already grab all its packets.
5237 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5243 case LTTNG_BUFFER_PER_PID
:
5246 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5247 struct ust_app_channel
*ua_chan
;
5248 struct ust_app_session
*ua_sess
;
5249 struct lttng_ht_iter chan_iter
;
5251 ua_sess
= lookup_session_by_app(usess
, app
);
5253 /* Session not associated with this app. */
5257 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5258 ua_chan
, node
.node
) {
5259 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5261 * Don't take channel into account if we
5262 * already grab all its packets.
5266 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;