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
);
585 pthread_mutex_unlock(®istry
->lock
);
590 * Send to the consumer a close metadata command for the given session. Once
591 * done, the metadata channel is deleted and the session metadata pointer is
592 * nullified. The session lock MUST be held unless the application is
593 * in the destroy path.
595 * Return 0 on success else a negative value.
597 static int close_metadata(struct ust_registry_session
*registry
,
598 struct consumer_output
*consumer
)
601 struct consumer_socket
*socket
;
608 pthread_mutex_lock(®istry
->lock
);
610 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
615 /* Get consumer socket to use to push the metadata.*/
616 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
623 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
630 * Metadata closed. Even on error this means that the consumer is not
631 * responding or not found so either way a second close should NOT be emit
634 registry
->metadata_closed
= 1;
636 pthread_mutex_unlock(®istry
->lock
);
642 * We need to execute ht_destroy outside of RCU read-side critical
643 * section and outside of call_rcu thread, so we postpone its execution
644 * using ht_cleanup_push. It is simpler than to change the semantic of
645 * the many callers of delete_ust_app_session().
648 void delete_ust_app_session_rcu(struct rcu_head
*head
)
650 struct ust_app_session
*ua_sess
=
651 caa_container_of(head
, struct ust_app_session
, rcu_head
);
653 ht_cleanup_push(ua_sess
->channels
);
658 * Delete ust app session safely. RCU read lock must be held before calling
662 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
666 struct lttng_ht_iter iter
;
667 struct ust_app_channel
*ua_chan
;
668 struct ust_registry_session
*registry
;
672 pthread_mutex_lock(&ua_sess
->lock
);
674 registry
= get_session_registry(ua_sess
);
676 /* Push metadata for application before freeing the application. */
677 (void) push_metadata(registry
, ua_sess
->consumer
);
680 * Don't ask to close metadata for global per UID buffers. Close
681 * metadata only on destroy trace session in this case. Also, the
682 * previous push metadata could have flag the metadata registry to
683 * close so don't send a close command if closed.
685 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
686 /* And ask to close it for this session registry. */
687 (void) close_metadata(registry
, ua_sess
->consumer
);
691 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
693 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
695 delete_ust_app_channel(sock
, ua_chan
, app
);
698 /* In case of per PID, the registry is kept in the session. */
699 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
700 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
702 buffer_reg_pid_remove(reg_pid
);
703 buffer_reg_pid_destroy(reg_pid
);
707 if (ua_sess
->handle
!= -1) {
708 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
709 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
710 ERR("UST app sock %d release session handle failed with ret %d",
714 pthread_mutex_unlock(&ua_sess
->lock
);
716 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
720 * Delete a traceable application structure from the global list. Never call
721 * this function outside of a call_rcu call.
723 * RCU read side lock should _NOT_ be held when calling this function.
726 void delete_ust_app(struct ust_app
*app
)
729 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
731 /* Delete ust app sessions info */
736 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
738 /* Free every object in the session and the session. */
740 delete_ust_app_session(sock
, ua_sess
, app
);
744 ht_cleanup_push(app
->sessions
);
745 ht_cleanup_push(app
->ust_objd
);
748 * Wait until we have deleted the application from the sock hash table
749 * before closing this socket, otherwise an application could re-use the
750 * socket ID and race with the teardown, using the same hash table entry.
752 * It's OK to leave the close in call_rcu. We want it to stay unique for
753 * all RCU readers that could run concurrently with unregister app,
754 * therefore we _need_ to only close that socket after a grace period. So
755 * it should stay in this RCU callback.
757 * This close() is a very important step of the synchronization model so
758 * every modification to this function must be carefully reviewed.
764 lttng_fd_put(LTTNG_FD_APPS
, 1);
766 DBG2("UST app pid %d deleted", app
->pid
);
771 * URCU intermediate call to delete an UST app.
774 void delete_ust_app_rcu(struct rcu_head
*head
)
776 struct lttng_ht_node_ulong
*node
=
777 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
778 struct ust_app
*app
=
779 caa_container_of(node
, struct ust_app
, pid_n
);
781 DBG3("Call RCU deleting app PID %d", app
->pid
);
786 * Delete the session from the application ht and delete the data structure by
787 * freeing every object inside and releasing them.
789 static void destroy_app_session(struct ust_app
*app
,
790 struct ust_app_session
*ua_sess
)
793 struct lttng_ht_iter iter
;
798 iter
.iter
.node
= &ua_sess
->node
.node
;
799 ret
= lttng_ht_del(app
->sessions
, &iter
);
801 /* Already scheduled for teardown. */
805 /* Once deleted, free the data structure. */
806 delete_ust_app_session(app
->sock
, ua_sess
, app
);
813 * Alloc new UST app session.
816 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
818 struct ust_app_session
*ua_sess
;
820 /* Init most of the default value by allocating and zeroing */
821 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
822 if (ua_sess
== NULL
) {
827 ua_sess
->handle
= -1;
828 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
829 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
830 pthread_mutex_init(&ua_sess
->lock
, NULL
);
839 * Alloc new UST app channel.
842 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
843 struct ust_app_session
*ua_sess
,
844 struct lttng_ust_channel_attr
*attr
)
846 struct ust_app_channel
*ua_chan
;
848 /* Init most of the default value by allocating and zeroing */
849 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
850 if (ua_chan
== NULL
) {
855 /* Setup channel name */
856 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
857 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
859 ua_chan
->enabled
= 1;
860 ua_chan
->handle
= -1;
861 ua_chan
->session
= ua_sess
;
862 ua_chan
->key
= get_next_channel_key();
863 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
864 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
865 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
867 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
868 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
870 /* Copy attributes */
872 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
873 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
874 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
875 ua_chan
->attr
.overwrite
= attr
->overwrite
;
876 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
877 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
878 ua_chan
->attr
.output
= attr
->output
;
880 /* By default, the channel is a per cpu channel. */
881 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
883 DBG3("UST app channel %s allocated", ua_chan
->name
);
892 * Allocate and initialize a UST app stream.
894 * Return newly allocated stream pointer or NULL on error.
896 struct ust_app_stream
*ust_app_alloc_stream(void)
898 struct ust_app_stream
*stream
= NULL
;
900 stream
= zmalloc(sizeof(*stream
));
901 if (stream
== NULL
) {
902 PERROR("zmalloc ust app stream");
906 /* Zero could be a valid value for a handle so flag it to -1. */
914 * Alloc new UST app event.
917 struct ust_app_event
*alloc_ust_app_event(char *name
,
918 struct lttng_ust_event
*attr
)
920 struct ust_app_event
*ua_event
;
922 /* Init most of the default value by allocating and zeroing */
923 ua_event
= zmalloc(sizeof(struct ust_app_event
));
924 if (ua_event
== NULL
) {
929 ua_event
->enabled
= 1;
930 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
931 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
932 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
934 /* Copy attributes */
936 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
939 DBG3("UST app event %s allocated", ua_event
->name
);
948 * Alloc new UST app context.
951 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
953 struct ust_app_ctx
*ua_ctx
;
955 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
956 if (ua_ctx
== NULL
) {
960 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
963 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
966 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
973 * Allocate a filter and copy the given original filter.
975 * Return allocated filter or NULL on error.
977 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
978 struct lttng_ust_filter_bytecode
*orig_f
)
980 struct lttng_ust_filter_bytecode
*filter
= NULL
;
982 /* Copy filter bytecode */
983 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
985 PERROR("zmalloc alloc ust app filter");
989 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
996 * Find an ust_app using the sock and return it. RCU read side lock must be
997 * held before calling this helper function.
999 struct ust_app
*ust_app_find_by_sock(int sock
)
1001 struct lttng_ht_node_ulong
*node
;
1002 struct lttng_ht_iter iter
;
1004 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1005 node
= lttng_ht_iter_get_node_ulong(&iter
);
1007 DBG2("UST app find by sock %d not found", sock
);
1011 return caa_container_of(node
, struct ust_app
, sock_n
);
1018 * Find an ust_app using the notify sock and return it. RCU read side lock must
1019 * be held before calling this helper function.
1021 static struct ust_app
*find_app_by_notify_sock(int sock
)
1023 struct lttng_ht_node_ulong
*node
;
1024 struct lttng_ht_iter iter
;
1026 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1028 node
= lttng_ht_iter_get_node_ulong(&iter
);
1030 DBG2("UST app find by notify sock %d not found", sock
);
1034 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1041 * Lookup for an ust app event based on event name, filter bytecode and the
1044 * Return an ust_app_event object or NULL on error.
1046 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1047 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1048 const struct lttng_event_exclusion
*exclusion
)
1050 struct lttng_ht_iter iter
;
1051 struct lttng_ht_node_str
*node
;
1052 struct ust_app_event
*event
= NULL
;
1053 struct ust_app_ht_key key
;
1058 /* Setup key for event lookup. */
1060 key
.filter
= filter
;
1061 key
.loglevel
= loglevel
;
1062 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1063 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1065 /* Lookup using the event name as hash and a custom match fct. */
1066 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1067 ht_match_ust_app_event
, &key
, &iter
.iter
);
1068 node
= lttng_ht_iter_get_node_str(&iter
);
1073 event
= caa_container_of(node
, struct ust_app_event
, node
);
1080 * Create the channel context on the tracer.
1082 * Called with UST app session lock held.
1085 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1086 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1090 health_code_update();
1092 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1093 ua_chan
->obj
, &ua_ctx
->obj
);
1095 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1096 ERR("UST app create channel context failed for app (pid: %d) "
1097 "with ret %d", app
->pid
, ret
);
1100 * This is normal behavior, an application can die during the
1101 * creation process. Don't report an error so the execution can
1102 * continue normally.
1105 DBG3("UST app disable event failed. Application is dead.");
1110 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1112 DBG2("UST app context handle %d created successfully for channel %s",
1113 ua_ctx
->handle
, ua_chan
->name
);
1116 health_code_update();
1121 * Set the filter on the tracer.
1124 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1125 struct ust_app
*app
)
1129 health_code_update();
1131 if (!ua_event
->filter
) {
1136 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1139 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1140 ERR("UST app event %s filter failed for app (pid: %d) "
1141 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1144 * This is normal behavior, an application can die during the
1145 * creation process. Don't report an error so the execution can
1146 * continue normally.
1149 DBG3("UST app filter event failed. Application is dead.");
1154 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1157 health_code_update();
1162 * Set event exclusions on the tracer.
1165 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1166 struct ust_app
*app
)
1170 health_code_update();
1172 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1177 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1180 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1181 ERR("UST app event %s exclusions failed for app (pid: %d) "
1182 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1185 * This is normal behavior, an application can die during the
1186 * creation process. Don't report an error so the execution can
1187 * continue normally.
1190 DBG3("UST app event exclusion failed. Application is dead.");
1195 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1198 health_code_update();
1203 * Disable the specified event on to UST tracer for the UST session.
1205 static int disable_ust_event(struct ust_app
*app
,
1206 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1210 health_code_update();
1212 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1214 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1215 ERR("UST app event %s disable failed for app (pid: %d) "
1216 "and session handle %d with ret %d",
1217 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1220 * This is normal behavior, an application can die during the
1221 * creation process. Don't report an error so the execution can
1222 * continue normally.
1225 DBG3("UST app disable event failed. Application is dead.");
1230 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1231 ua_event
->attr
.name
, app
->pid
);
1234 health_code_update();
1239 * Disable the specified channel on to UST tracer for the UST session.
1241 static int disable_ust_channel(struct ust_app
*app
,
1242 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1246 health_code_update();
1248 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1250 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1251 ERR("UST app channel %s disable failed for app (pid: %d) "
1252 "and session handle %d with ret %d",
1253 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1256 * This is normal behavior, an application can die during the
1257 * creation process. Don't report an error so the execution can
1258 * continue normally.
1261 DBG3("UST app disable channel failed. Application is dead.");
1266 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1267 ua_chan
->name
, app
->pid
);
1270 health_code_update();
1275 * Enable the specified channel on to UST tracer for the UST session.
1277 static int enable_ust_channel(struct ust_app
*app
,
1278 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1282 health_code_update();
1284 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1286 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1287 ERR("UST app channel %s enable failed for app (pid: %d) "
1288 "and session handle %d with ret %d",
1289 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1292 * This is normal behavior, an application can die during the
1293 * creation process. Don't report an error so the execution can
1294 * continue normally.
1297 DBG3("UST app enable channel failed. Application is dead.");
1302 ua_chan
->enabled
= 1;
1304 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1305 ua_chan
->name
, app
->pid
);
1308 health_code_update();
1313 * Enable the specified event on to UST tracer for the UST session.
1315 static int enable_ust_event(struct ust_app
*app
,
1316 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1320 health_code_update();
1322 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1324 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1325 ERR("UST app event %s enable failed for app (pid: %d) "
1326 "and session handle %d with ret %d",
1327 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1330 * This is normal behavior, an application can die during the
1331 * creation process. Don't report an error so the execution can
1332 * continue normally.
1335 DBG3("UST app enable event failed. Application is dead.");
1340 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1341 ua_event
->attr
.name
, app
->pid
);
1344 health_code_update();
1349 * Send channel and stream buffer to application.
1351 * Return 0 on success. On error, a negative value is returned.
1353 static int send_channel_pid_to_ust(struct ust_app
*app
,
1354 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1357 struct ust_app_stream
*stream
, *stmp
;
1363 health_code_update();
1365 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1368 /* Send channel to the application. */
1369 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1374 health_code_update();
1376 /* Send all streams to application. */
1377 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1378 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1382 /* We don't need the stream anymore once sent to the tracer. */
1383 cds_list_del(&stream
->list
);
1384 delete_ust_app_stream(-1, stream
);
1386 /* Flag the channel that it is sent to the application. */
1387 ua_chan
->is_sent
= 1;
1390 health_code_update();
1395 * Create the specified event onto the UST tracer for a UST session.
1397 * Should be called with session mutex held.
1400 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1401 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1405 health_code_update();
1407 /* Create UST event on tracer */
1408 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1411 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1412 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1413 ua_event
->attr
.name
, app
->pid
, ret
);
1416 * This is normal behavior, an application can die during the
1417 * creation process. Don't report an error so the execution can
1418 * continue normally.
1421 DBG3("UST app create event failed. Application is dead.");
1426 ua_event
->handle
= ua_event
->obj
->handle
;
1428 DBG2("UST app event %s created successfully for pid:%d",
1429 ua_event
->attr
.name
, app
->pid
);
1431 health_code_update();
1433 /* Set filter if one is present. */
1434 if (ua_event
->filter
) {
1435 ret
= set_ust_event_filter(ua_event
, app
);
1441 /* Set exclusions for the event */
1442 if (ua_event
->exclusion
) {
1443 ret
= set_ust_event_exclusion(ua_event
, app
);
1449 /* If event not enabled, disable it on the tracer */
1450 if (ua_event
->enabled
) {
1452 * We now need to explicitly enable the event, since it
1453 * is now disabled at creation.
1455 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1458 * If we hit an EPERM, something is wrong with our enable call. If
1459 * we get an EEXIST, there is a problem on the tracer side since we
1463 case -LTTNG_UST_ERR_PERM
:
1464 /* Code flow problem */
1466 case -LTTNG_UST_ERR_EXIST
:
1467 /* It's OK for our use case. */
1478 health_code_update();
1483 * Copy data between an UST app event and a LTT event.
1485 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1486 struct ltt_ust_event
*uevent
)
1488 size_t exclusion_alloc_size
;
1490 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1491 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1493 ua_event
->enabled
= uevent
->enabled
;
1495 /* Copy event attributes */
1496 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1498 /* Copy filter bytecode */
1499 if (uevent
->filter
) {
1500 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1501 /* Filter might be NULL here in case of ENONEM. */
1504 /* Copy exclusion data */
1505 if (uevent
->exclusion
) {
1506 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1507 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1508 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1509 if (ua_event
->exclusion
== NULL
) {
1512 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1513 exclusion_alloc_size
);
1519 * Copy data between an UST app channel and a LTT channel.
1521 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1522 struct ltt_ust_channel
*uchan
)
1524 struct lttng_ht_iter iter
;
1525 struct ltt_ust_event
*uevent
;
1526 struct ltt_ust_context
*uctx
;
1527 struct ust_app_event
*ua_event
;
1528 struct ust_app_ctx
*ua_ctx
;
1530 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1532 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1533 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1535 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1536 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1538 /* Copy event attributes since the layout is different. */
1539 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1540 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1541 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1542 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1543 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1544 ua_chan
->attr
.output
= uchan
->attr
.output
;
1546 * Note that the attribute channel type is not set since the channel on the
1547 * tracing registry side does not have this information.
1550 ua_chan
->enabled
= uchan
->enabled
;
1551 ua_chan
->tracing_channel_id
= uchan
->id
;
1553 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1554 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1555 if (ua_ctx
== NULL
) {
1558 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1559 (unsigned long) ua_ctx
->ctx
.ctx
);
1560 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1561 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1564 /* Copy all events from ltt ust channel to ust app channel */
1565 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1566 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1567 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1568 if (ua_event
== NULL
) {
1569 DBG2("UST event %s not found on shadow copy channel",
1571 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1572 if (ua_event
== NULL
) {
1575 shadow_copy_event(ua_event
, uevent
);
1576 add_unique_ust_app_event(ua_chan
, ua_event
);
1580 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1584 * Copy data between a UST app session and a regular LTT session.
1586 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1587 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1589 struct lttng_ht_node_str
*ua_chan_node
;
1590 struct lttng_ht_iter iter
;
1591 struct ltt_ust_channel
*uchan
;
1592 struct ust_app_channel
*ua_chan
;
1594 struct tm
*timeinfo
;
1598 /* Get date and time for unique app path */
1600 timeinfo
= localtime(&rawtime
);
1601 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1603 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1605 ua_sess
->tracing_id
= usess
->id
;
1606 ua_sess
->id
= get_next_session_id();
1607 ua_sess
->uid
= app
->uid
;
1608 ua_sess
->gid
= app
->gid
;
1609 ua_sess
->euid
= usess
->uid
;
1610 ua_sess
->egid
= usess
->gid
;
1611 ua_sess
->buffer_type
= usess
->buffer_type
;
1612 ua_sess
->bits_per_long
= app
->bits_per_long
;
1613 /* There is only one consumer object per session possible. */
1614 ua_sess
->consumer
= usess
->consumer
;
1615 ua_sess
->output_traces
= usess
->output_traces
;
1616 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1617 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1618 &usess
->metadata_attr
);
1620 switch (ua_sess
->buffer_type
) {
1621 case LTTNG_BUFFER_PER_PID
:
1622 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1623 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1626 case LTTNG_BUFFER_PER_UID
:
1627 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1628 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1635 PERROR("asprintf UST shadow copy session");
1640 /* Iterate over all channels in global domain. */
1641 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1643 struct lttng_ht_iter uiter
;
1645 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1646 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1647 if (ua_chan_node
!= NULL
) {
1648 /* Session exist. Contiuing. */
1652 DBG2("Channel %s not found on shadow session copy, creating it",
1654 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1655 if (ua_chan
== NULL
) {
1656 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1659 shadow_copy_channel(ua_chan
, uchan
);
1661 * The concept of metadata channel does not exist on the tracing
1662 * registry side of the session daemon so this can only be a per CPU
1663 * channel and not metadata.
1665 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1667 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1675 * Lookup sesison wrapper.
1678 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1679 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1681 /* Get right UST app session from app */
1682 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1686 * Return ust app session from the app session hashtable using the UST session
1689 static struct ust_app_session
*lookup_session_by_app(
1690 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1692 struct lttng_ht_iter iter
;
1693 struct lttng_ht_node_u64
*node
;
1695 __lookup_session_by_app(usess
, app
, &iter
);
1696 node
= lttng_ht_iter_get_node_u64(&iter
);
1701 return caa_container_of(node
, struct ust_app_session
, node
);
1708 * Setup buffer registry per PID for the given session and application. If none
1709 * is found, a new one is created, added to the global registry and
1710 * initialized. If regp is valid, it's set with the newly created object.
1712 * Return 0 on success or else a negative value.
1714 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1715 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1718 struct buffer_reg_pid
*reg_pid
;
1725 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1728 * This is the create channel path meaning that if there is NO
1729 * registry available, we have to create one for this session.
1731 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1739 /* Initialize registry. */
1740 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1741 app
->bits_per_long
, app
->uint8_t_alignment
,
1742 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1743 app
->uint64_t_alignment
, app
->long_alignment
,
1744 app
->byte_order
, app
->version
.major
,
1745 app
->version
.minor
);
1748 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1749 * destroy the buffer registry, because it is always expected
1750 * that if the buffer registry can be found, its ust registry is
1753 buffer_reg_pid_destroy(reg_pid
);
1757 buffer_reg_pid_add(reg_pid
);
1759 DBG3("UST app buffer registry per PID created successfully");
1771 * Setup buffer registry per UID for the given session and application. If none
1772 * is found, a new one is created, added to the global registry and
1773 * initialized. If regp is valid, it's set with the newly created object.
1775 * Return 0 on success or else a negative value.
1777 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1778 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1781 struct buffer_reg_uid
*reg_uid
;
1788 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1791 * This is the create channel path meaning that if there is NO
1792 * registry available, we have to create one for this session.
1794 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1795 LTTNG_DOMAIN_UST
, ®_uid
);
1803 /* Initialize registry. */
1804 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1805 app
->bits_per_long
, app
->uint8_t_alignment
,
1806 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1807 app
->uint64_t_alignment
, app
->long_alignment
,
1808 app
->byte_order
, app
->version
.major
,
1809 app
->version
.minor
);
1812 * reg_uid->registry->reg.ust is NULL upon error, so we need to
1813 * destroy the buffer registry, because it is always expected
1814 * that if the buffer registry can be found, its ust registry is
1817 buffer_reg_uid_destroy(reg_uid
, NULL
);
1820 /* Add node to teardown list of the session. */
1821 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1823 buffer_reg_uid_add(reg_uid
);
1825 DBG3("UST app buffer registry per UID created successfully");
1836 * Create a session on the tracer side for the given app.
1838 * On success, ua_sess_ptr is populated with the session pointer or else left
1839 * untouched. If the session was created, is_created is set to 1. On error,
1840 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1843 * Returns 0 on success or else a negative code which is either -ENOMEM or
1844 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1846 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1847 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1850 int ret
, created
= 0;
1851 struct ust_app_session
*ua_sess
;
1855 assert(ua_sess_ptr
);
1857 health_code_update();
1859 ua_sess
= lookup_session_by_app(usess
, app
);
1860 if (ua_sess
== NULL
) {
1861 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1862 app
->pid
, usess
->id
);
1863 ua_sess
= alloc_ust_app_session(app
);
1864 if (ua_sess
== NULL
) {
1865 /* Only malloc can failed so something is really wrong */
1869 shadow_copy_session(ua_sess
, usess
, app
);
1873 switch (usess
->buffer_type
) {
1874 case LTTNG_BUFFER_PER_PID
:
1875 /* Init local registry. */
1876 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1878 delete_ust_app_session(-1, ua_sess
, app
);
1882 case LTTNG_BUFFER_PER_UID
:
1883 /* Look for a global registry. If none exists, create one. */
1884 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1886 delete_ust_app_session(-1, ua_sess
, app
);
1896 health_code_update();
1898 if (ua_sess
->handle
== -1) {
1899 ret
= ustctl_create_session(app
->sock
);
1901 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1902 ERR("Creating session for app pid %d with ret %d",
1905 DBG("UST app creating session failed. Application is dead");
1907 * This is normal behavior, an application can die during the
1908 * creation process. Don't report an error so the execution can
1909 * continue normally. This will get flagged ENOTCONN and the
1910 * caller will handle it.
1914 delete_ust_app_session(-1, ua_sess
, app
);
1915 if (ret
!= -ENOMEM
) {
1917 * Tracer is probably gone or got an internal error so let's
1918 * behave like it will soon unregister or not usable.
1925 ua_sess
->handle
= ret
;
1927 /* Add ust app session to app's HT */
1928 lttng_ht_node_init_u64(&ua_sess
->node
,
1929 ua_sess
->tracing_id
);
1930 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1932 DBG2("UST app session created successfully with handle %d", ret
);
1935 *ua_sess_ptr
= ua_sess
;
1937 *is_created
= created
;
1940 /* Everything went well. */
1944 health_code_update();
1949 * Match function for a hash table lookup of ust_app_ctx.
1951 * It matches an ust app context based on the context type and, in the case
1952 * of perf counters, their name.
1954 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1956 struct ust_app_ctx
*ctx
;
1957 const struct lttng_ust_context
*key
;
1962 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1966 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1970 /* Check the name in the case of perf thread counters. */
1971 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1972 if (strncmp(key
->u
.perf_counter
.name
,
1973 ctx
->ctx
.u
.perf_counter
.name
,
1974 sizeof(key
->u
.perf_counter
.name
))) {
1987 * Lookup for an ust app context from an lttng_ust_context.
1989 * Must be called while holding RCU read side lock.
1990 * Return an ust_app_ctx object or NULL on error.
1993 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
1994 struct lttng_ust_context
*uctx
)
1996 struct lttng_ht_iter iter
;
1997 struct lttng_ht_node_ulong
*node
;
1998 struct ust_app_ctx
*app_ctx
= NULL
;
2003 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2004 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2005 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2006 node
= lttng_ht_iter_get_node_ulong(&iter
);
2011 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2018 * Create a context for the channel on the tracer.
2020 * Called with UST app session lock held and a RCU read side lock.
2023 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2024 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2025 struct ust_app
*app
)
2028 struct ust_app_ctx
*ua_ctx
;
2030 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2032 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2038 ua_ctx
= alloc_ust_app_ctx(uctx
);
2039 if (ua_ctx
== NULL
) {
2045 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2046 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2047 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2049 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2059 * Enable on the tracer side a ust app event for the session and channel.
2061 * Called with UST app session lock held.
2064 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2065 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2069 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2074 ua_event
->enabled
= 1;
2081 * Disable on the tracer side a ust app event for the session and channel.
2083 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2084 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2088 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2093 ua_event
->enabled
= 0;
2100 * Lookup ust app channel for session and disable it on the tracer side.
2103 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2104 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2108 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2113 ua_chan
->enabled
= 0;
2120 * Lookup ust app channel for session and enable it on the tracer side. This
2121 * MUST be called with a RCU read side lock acquired.
2123 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2124 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2127 struct lttng_ht_iter iter
;
2128 struct lttng_ht_node_str
*ua_chan_node
;
2129 struct ust_app_channel
*ua_chan
;
2131 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2132 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2133 if (ua_chan_node
== NULL
) {
2134 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2135 uchan
->name
, ua_sess
->tracing_id
);
2139 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2141 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2151 * Ask the consumer to create a channel and get it if successful.
2153 * Return 0 on success or else a negative value.
2155 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2156 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2157 int bitness
, struct ust_registry_session
*registry
)
2160 unsigned int nb_fd
= 0;
2161 struct consumer_socket
*socket
;
2169 health_code_update();
2171 /* Get the right consumer socket for the application. */
2172 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2178 health_code_update();
2180 /* Need one fd for the channel. */
2181 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2183 ERR("Exhausted number of available FD upon create channel");
2188 * Ask consumer to create channel. The consumer will return the number of
2189 * stream we have to expect.
2191 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2198 * Compute the number of fd needed before receiving them. It must be 2 per
2199 * stream (2 being the default value here).
2201 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2203 /* Reserve the amount of file descriptor we need. */
2204 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2206 ERR("Exhausted number of available FD upon create channel");
2207 goto error_fd_get_stream
;
2210 health_code_update();
2213 * Now get the channel from the consumer. This call wil populate the stream
2214 * list of that channel and set the ust objects.
2216 if (usess
->consumer
->enabled
) {
2217 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2227 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2228 error_fd_get_stream
:
2230 * Initiate a destroy channel on the consumer since we had an error
2231 * handling it on our side. The return value is of no importance since we
2232 * already have a ret value set by the previous error that we need to
2235 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2237 lttng_fd_put(LTTNG_FD_APPS
, 1);
2239 health_code_update();
2245 * Duplicate the ust data object of the ust app stream and save it in the
2246 * buffer registry stream.
2248 * Return 0 on success or else a negative value.
2250 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2251 struct ust_app_stream
*stream
)
2258 /* Reserve the amount of file descriptor we need. */
2259 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2261 ERR("Exhausted number of available FD upon duplicate stream");
2265 /* Duplicate object for stream once the original is in the registry. */
2266 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2267 reg_stream
->obj
.ust
);
2269 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2270 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2271 lttng_fd_put(LTTNG_FD_APPS
, 2);
2274 stream
->handle
= stream
->obj
->handle
;
2281 * Duplicate the ust data object of the ust app. channel and save it in the
2282 * buffer registry channel.
2284 * Return 0 on success or else a negative value.
2286 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2287 struct ust_app_channel
*ua_chan
)
2294 /* Need two fds for the channel. */
2295 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2297 ERR("Exhausted number of available FD upon duplicate channel");
2301 /* Duplicate object for stream once the original is in the registry. */
2302 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2304 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2305 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2308 ua_chan
->handle
= ua_chan
->obj
->handle
;
2313 lttng_fd_put(LTTNG_FD_APPS
, 1);
2319 * For a given channel buffer registry, setup all streams of the given ust
2320 * application channel.
2322 * Return 0 on success or else a negative value.
2324 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2325 struct ust_app_channel
*ua_chan
)
2328 struct ust_app_stream
*stream
, *stmp
;
2333 DBG2("UST app setup buffer registry stream");
2335 /* Send all streams to application. */
2336 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2337 struct buffer_reg_stream
*reg_stream
;
2339 ret
= buffer_reg_stream_create(®_stream
);
2345 * Keep original pointer and nullify it in the stream so the delete
2346 * stream call does not release the object.
2348 reg_stream
->obj
.ust
= stream
->obj
;
2350 buffer_reg_stream_add(reg_stream
, reg_chan
);
2352 /* We don't need the streams anymore. */
2353 cds_list_del(&stream
->list
);
2354 delete_ust_app_stream(-1, stream
);
2362 * Create a buffer registry channel for the given session registry and
2363 * application channel object. If regp pointer is valid, it's set with the
2364 * created object. Important, the created object is NOT added to the session
2365 * registry hash table.
2367 * Return 0 on success else a negative value.
2369 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2370 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2373 struct buffer_reg_channel
*reg_chan
= NULL
;
2378 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2380 /* Create buffer registry channel. */
2381 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2386 reg_chan
->consumer_key
= ua_chan
->key
;
2387 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2388 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2390 /* Create and add a channel registry to session. */
2391 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2392 ua_chan
->tracing_channel_id
);
2396 buffer_reg_channel_add(reg_sess
, reg_chan
);
2405 /* Safe because the registry channel object was not added to any HT. */
2406 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2412 * Setup buffer registry channel for the given session registry and application
2413 * channel object. If regp pointer is valid, it's set with the created object.
2415 * Return 0 on success else a negative value.
2417 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2418 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2425 assert(ua_chan
->obj
);
2427 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2429 /* Setup all streams for the registry. */
2430 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2435 reg_chan
->obj
.ust
= ua_chan
->obj
;
2436 ua_chan
->obj
= NULL
;
2441 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2442 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2447 * Send buffer registry channel to the application.
2449 * Return 0 on success else a negative value.
2451 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2452 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2453 struct ust_app_channel
*ua_chan
)
2456 struct buffer_reg_stream
*reg_stream
;
2463 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2465 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2470 /* Send channel to the application. */
2471 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2476 health_code_update();
2478 /* Send all streams to application. */
2479 pthread_mutex_lock(®_chan
->stream_list_lock
);
2480 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2481 struct ust_app_stream stream
;
2483 ret
= duplicate_stream_object(reg_stream
, &stream
);
2485 goto error_stream_unlock
;
2488 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2490 (void) release_ust_app_stream(-1, &stream
);
2491 goto error_stream_unlock
;
2495 * The return value is not important here. This function will output an
2498 (void) release_ust_app_stream(-1, &stream
);
2500 ua_chan
->is_sent
= 1;
2502 error_stream_unlock
:
2503 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2509 * Create and send to the application the created buffers with per UID buffers.
2511 * Return 0 on success else a negative value.
2513 static int create_channel_per_uid(struct ust_app
*app
,
2514 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2515 struct ust_app_channel
*ua_chan
)
2518 struct buffer_reg_uid
*reg_uid
;
2519 struct buffer_reg_channel
*reg_chan
;
2526 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2528 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2530 * The session creation handles the creation of this global registry
2531 * object. If none can be find, there is a code flow problem or a
2536 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2539 /* Create the buffer registry channel object. */
2540 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2542 ERR("Error creating the UST channel \"%s\" registry instance",
2549 * Create the buffers on the consumer side. This call populates the
2550 * ust app channel object with all streams and data object.
2552 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2553 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2555 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2559 * Let's remove the previously created buffer registry channel so
2560 * it's not visible anymore in the session registry.
2562 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2563 ua_chan
->tracing_channel_id
);
2564 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2565 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2570 * Setup the streams and add it to the session registry.
2572 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2574 ERR("Error setting up UST channel \"%s\"",
2581 /* Send buffers to the application. */
2582 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2585 * Don't report error to the console, since it may be
2586 * caused by application concurrently exiting.
2596 * Create and send to the application the created buffers with per PID buffers.
2598 * Return 0 on success else a negative value.
2600 static int create_channel_per_pid(struct ust_app
*app
,
2601 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2602 struct ust_app_channel
*ua_chan
)
2605 struct ust_registry_session
*registry
;
2612 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2616 registry
= get_session_registry(ua_sess
);
2619 /* Create and add a new channel registry to session. */
2620 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2622 ERR("Error creating the UST channel \"%s\" registry instance",
2627 /* Create and get channel on the consumer side. */
2628 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2629 app
->bits_per_long
, registry
);
2631 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2636 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2639 * Don't report error to the console, since it may be
2640 * caused by application concurrently exiting.
2651 * From an already allocated ust app channel, create the channel buffers if
2652 * need and send it to the application. This MUST be called with a RCU read
2653 * side lock acquired.
2655 * Return 0 on success or else a negative value.
2657 static int do_create_channel(struct ust_app
*app
,
2658 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2659 struct ust_app_channel
*ua_chan
)
2668 /* Handle buffer type before sending the channel to the application. */
2669 switch (usess
->buffer_type
) {
2670 case LTTNG_BUFFER_PER_UID
:
2672 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2678 case LTTNG_BUFFER_PER_PID
:
2680 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2692 /* Initialize ust objd object using the received handle and add it. */
2693 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2694 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2696 /* If channel is not enabled, disable it on the tracer */
2697 if (!ua_chan
->enabled
) {
2698 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2709 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2710 * newly created channel if not NULL.
2712 * Called with UST app session lock and RCU read-side lock held.
2714 * Return 0 on success or else a negative value.
2716 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2717 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2718 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2719 struct ust_app_channel
**ua_chanp
)
2722 struct lttng_ht_iter iter
;
2723 struct lttng_ht_node_str
*ua_chan_node
;
2724 struct ust_app_channel
*ua_chan
;
2726 /* Lookup channel in the ust app session */
2727 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2728 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2729 if (ua_chan_node
!= NULL
) {
2730 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2734 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2735 if (ua_chan
== NULL
) {
2736 /* Only malloc can fail here */
2740 shadow_copy_channel(ua_chan
, uchan
);
2742 /* Set channel type. */
2743 ua_chan
->attr
.type
= type
;
2745 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2750 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2753 /* Only add the channel if successful on the tracer side. */
2754 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2758 *ua_chanp
= ua_chan
;
2761 /* Everything went well. */
2765 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2771 * Create UST app event and create it on the tracer side.
2773 * Called with ust app session mutex held.
2776 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2777 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2778 struct ust_app
*app
)
2781 struct ust_app_event
*ua_event
;
2783 /* Get event node */
2784 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2785 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2786 if (ua_event
!= NULL
) {
2791 /* Does not exist so create one */
2792 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2793 if (ua_event
== NULL
) {
2794 /* Only malloc can failed so something is really wrong */
2798 shadow_copy_event(ua_event
, uevent
);
2800 /* Create it on the tracer side */
2801 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2803 /* Not found previously means that it does not exist on the tracer */
2804 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2808 add_unique_ust_app_event(ua_chan
, ua_event
);
2810 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2817 /* Valid. Calling here is already in a read side lock */
2818 delete_ust_app_event(-1, ua_event
);
2823 * Create UST metadata and open it on the tracer side.
2825 * Called with UST app session lock held and RCU read side lock.
2827 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2828 struct ust_app
*app
, struct consumer_output
*consumer
)
2831 struct ust_app_channel
*metadata
;
2832 struct consumer_socket
*socket
;
2833 struct ust_registry_session
*registry
;
2839 registry
= get_session_registry(ua_sess
);
2842 pthread_mutex_lock(®istry
->lock
);
2844 /* Metadata already exists for this registry or it was closed previously */
2845 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2850 /* Allocate UST metadata */
2851 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2853 /* malloc() failed */
2858 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2860 /* Need one fd for the channel. */
2861 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2863 ERR("Exhausted number of available FD upon create metadata");
2867 /* Get the right consumer socket for the application. */
2868 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2871 goto error_consumer
;
2875 * Keep metadata key so we can identify it on the consumer side. Assign it
2876 * to the registry *before* we ask the consumer so we avoid the race of the
2877 * consumer requesting the metadata and the ask_channel call on our side
2878 * did not returned yet.
2880 registry
->metadata_key
= metadata
->key
;
2883 * Ask the metadata channel creation to the consumer. The metadata object
2884 * will be created by the consumer and kept their. However, the stream is
2885 * never added or monitored until we do a first push metadata to the
2888 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2891 /* Nullify the metadata key so we don't try to close it later on. */
2892 registry
->metadata_key
= 0;
2893 goto error_consumer
;
2897 * The setup command will make the metadata stream be sent to the relayd,
2898 * if applicable, and the thread managing the metadatas. This is important
2899 * because after this point, if an error occurs, the only way the stream
2900 * can be deleted is to be monitored in the consumer.
2902 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2904 /* Nullify the metadata key so we don't try to close it later on. */
2905 registry
->metadata_key
= 0;
2906 goto error_consumer
;
2909 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2910 metadata
->key
, app
->pid
);
2913 lttng_fd_put(LTTNG_FD_APPS
, 1);
2914 delete_ust_app_channel(-1, metadata
, app
);
2916 pthread_mutex_unlock(®istry
->lock
);
2921 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2922 * acquired before calling this function.
2924 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2926 struct ust_app
*app
= NULL
;
2927 struct lttng_ht_node_ulong
*node
;
2928 struct lttng_ht_iter iter
;
2930 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2931 node
= lttng_ht_iter_get_node_ulong(&iter
);
2933 DBG2("UST app no found with pid %d", pid
);
2937 DBG2("Found UST app by pid %d", pid
);
2939 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2946 * Allocate and init an UST app object using the registration information and
2947 * the command socket. This is called when the command socket connects to the
2950 * The object is returned on success or else NULL.
2952 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2954 struct ust_app
*lta
= NULL
;
2959 DBG3("UST app creating application for socket %d", sock
);
2961 if ((msg
->bits_per_long
== 64 &&
2962 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2963 || (msg
->bits_per_long
== 32 &&
2964 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2965 ERR("Registration failed: application \"%s\" (pid: %d) has "
2966 "%d-bit long, but no consumerd for this size is available.\n",
2967 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2971 lta
= zmalloc(sizeof(struct ust_app
));
2977 lta
->ppid
= msg
->ppid
;
2978 lta
->uid
= msg
->uid
;
2979 lta
->gid
= msg
->gid
;
2981 lta
->bits_per_long
= msg
->bits_per_long
;
2982 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2983 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2984 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2985 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2986 lta
->long_alignment
= msg
->long_alignment
;
2987 lta
->byte_order
= msg
->byte_order
;
2989 lta
->v_major
= msg
->major
;
2990 lta
->v_minor
= msg
->minor
;
2991 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2992 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2993 lta
->notify_sock
= -1;
2995 /* Copy name and make sure it's NULL terminated. */
2996 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2997 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3000 * Before this can be called, when receiving the registration information,
3001 * the application compatibility is checked. So, at this point, the
3002 * application can work with this session daemon.
3004 lta
->compatible
= 1;
3006 lta
->pid
= msg
->pid
;
3007 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3009 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3011 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3018 * For a given application object, add it to every hash table.
3020 void ust_app_add(struct ust_app
*app
)
3023 assert(app
->notify_sock
>= 0);
3028 * On a re-registration, we want to kick out the previous registration of
3031 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3034 * The socket _should_ be unique until _we_ call close. So, a add_unique
3035 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3036 * already in the table.
3038 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3040 /* Add application to the notify socket hash table. */
3041 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3042 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3044 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3045 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3046 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3053 * Set the application version into the object.
3055 * Return 0 on success else a negative value either an errno code or a
3056 * LTTng-UST error code.
3058 int ust_app_version(struct ust_app
*app
)
3064 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3066 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3067 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3069 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3077 * Unregister app by removing it from the global traceable app list and freeing
3080 * The socket is already closed at this point so no close to sock.
3082 void ust_app_unregister(int sock
)
3084 struct ust_app
*lta
;
3085 struct lttng_ht_node_ulong
*node
;
3086 struct lttng_ht_iter ust_app_sock_iter
;
3087 struct lttng_ht_iter iter
;
3088 struct ust_app_session
*ua_sess
;
3093 /* Get the node reference for a call_rcu */
3094 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3095 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3098 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3099 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3102 * For per-PID buffers, perform "push metadata" and flush all
3103 * application streams before removing app from hash tables,
3104 * ensuring proper behavior of data_pending check.
3105 * Remove sessions so they are not visible during deletion.
3107 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3109 struct ust_registry_session
*registry
;
3111 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3113 /* The session was already removed so scheduled for teardown. */
3117 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3118 (void) ust_app_flush_app_session(lta
, ua_sess
);
3122 * Add session to list for teardown. This is safe since at this point we
3123 * are the only one using this list.
3125 pthread_mutex_lock(&ua_sess
->lock
);
3128 * Normally, this is done in the delete session process which is
3129 * executed in the call rcu below. However, upon registration we can't
3130 * afford to wait for the grace period before pushing data or else the
3131 * data pending feature can race between the unregistration and stop
3132 * command where the data pending command is sent *before* the grace
3135 * The close metadata below nullifies the metadata pointer in the
3136 * session so the delete session will NOT push/close a second time.
3138 registry
= get_session_registry(ua_sess
);
3140 /* Push metadata for application before freeing the application. */
3141 (void) push_metadata(registry
, ua_sess
->consumer
);
3144 * Don't ask to close metadata for global per UID buffers. Close
3145 * metadata only on destroy trace session in this case. Also, the
3146 * previous push metadata could have flag the metadata registry to
3147 * close so don't send a close command if closed.
3149 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3150 /* And ask to close it for this session registry. */
3151 (void) close_metadata(registry
, ua_sess
->consumer
);
3154 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3156 pthread_mutex_unlock(&ua_sess
->lock
);
3159 /* Remove application from PID hash table */
3160 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3164 * Remove application from notify hash table. The thread handling the
3165 * notify socket could have deleted the node so ignore on error because
3166 * either way it's valid. The close of that socket is handled by the other
3169 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3170 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3173 * Ignore return value since the node might have been removed before by an
3174 * add replace during app registration because the PID can be reassigned by
3177 iter
.iter
.node
= <a
->pid_n
.node
;
3178 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3180 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3185 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3192 * Fill events array with all events name of all registered apps.
3194 int ust_app_list_events(struct lttng_event
**events
)
3197 size_t nbmem
, count
= 0;
3198 struct lttng_ht_iter iter
;
3199 struct ust_app
*app
;
3200 struct lttng_event
*tmp_event
;
3202 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3203 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3204 if (tmp_event
== NULL
) {
3205 PERROR("zmalloc ust app events");
3212 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3213 struct lttng_ust_tracepoint_iter uiter
;
3215 health_code_update();
3217 if (!app
->compatible
) {
3219 * TODO: In time, we should notice the caller of this error by
3220 * telling him that this is a version error.
3224 handle
= ustctl_tracepoint_list(app
->sock
);
3226 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3227 ERR("UST app list events getting handle failed for app pid %d",
3233 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3234 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3235 /* Handle ustctl error. */
3237 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3238 ERR("UST app tp list get failed for app %d with ret %d",
3241 DBG3("UST app tp list get failed. Application is dead");
3243 * This is normal behavior, an application can die during the
3244 * creation process. Don't report an error so the execution can
3245 * continue normally. Continue normal execution.
3253 health_code_update();
3254 if (count
>= nbmem
) {
3255 /* In case the realloc fails, we free the memory */
3256 struct lttng_event
*new_tmp_event
;
3259 new_nbmem
= nbmem
<< 1;
3260 DBG2("Reallocating event list from %zu to %zu entries",
3262 new_tmp_event
= realloc(tmp_event
,
3263 new_nbmem
* sizeof(struct lttng_event
));
3264 if (new_tmp_event
== NULL
) {
3265 PERROR("realloc ust app events");
3270 /* Zero the new memory */
3271 memset(new_tmp_event
+ nbmem
, 0,
3272 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3274 tmp_event
= new_tmp_event
;
3276 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3277 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3278 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3279 tmp_event
[count
].pid
= app
->pid
;
3280 tmp_event
[count
].enabled
= -1;
3286 *events
= tmp_event
;
3288 DBG2("UST app list events done (%zu events)", count
);
3293 health_code_update();
3298 * Fill events array with all events name of all registered apps.
3300 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3303 size_t nbmem
, count
= 0;
3304 struct lttng_ht_iter iter
;
3305 struct ust_app
*app
;
3306 struct lttng_event_field
*tmp_event
;
3308 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3309 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3310 if (tmp_event
== NULL
) {
3311 PERROR("zmalloc ust app event fields");
3318 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3319 struct lttng_ust_field_iter uiter
;
3321 health_code_update();
3323 if (!app
->compatible
) {
3325 * TODO: In time, we should notice the caller of this error by
3326 * telling him that this is a version error.
3330 handle
= ustctl_tracepoint_field_list(app
->sock
);
3332 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3333 ERR("UST app list field getting handle failed for app pid %d",
3339 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3340 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3341 /* Handle ustctl error. */
3343 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3344 ERR("UST app tp list field failed for app %d with ret %d",
3347 DBG3("UST app tp list field failed. Application is dead");
3349 * This is normal behavior, an application can die during the
3350 * creation process. Don't report an error so the execution can
3351 * continue normally. Reset list and count for next app.
3359 health_code_update();
3360 if (count
>= nbmem
) {
3361 /* In case the realloc fails, we free the memory */
3362 struct lttng_event_field
*new_tmp_event
;
3365 new_nbmem
= nbmem
<< 1;
3366 DBG2("Reallocating event field list from %zu to %zu entries",
3368 new_tmp_event
= realloc(tmp_event
,
3369 new_nbmem
* sizeof(struct lttng_event_field
));
3370 if (new_tmp_event
== NULL
) {
3371 PERROR("realloc ust app event fields");
3376 /* Zero the new memory */
3377 memset(new_tmp_event
+ nbmem
, 0,
3378 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3380 tmp_event
= new_tmp_event
;
3383 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3384 /* Mapping between these enums matches 1 to 1. */
3385 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3386 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3388 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3389 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3390 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3391 tmp_event
[count
].event
.pid
= app
->pid
;
3392 tmp_event
[count
].event
.enabled
= -1;
3398 *fields
= tmp_event
;
3400 DBG2("UST app list event fields done (%zu events)", count
);
3405 health_code_update();
3410 * Free and clean all traceable apps of the global list.
3412 * Should _NOT_ be called with RCU read-side lock held.
3414 void ust_app_clean_list(void)
3417 struct ust_app
*app
;
3418 struct lttng_ht_iter iter
;
3420 DBG2("UST app cleaning registered apps hash table");
3425 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3426 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3428 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3432 /* Cleanup socket hash table */
3433 if (ust_app_ht_by_sock
) {
3434 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3436 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3441 /* Cleanup notify socket hash table */
3442 if (ust_app_ht_by_notify_sock
) {
3443 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3444 notify_sock_n
.node
) {
3445 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3451 /* Destroy is done only when the ht is empty */
3453 ht_cleanup_push(ust_app_ht
);
3455 if (ust_app_ht_by_sock
) {
3456 ht_cleanup_push(ust_app_ht_by_sock
);
3458 if (ust_app_ht_by_notify_sock
) {
3459 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3464 * Init UST app hash table.
3466 int ust_app_ht_alloc(void)
3468 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3472 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3473 if (!ust_app_ht_by_sock
) {
3476 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3477 if (!ust_app_ht_by_notify_sock
) {
3484 * For a specific UST session, disable the channel for all registered apps.
3486 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3487 struct ltt_ust_channel
*uchan
)
3490 struct lttng_ht_iter iter
;
3491 struct lttng_ht_node_str
*ua_chan_node
;
3492 struct ust_app
*app
;
3493 struct ust_app_session
*ua_sess
;
3494 struct ust_app_channel
*ua_chan
;
3496 if (usess
== NULL
|| uchan
== NULL
) {
3497 ERR("Disabling UST global channel with NULL values");
3502 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3503 uchan
->name
, usess
->id
);
3507 /* For every registered applications */
3508 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3509 struct lttng_ht_iter uiter
;
3510 if (!app
->compatible
) {
3512 * TODO: In time, we should notice the caller of this error by
3513 * telling him that this is a version error.
3517 ua_sess
= lookup_session_by_app(usess
, app
);
3518 if (ua_sess
== NULL
) {
3523 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3524 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3525 /* If the session if found for the app, the channel must be there */
3526 assert(ua_chan_node
);
3528 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3529 /* The channel must not be already disabled */
3530 assert(ua_chan
->enabled
== 1);
3532 /* Disable channel onto application */
3533 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3535 /* XXX: We might want to report this error at some point... */
3547 * For a specific UST session, enable the channel for all registered apps.
3549 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3550 struct ltt_ust_channel
*uchan
)
3553 struct lttng_ht_iter iter
;
3554 struct ust_app
*app
;
3555 struct ust_app_session
*ua_sess
;
3557 if (usess
== NULL
|| uchan
== NULL
) {
3558 ERR("Adding UST global channel to NULL values");
3563 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3564 uchan
->name
, usess
->id
);
3568 /* For every registered applications */
3569 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3570 if (!app
->compatible
) {
3572 * TODO: In time, we should notice the caller of this error by
3573 * telling him that this is a version error.
3577 ua_sess
= lookup_session_by_app(usess
, app
);
3578 if (ua_sess
== NULL
) {
3582 /* Enable channel onto application */
3583 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3585 /* XXX: We might want to report this error at some point... */
3597 * Disable an event in a channel and for a specific session.
3599 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3600 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3603 struct lttng_ht_iter iter
, uiter
;
3604 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3605 struct ust_app
*app
;
3606 struct ust_app_session
*ua_sess
;
3607 struct ust_app_channel
*ua_chan
;
3608 struct ust_app_event
*ua_event
;
3610 DBG("UST app disabling event %s for all apps in channel "
3611 "%s for session id %" PRIu64
,
3612 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3616 /* For all registered applications */
3617 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3618 if (!app
->compatible
) {
3620 * TODO: In time, we should notice the caller of this error by
3621 * telling him that this is a version error.
3625 ua_sess
= lookup_session_by_app(usess
, app
);
3626 if (ua_sess
== NULL
) {
3631 /* Lookup channel in the ust app session */
3632 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3633 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3634 if (ua_chan_node
== NULL
) {
3635 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3636 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3639 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3641 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3642 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3643 if (ua_event_node
== NULL
) {
3644 DBG2("Event %s not found in channel %s for app pid %d."
3645 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3648 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3650 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3652 /* XXX: Report error someday... */
3663 * For a specific UST session, create the channel for all registered apps.
3665 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3666 struct ltt_ust_channel
*uchan
)
3668 int ret
= 0, created
;
3669 struct lttng_ht_iter iter
;
3670 struct ust_app
*app
;
3671 struct ust_app_session
*ua_sess
= NULL
;
3673 /* Very wrong code flow */
3677 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3678 uchan
->name
, usess
->id
);
3682 /* For every registered applications */
3683 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3684 if (!app
->compatible
) {
3686 * TODO: In time, we should notice the caller of this error by
3687 * telling him that this is a version error.
3692 * Create session on the tracer side and add it to app session HT. Note
3693 * that if session exist, it will simply return a pointer to the ust
3696 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3701 * The application's socket is not valid. Either a bad socket
3702 * or a timeout on it. We can't inform the caller that for a
3703 * specific app, the session failed so lets continue here.
3708 goto error_rcu_unlock
;
3713 pthread_mutex_lock(&ua_sess
->lock
);
3714 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3715 sizeof(uchan
->name
))) {
3716 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3719 /* Create channel onto application. We don't need the chan ref. */
3720 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3721 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3723 pthread_mutex_unlock(&ua_sess
->lock
);
3725 if (ret
== -ENOMEM
) {
3726 /* No more memory is a fatal error. Stop right now. */
3727 goto error_rcu_unlock
;
3729 /* Cleanup the created session if it's the case. */
3731 destroy_app_session(app
, ua_sess
);
3742 * Enable event for a specific session and channel on the tracer.
3744 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3745 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3748 struct lttng_ht_iter iter
, uiter
;
3749 struct lttng_ht_node_str
*ua_chan_node
;
3750 struct ust_app
*app
;
3751 struct ust_app_session
*ua_sess
;
3752 struct ust_app_channel
*ua_chan
;
3753 struct ust_app_event
*ua_event
;
3755 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3756 uevent
->attr
.name
, usess
->id
);
3759 * NOTE: At this point, this function is called only if the session and
3760 * channel passed are already created for all apps. and enabled on the
3766 /* For all registered applications */
3767 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3768 if (!app
->compatible
) {
3770 * TODO: In time, we should notice the caller of this error by
3771 * telling him that this is a version error.
3775 ua_sess
= lookup_session_by_app(usess
, app
);
3777 /* The application has problem or is probably dead. */
3781 pthread_mutex_lock(&ua_sess
->lock
);
3783 /* Lookup channel in the ust app session */
3784 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3785 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3786 /* If the channel is not found, there is a code flow error */
3787 assert(ua_chan_node
);
3789 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3791 /* Get event node */
3792 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3793 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3794 if (ua_event
== NULL
) {
3795 DBG3("UST app enable event %s not found for app PID %d."
3796 "Skipping app", uevent
->attr
.name
, app
->pid
);
3800 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3802 pthread_mutex_unlock(&ua_sess
->lock
);
3806 pthread_mutex_unlock(&ua_sess
->lock
);
3815 * For a specific existing UST session and UST channel, creates the event for
3816 * all registered apps.
3818 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3819 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3822 struct lttng_ht_iter iter
, uiter
;
3823 struct lttng_ht_node_str
*ua_chan_node
;
3824 struct ust_app
*app
;
3825 struct ust_app_session
*ua_sess
;
3826 struct ust_app_channel
*ua_chan
;
3828 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3829 uevent
->attr
.name
, usess
->id
);
3833 /* For all registered applications */
3834 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3835 if (!app
->compatible
) {
3837 * TODO: In time, we should notice the caller of this error by
3838 * telling him that this is a version error.
3842 ua_sess
= lookup_session_by_app(usess
, app
);
3844 /* The application has problem or is probably dead. */
3848 pthread_mutex_lock(&ua_sess
->lock
);
3849 /* Lookup channel in the ust app session */
3850 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3851 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3852 /* If the channel is not found, there is a code flow error */
3853 assert(ua_chan_node
);
3855 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3857 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3858 pthread_mutex_unlock(&ua_sess
->lock
);
3860 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3861 /* Possible value at this point: -ENOMEM. If so, we stop! */
3864 DBG2("UST app event %s already exist on app PID %d",
3865 uevent
->attr
.name
, app
->pid
);
3876 * Start tracing for a specific UST session and app.
3879 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3882 struct ust_app_session
*ua_sess
;
3884 DBG("Starting tracing for ust app pid %d", app
->pid
);
3888 if (!app
->compatible
) {
3892 ua_sess
= lookup_session_by_app(usess
, app
);
3893 if (ua_sess
== NULL
) {
3894 /* The session is in teardown process. Ignore and continue. */
3898 pthread_mutex_lock(&ua_sess
->lock
);
3900 /* Upon restart, we skip the setup, already done */
3901 if (ua_sess
->started
) {
3905 /* Create directories if consumer is LOCAL and has a path defined. */
3906 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3907 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3908 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3909 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3911 if (ret
!= -EEXIST
) {
3912 ERR("Trace directory creation error");
3919 * Create the metadata for the application. This returns gracefully if a
3920 * metadata was already set for the session.
3922 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3927 health_code_update();
3930 /* This start the UST tracing */
3931 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3933 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3934 ERR("Error starting tracing for app pid: %d (ret: %d)",
3937 DBG("UST app start session failed. Application is dead.");
3939 * This is normal behavior, an application can die during the
3940 * creation process. Don't report an error so the execution can
3941 * continue normally.
3943 pthread_mutex_unlock(&ua_sess
->lock
);
3949 /* Indicate that the session has been started once */
3950 ua_sess
->started
= 1;
3952 pthread_mutex_unlock(&ua_sess
->lock
);
3954 health_code_update();
3956 /* Quiescent wait after starting trace */
3957 ret
= ustctl_wait_quiescent(app
->sock
);
3958 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3959 ERR("UST app wait quiescent failed for app pid %d ret %d",
3965 health_code_update();
3969 pthread_mutex_unlock(&ua_sess
->lock
);
3971 health_code_update();
3976 * Stop tracing for a specific UST session and app.
3979 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3982 struct ust_app_session
*ua_sess
;
3983 struct ust_registry_session
*registry
;
3985 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3989 if (!app
->compatible
) {
3990 goto end_no_session
;
3993 ua_sess
= lookup_session_by_app(usess
, app
);
3994 if (ua_sess
== NULL
) {
3995 goto end_no_session
;
3998 pthread_mutex_lock(&ua_sess
->lock
);
4001 * If started = 0, it means that stop trace has been called for a session
4002 * that was never started. It's possible since we can have a fail start
4003 * from either the application manager thread or the command thread. Simply
4004 * indicate that this is a stop error.
4006 if (!ua_sess
->started
) {
4007 goto error_rcu_unlock
;
4010 health_code_update();
4012 /* This inhibits UST tracing */
4013 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4015 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4016 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4019 DBG("UST app stop session failed. Application is dead.");
4021 * This is normal behavior, an application can die during the
4022 * creation process. Don't report an error so the execution can
4023 * continue normally.
4027 goto error_rcu_unlock
;
4030 health_code_update();
4032 /* Quiescent wait after stopping trace */
4033 ret
= ustctl_wait_quiescent(app
->sock
);
4034 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4035 ERR("UST app wait quiescent failed for app pid %d ret %d",
4039 health_code_update();
4041 registry
= get_session_registry(ua_sess
);
4044 /* Push metadata for application before freeing the application. */
4045 (void) push_metadata(registry
, ua_sess
->consumer
);
4048 pthread_mutex_unlock(&ua_sess
->lock
);
4051 health_code_update();
4055 pthread_mutex_unlock(&ua_sess
->lock
);
4057 health_code_update();
4062 int ust_app_flush_app_session(struct ust_app
*app
,
4063 struct ust_app_session
*ua_sess
)
4065 int ret
, retval
= 0;
4066 struct lttng_ht_iter iter
;
4067 struct ust_app_channel
*ua_chan
;
4068 struct consumer_socket
*socket
;
4070 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4074 if (!app
->compatible
) {
4075 goto end_not_compatible
;
4078 pthread_mutex_lock(&ua_sess
->lock
);
4080 health_code_update();
4082 /* Flushing buffers */
4083 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4086 /* Flush buffers and push metadata. */
4087 switch (ua_sess
->buffer_type
) {
4088 case LTTNG_BUFFER_PER_PID
:
4089 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4091 health_code_update();
4092 assert(ua_chan
->is_sent
);
4093 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4095 ERR("Error flushing consumer channel");
4101 case LTTNG_BUFFER_PER_UID
:
4107 health_code_update();
4109 pthread_mutex_unlock(&ua_sess
->lock
);
4113 health_code_update();
4118 * Flush buffers for all applications for a specific UST session.
4119 * Called with UST session lock held.
4122 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4127 DBG("Flushing session buffers for all ust apps");
4131 /* Flush buffers and push metadata. */
4132 switch (usess
->buffer_type
) {
4133 case LTTNG_BUFFER_PER_UID
:
4135 struct buffer_reg_uid
*reg
;
4136 struct lttng_ht_iter iter
;
4138 /* Flush all per UID buffers associated to that session. */
4139 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4140 struct ust_registry_session
*ust_session_reg
;
4141 struct buffer_reg_channel
*reg_chan
;
4142 struct consumer_socket
*socket
;
4144 /* Get consumer socket to use to push the metadata.*/
4145 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4148 /* Ignore request if no consumer is found for the session. */
4152 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4153 reg_chan
, node
.node
) {
4155 * The following call will print error values so the return
4156 * code is of little importance because whatever happens, we
4157 * have to try them all.
4159 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4162 ust_session_reg
= reg
->registry
->reg
.ust
;
4163 /* Push metadata. */
4164 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4168 case LTTNG_BUFFER_PER_PID
:
4170 struct ust_app_session
*ua_sess
;
4171 struct lttng_ht_iter iter
;
4172 struct ust_app
*app
;
4174 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4175 ua_sess
= lookup_session_by_app(usess
, app
);
4176 if (ua_sess
== NULL
) {
4179 (void) ust_app_flush_app_session(app
, ua_sess
);
4191 health_code_update();
4196 * Destroy a specific UST session in apps.
4198 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4201 struct ust_app_session
*ua_sess
;
4202 struct lttng_ht_iter iter
;
4203 struct lttng_ht_node_u64
*node
;
4205 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4209 if (!app
->compatible
) {
4213 __lookup_session_by_app(usess
, app
, &iter
);
4214 node
= lttng_ht_iter_get_node_u64(&iter
);
4216 /* Session is being or is deleted. */
4219 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4221 health_code_update();
4222 destroy_app_session(app
, ua_sess
);
4224 health_code_update();
4226 /* Quiescent wait after stopping trace */
4227 ret
= ustctl_wait_quiescent(app
->sock
);
4228 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4229 ERR("UST app wait quiescent failed for app pid %d ret %d",
4234 health_code_update();
4239 * Start tracing for the UST session.
4241 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4244 struct lttng_ht_iter iter
;
4245 struct ust_app
*app
;
4247 DBG("Starting all UST traces");
4251 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4252 ret
= ust_app_start_trace(usess
, app
);
4254 /* Continue to next apps even on error */
4265 * Start tracing for the UST session.
4266 * Called with UST session lock held.
4268 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4271 struct lttng_ht_iter iter
;
4272 struct ust_app
*app
;
4274 DBG("Stopping all UST traces");
4278 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4279 ret
= ust_app_stop_trace(usess
, app
);
4281 /* Continue to next apps even on error */
4286 (void) ust_app_flush_session(usess
);
4294 * Destroy app UST session.
4296 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4299 struct lttng_ht_iter iter
;
4300 struct ust_app
*app
;
4302 DBG("Destroy all UST traces");
4306 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4307 ret
= destroy_trace(usess
, app
);
4309 /* Continue to next apps even on error */
4320 * Add channels/events from UST global domain to registered apps at sock.
4322 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4325 struct lttng_ht_iter iter
, uiter
;
4326 struct ust_app
*app
;
4327 struct ust_app_session
*ua_sess
= NULL
;
4328 struct ust_app_channel
*ua_chan
;
4329 struct ust_app_event
*ua_event
;
4330 struct ust_app_ctx
*ua_ctx
;
4335 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4340 app
= ust_app_find_by_sock(sock
);
4343 * Application can be unregistered before so this is possible hence
4344 * simply stopping the update.
4346 DBG3("UST app update failed to find app sock %d", sock
);
4350 if (!app
->compatible
) {
4354 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4356 /* Tracer is probably gone or ENOMEM. */
4361 pthread_mutex_lock(&ua_sess
->lock
);
4364 * We can iterate safely here over all UST app session since the create ust
4365 * app session above made a shadow copy of the UST global domain from the
4368 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4370 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4373 * Stop everything. On error, the application failed, no more
4374 * file descriptor are available or ENOMEM so stopping here is
4375 * the only thing we can do for now.
4381 * Add context using the list so they are enabled in the same order the
4384 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4385 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4392 /* For each events */
4393 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4395 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4402 pthread_mutex_unlock(&ua_sess
->lock
);
4404 if (usess
->active
) {
4405 ret
= ust_app_start_trace(usess
, app
);
4410 DBG2("UST trace started for app pid %d", app
->pid
);
4413 /* Everything went well at this point. */
4418 pthread_mutex_unlock(&ua_sess
->lock
);
4421 destroy_app_session(app
, ua_sess
);
4428 * Add context to a specific channel for global UST domain.
4430 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4431 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4434 struct lttng_ht_node_str
*ua_chan_node
;
4435 struct lttng_ht_iter iter
, uiter
;
4436 struct ust_app_channel
*ua_chan
= NULL
;
4437 struct ust_app_session
*ua_sess
;
4438 struct ust_app
*app
;
4442 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4443 if (!app
->compatible
) {
4445 * TODO: In time, we should notice the caller of this error by
4446 * telling him that this is a version error.
4450 ua_sess
= lookup_session_by_app(usess
, app
);
4451 if (ua_sess
== NULL
) {
4455 pthread_mutex_lock(&ua_sess
->lock
);
4456 /* Lookup channel in the ust app session */
4457 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4458 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4459 if (ua_chan_node
== NULL
) {
4462 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4464 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4469 pthread_mutex_unlock(&ua_sess
->lock
);
4477 * Enable event for a channel from a UST session for a specific PID.
4479 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4480 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4483 struct lttng_ht_iter iter
;
4484 struct lttng_ht_node_str
*ua_chan_node
;
4485 struct ust_app
*app
;
4486 struct ust_app_session
*ua_sess
;
4487 struct ust_app_channel
*ua_chan
;
4488 struct ust_app_event
*ua_event
;
4490 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4494 app
= ust_app_find_by_pid(pid
);
4496 ERR("UST app enable event per PID %d not found", pid
);
4501 if (!app
->compatible
) {
4506 ua_sess
= lookup_session_by_app(usess
, app
);
4508 /* The application has problem or is probably dead. */
4513 pthread_mutex_lock(&ua_sess
->lock
);
4514 /* Lookup channel in the ust app session */
4515 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4516 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4517 /* If the channel is not found, there is a code flow error */
4518 assert(ua_chan_node
);
4520 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4522 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4523 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4524 if (ua_event
== NULL
) {
4525 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4530 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4537 pthread_mutex_unlock(&ua_sess
->lock
);
4544 * Calibrate registered applications.
4546 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4549 struct lttng_ht_iter iter
;
4550 struct ust_app
*app
;
4554 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4555 if (!app
->compatible
) {
4557 * TODO: In time, we should notice the caller of this error by
4558 * telling him that this is a version error.
4563 health_code_update();
4565 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4569 /* Means that it's not implemented on the tracer side. */
4573 DBG2("Calibrate app PID %d returned with error %d",
4580 DBG("UST app global domain calibration finished");
4584 health_code_update();
4590 * Receive registration and populate the given msg structure.
4592 * On success return 0 else a negative value returned by the ustctl call.
4594 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4597 uint32_t pid
, ppid
, uid
, gid
;
4601 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4602 &pid
, &ppid
, &uid
, &gid
,
4603 &msg
->bits_per_long
,
4604 &msg
->uint8_t_alignment
,
4605 &msg
->uint16_t_alignment
,
4606 &msg
->uint32_t_alignment
,
4607 &msg
->uint64_t_alignment
,
4608 &msg
->long_alignment
,
4615 case LTTNG_UST_ERR_EXITING
:
4616 DBG3("UST app recv reg message failed. Application died");
4618 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4619 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4620 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4621 LTTNG_UST_ABI_MINOR_VERSION
);
4624 ERR("UST app recv reg message failed with ret %d", ret
);
4629 msg
->pid
= (pid_t
) pid
;
4630 msg
->ppid
= (pid_t
) ppid
;
4631 msg
->uid
= (uid_t
) uid
;
4632 msg
->gid
= (gid_t
) gid
;
4639 * Return a ust app channel object using the application object and the channel
4640 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4641 * lock MUST be acquired before calling this function.
4643 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4646 struct lttng_ht_node_ulong
*node
;
4647 struct lttng_ht_iter iter
;
4648 struct ust_app_channel
*ua_chan
= NULL
;
4652 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4653 node
= lttng_ht_iter_get_node_ulong(&iter
);
4655 DBG2("UST app channel find by objd %d not found", objd
);
4659 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4666 * Reply to a register channel notification from an application on the notify
4667 * socket. The channel metadata is also created.
4669 * The session UST registry lock is acquired in this function.
4671 * On success 0 is returned else a negative value.
4673 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4674 size_t nr_fields
, struct ustctl_field
*fields
)
4676 int ret
, ret_code
= 0;
4677 uint32_t chan_id
, reg_count
;
4678 uint64_t chan_reg_key
;
4679 enum ustctl_channel_header type
;
4680 struct ust_app
*app
;
4681 struct ust_app_channel
*ua_chan
;
4682 struct ust_app_session
*ua_sess
;
4683 struct ust_registry_session
*registry
;
4684 struct ust_registry_channel
*chan_reg
;
4688 /* Lookup application. If not found, there is a code flow error. */
4689 app
= find_app_by_notify_sock(sock
);
4691 DBG("Application socket %d is being teardown. Abort event notify",
4695 goto error_rcu_unlock
;
4698 /* Lookup channel by UST object descriptor. */
4699 ua_chan
= find_channel_by_objd(app
, cobjd
);
4701 DBG("Application channel is being teardown. Abort event notify");
4704 goto error_rcu_unlock
;
4707 assert(ua_chan
->session
);
4708 ua_sess
= ua_chan
->session
;
4710 /* Get right session registry depending on the session buffer type. */
4711 registry
= get_session_registry(ua_sess
);
4714 /* Depending on the buffer type, a different channel key is used. */
4715 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4716 chan_reg_key
= ua_chan
->tracing_channel_id
;
4718 chan_reg_key
= ua_chan
->key
;
4721 pthread_mutex_lock(®istry
->lock
);
4723 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4726 if (!chan_reg
->register_done
) {
4727 reg_count
= ust_registry_get_event_count(chan_reg
);
4728 if (reg_count
< 31) {
4729 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4731 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4734 chan_reg
->nr_ctx_fields
= nr_fields
;
4735 chan_reg
->ctx_fields
= fields
;
4736 chan_reg
->header_type
= type
;
4738 /* Get current already assigned values. */
4739 type
= chan_reg
->header_type
;
4741 /* Set to NULL so the error path does not do a double free. */
4744 /* Channel id is set during the object creation. */
4745 chan_id
= chan_reg
->chan_id
;
4747 /* Append to metadata */
4748 if (!chan_reg
->metadata_dumped
) {
4749 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4751 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4757 DBG3("UST app replying to register channel key %" PRIu64
4758 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4761 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4763 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4764 ERR("UST app reply channel failed with ret %d", ret
);
4766 DBG3("UST app reply channel failed. Application died");
4771 /* This channel registry registration is completed. */
4772 chan_reg
->register_done
= 1;
4775 pthread_mutex_unlock(®istry
->lock
);
4785 * Add event to the UST channel registry. When the event is added to the
4786 * registry, the metadata is also created. Once done, this replies to the
4787 * application with the appropriate error code.
4789 * The session UST registry lock is acquired in the function.
4791 * On success 0 is returned else a negative value.
4793 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4794 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4795 char *model_emf_uri
)
4798 uint32_t event_id
= 0;
4799 uint64_t chan_reg_key
;
4800 struct ust_app
*app
;
4801 struct ust_app_channel
*ua_chan
;
4802 struct ust_app_session
*ua_sess
;
4803 struct ust_registry_session
*registry
;
4807 /* Lookup application. If not found, there is a code flow error. */
4808 app
= find_app_by_notify_sock(sock
);
4810 DBG("Application socket %d is being teardown. Abort event notify",
4815 free(model_emf_uri
);
4816 goto error_rcu_unlock
;
4819 /* Lookup channel by UST object descriptor. */
4820 ua_chan
= find_channel_by_objd(app
, cobjd
);
4822 DBG("Application channel is being teardown. Abort event notify");
4826 free(model_emf_uri
);
4827 goto error_rcu_unlock
;
4830 assert(ua_chan
->session
);
4831 ua_sess
= ua_chan
->session
;
4833 registry
= get_session_registry(ua_sess
);
4836 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4837 chan_reg_key
= ua_chan
->tracing_channel_id
;
4839 chan_reg_key
= ua_chan
->key
;
4842 pthread_mutex_lock(®istry
->lock
);
4845 * From this point on, this call acquires the ownership of the sig, fields
4846 * and model_emf_uri meaning any free are done inside it if needed. These
4847 * three variables MUST NOT be read/write after this.
4849 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4850 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4851 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4855 * The return value is returned to ustctl so in case of an error, the
4856 * application can be notified. In case of an error, it's important not to
4857 * return a negative error or else the application will get closed.
4859 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4861 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4862 ERR("UST app reply event failed with ret %d", ret
);
4864 DBG3("UST app reply event failed. Application died");
4867 * No need to wipe the create event since the application socket will
4868 * get close on error hence cleaning up everything by itself.
4873 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4877 pthread_mutex_unlock(®istry
->lock
);
4884 * Handle application notification through the given notify socket.
4886 * Return 0 on success or else a negative value.
4888 int ust_app_recv_notify(int sock
)
4891 enum ustctl_notify_cmd cmd
;
4893 DBG3("UST app receiving notify from sock %d", sock
);
4895 ret
= ustctl_recv_notify(sock
, &cmd
);
4897 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4898 ERR("UST app recv notify failed with ret %d", ret
);
4900 DBG3("UST app recv notify failed. Application died");
4906 case USTCTL_NOTIFY_CMD_EVENT
:
4908 int sobjd
, cobjd
, loglevel
;
4909 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4911 struct ustctl_field
*fields
;
4913 DBG2("UST app ustctl register event received");
4915 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4916 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4918 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4919 ERR("UST app recv event failed with ret %d", ret
);
4921 DBG3("UST app recv event failed. Application died");
4927 * Add event to the UST registry coming from the notify socket. This
4928 * call will free if needed the sig, fields and model_emf_uri. This
4929 * code path loses the ownsership of these variables and transfer them
4930 * to the this function.
4932 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4933 fields
, loglevel
, model_emf_uri
);
4940 case USTCTL_NOTIFY_CMD_CHANNEL
:
4944 struct ustctl_field
*fields
;
4946 DBG2("UST app ustctl register channel received");
4948 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4951 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4952 ERR("UST app recv channel failed with ret %d", ret
);
4954 DBG3("UST app recv channel failed. Application died");
4960 * The fields ownership are transfered to this function call meaning
4961 * that if needed it will be freed. After this, it's invalid to access
4962 * fields or clean it up.
4964 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4973 /* Should NEVER happen. */
4982 * Once the notify socket hangs up, this is called. First, it tries to find the
4983 * corresponding application. On failure, the call_rcu to close the socket is
4984 * executed. If an application is found, it tries to delete it from the notify
4985 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4987 * Note that an object needs to be allocated here so on ENOMEM failure, the
4988 * call RCU is not done but the rest of the cleanup is.
4990 void ust_app_notify_sock_unregister(int sock
)
4993 struct lttng_ht_iter iter
;
4994 struct ust_app
*app
;
4995 struct ust_app_notify_sock_obj
*obj
;
5001 obj
= zmalloc(sizeof(*obj
));
5004 * An ENOMEM is kind of uncool. If this strikes we continue the
5005 * procedure but the call_rcu will not be called. In this case, we
5006 * accept the fd leak rather than possibly creating an unsynchronized
5007 * state between threads.
5009 * TODO: The notify object should be created once the notify socket is
5010 * registered and stored independantely from the ust app object. The
5011 * tricky part is to synchronize the teardown of the application and
5012 * this notify object. Let's keep that in mind so we can avoid this
5013 * kind of shenanigans with ENOMEM in the teardown path.
5020 DBG("UST app notify socket unregister %d", sock
);
5023 * Lookup application by notify socket. If this fails, this means that the
5024 * hash table delete has already been done by the application
5025 * unregistration process so we can safely close the notify socket in a
5028 app
= find_app_by_notify_sock(sock
);
5033 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5036 * Whatever happens here either we fail or succeed, in both cases we have
5037 * to close the socket after a grace period to continue to the call RCU
5038 * here. If the deletion is successful, the application is not visible
5039 * anymore by other threads and is it fails it means that it was already
5040 * deleted from the hash table so either way we just have to close the
5043 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5049 * Close socket after a grace period to avoid for the socket to be reused
5050 * before the application object is freed creating potential race between
5051 * threads trying to add unique in the global hash table.
5054 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5059 * Destroy a ust app data structure and free its memory.
5061 void ust_app_destroy(struct ust_app
*app
)
5067 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5071 * Take a snapshot for a given UST session. The snapshot is sent to the given
5074 * Return 0 on success or else a negative value.
5076 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5077 struct snapshot_output
*output
, int wait
,
5078 uint64_t nb_packets_per_stream
)
5081 unsigned int snapshot_done
= 0;
5082 struct lttng_ht_iter iter
;
5083 struct ust_app
*app
;
5084 char pathname
[PATH_MAX
];
5091 switch (usess
->buffer_type
) {
5092 case LTTNG_BUFFER_PER_UID
:
5094 struct buffer_reg_uid
*reg
;
5096 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5097 struct buffer_reg_channel
*reg_chan
;
5098 struct consumer_socket
*socket
;
5100 /* Get consumer socket to use to push the metadata.*/
5101 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5108 memset(pathname
, 0, sizeof(pathname
));
5109 ret
= snprintf(pathname
, sizeof(pathname
),
5110 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5111 reg
->uid
, reg
->bits_per_long
);
5113 PERROR("snprintf snapshot path");
5117 /* Add the UST default trace dir to path. */
5118 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5119 reg_chan
, node
.node
) {
5120 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5121 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5122 nb_packets_per_stream
);
5127 ret
= consumer_snapshot_channel(socket
,
5128 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5129 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5137 case LTTNG_BUFFER_PER_PID
:
5139 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5140 struct consumer_socket
*socket
;
5141 struct lttng_ht_iter chan_iter
;
5142 struct ust_app_channel
*ua_chan
;
5143 struct ust_app_session
*ua_sess
;
5144 struct ust_registry_session
*registry
;
5146 ua_sess
= lookup_session_by_app(usess
, app
);
5148 /* Session not associated with this app. */
5152 /* Get the right consumer socket for the application. */
5153 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5160 /* Add the UST default trace dir to path. */
5161 memset(pathname
, 0, sizeof(pathname
));
5162 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5165 PERROR("snprintf snapshot path");
5169 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5170 ua_chan
, node
.node
) {
5171 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5172 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5173 nb_packets_per_stream
);
5179 registry
= get_session_registry(ua_sess
);
5181 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5182 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5195 if (!snapshot_done
) {
5197 * If no snapshot was made and we are not in the error path, this means
5198 * that there are no buffers thus no (prior) application to snapshot
5199 * data from so we have simply NO data.
5210 * Return the size taken by one more packet per stream.
5212 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5213 uint64_t cur_nr_packets
)
5215 uint64_t tot_size
= 0;
5216 struct ust_app
*app
;
5217 struct lttng_ht_iter iter
;
5221 switch (usess
->buffer_type
) {
5222 case LTTNG_BUFFER_PER_UID
:
5224 struct buffer_reg_uid
*reg
;
5226 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5227 struct buffer_reg_channel
*reg_chan
;
5230 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5231 reg_chan
, node
.node
) {
5232 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5234 * Don't take channel into account if we
5235 * already grab all its packets.
5239 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5245 case LTTNG_BUFFER_PER_PID
:
5248 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5249 struct ust_app_channel
*ua_chan
;
5250 struct ust_app_session
*ua_sess
;
5251 struct lttng_ht_iter chan_iter
;
5253 ua_sess
= lookup_session_by_app(usess
, app
);
5255 /* Session not associated with this app. */
5259 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5260 ua_chan
, node
.node
) {
5261 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5263 * Don't take channel into account if we
5264 * already grab all its packets.
5268 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;