2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
44 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key
;
48 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id
;
52 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 * Return the incremented value of next_channel_key.
57 static uint64_t get_next_channel_key(void)
61 pthread_mutex_lock(&next_channel_key_lock
);
62 ret
= ++_next_channel_key
;
63 pthread_mutex_unlock(&next_channel_key_lock
);
68 * Return the atomically incremented value of next_session_id.
70 static uint64_t get_next_session_id(void)
74 pthread_mutex_lock(&next_session_id_lock
);
75 ret
= ++_next_session_id
;
76 pthread_mutex_unlock(&next_session_id_lock
);
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr
*attr
,
82 struct lttng_ust_channel_attr
*uattr
)
84 /* Copy event attributes since the layout is different. */
85 attr
->subbuf_size
= uattr
->subbuf_size
;
86 attr
->num_subbuf
= uattr
->num_subbuf
;
87 attr
->overwrite
= uattr
->overwrite
;
88 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
89 attr
->read_timer_interval
= uattr
->read_timer_interval
;
90 attr
->output
= uattr
->output
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
107 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
113 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
117 /* Event loglevel. */
118 if (event
->attr
.loglevel
!= key
->loglevel
) {
119 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
120 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
122 * Match is accepted. This is because on event creation, the
123 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
124 * -1 are accepted for this loglevel type since 0 is the one set by
125 * the API when receiving an enable event.
132 /* One of the filters is NULL, fail. */
133 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
137 if (key
->filter
&& event
->filter
) {
138 /* Both filters exists, check length followed by the bytecode. */
139 if (event
->filter
->len
!= key
->filter
->len
||
140 memcmp(event
->filter
->data
, key
->filter
->data
,
141 event
->filter
->len
) != 0) {
146 /* One of the exclusions is NULL, fail. */
147 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
151 if (key
->exclusion
&& event
->exclusion
) {
152 /* Both exclusions exists, check count followed by the names. */
153 if (event
->exclusion
->count
!= key
->exclusion
->count
||
154 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
155 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
169 * Unique add of an ust app event in the given ht. This uses the custom
170 * ht_match_ust_app_event match function and the event name as hash.
172 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
173 struct ust_app_event
*event
)
175 struct cds_lfht_node
*node_ptr
;
176 struct ust_app_ht_key key
;
180 assert(ua_chan
->events
);
183 ht
= ua_chan
->events
;
184 key
.name
= event
->attr
.name
;
185 key
.filter
= event
->filter
;
186 key
.loglevel
= event
->attr
.loglevel
;
187 key
.exclusion
= event
->exclusion
;
189 node_ptr
= cds_lfht_add_unique(ht
->ht
,
190 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
191 ht_match_ust_app_event
, &key
, &event
->node
.node
);
192 assert(node_ptr
== &event
->node
.node
);
196 * Close the notify socket from the given RCU head object. This MUST be called
197 * through a call_rcu().
199 static void close_notify_sock_rcu(struct rcu_head
*head
)
202 struct ust_app_notify_sock_obj
*obj
=
203 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
205 /* Must have a valid fd here. */
206 assert(obj
->fd
>= 0);
208 ret
= close(obj
->fd
);
210 ERR("close notify sock %d RCU", obj
->fd
);
212 lttng_fd_put(LTTNG_FD_APPS
, 1);
218 * Return the session registry according to the buffer type of the given
221 * A registry per UID object MUST exists before calling this function or else
222 * it assert() if not found. RCU read side lock must be acquired.
224 static struct ust_registry_session
*get_session_registry(
225 struct ust_app_session
*ua_sess
)
227 struct ust_registry_session
*registry
= NULL
;
231 switch (ua_sess
->buffer_type
) {
232 case LTTNG_BUFFER_PER_PID
:
234 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
238 registry
= reg_pid
->registry
->reg
.ust
;
241 case LTTNG_BUFFER_PER_UID
:
243 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
244 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
248 registry
= reg_uid
->registry
->reg
.ust
;
260 * Delete ust context safely. RCU read lock must be held before calling
264 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
271 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
272 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
273 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
274 sock
, ua_ctx
->obj
->handle
, ret
);
282 * Delete ust app event safely. RCU read lock must be held before calling
286 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
292 free(ua_event
->filter
);
293 if (ua_event
->exclusion
!= NULL
)
294 free(ua_event
->exclusion
);
295 if (ua_event
->obj
!= NULL
) {
296 ret
= ustctl_release_object(sock
, ua_event
->obj
);
297 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
298 ERR("UST app sock %d release event obj failed with ret %d",
307 * Release ust data object of the given stream.
309 * Return 0 on success or else a negative value.
311 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
318 ret
= ustctl_release_object(sock
, stream
->obj
);
319 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
320 ERR("UST app sock %d release stream obj failed with ret %d",
323 lttng_fd_put(LTTNG_FD_APPS
, 2);
331 * Delete ust app stream safely. RCU read lock must be held before calling
335 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
339 (void) release_ust_app_stream(sock
, stream
);
344 * We need to execute ht_destroy outside of RCU read-side critical
345 * section and outside of call_rcu thread, so we postpone its execution
346 * using ht_cleanup_push. It is simpler than to change the semantic of
347 * the many callers of delete_ust_app_session().
350 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
352 struct ust_app_channel
*ua_chan
=
353 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
355 ht_cleanup_push(ua_chan
->ctx
);
356 ht_cleanup_push(ua_chan
->events
);
361 * Delete ust app channel safely. RCU read lock must be held before calling
365 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
369 struct lttng_ht_iter iter
;
370 struct ust_app_event
*ua_event
;
371 struct ust_app_ctx
*ua_ctx
;
372 struct ust_app_stream
*stream
, *stmp
;
373 struct ust_registry_session
*registry
;
377 DBG3("UST app deleting channel %s", ua_chan
->name
);
380 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
381 cds_list_del(&stream
->list
);
382 delete_ust_app_stream(sock
, stream
);
386 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
387 cds_list_del(&ua_ctx
->list
);
388 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
390 delete_ust_app_ctx(sock
, ua_ctx
);
394 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
396 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
398 delete_ust_app_event(sock
, ua_event
);
401 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
402 /* Wipe and free registry from session registry. */
403 registry
= get_session_registry(ua_chan
->session
);
405 ust_registry_channel_del_free(registry
, ua_chan
->key
);
409 if (ua_chan
->obj
!= NULL
) {
410 /* Remove channel from application UST object descriptor. */
411 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
412 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
414 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
415 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
416 ERR("UST app sock %d release channel obj failed with ret %d",
419 lttng_fd_put(LTTNG_FD_APPS
, 1);
422 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
426 * Push metadata to consumer socket.
428 * RCU read-side lock must be held to guarantee existance of socket.
429 * Must be called with the ust app session lock held.
430 * Must be called with the registry lock held.
432 * On success, return the len of metadata pushed or else a negative value.
433 * Returning a -EPIPE return value means we could not send the metadata,
434 * but it can be caused by recoverable errors (e.g. the application has
435 * terminated concurrently).
437 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
438 struct consumer_socket
*socket
, int send_zero_data
)
441 char *metadata_str
= NULL
;
449 * Means that no metadata was assigned to the session. This can
450 * happens if no start has been done previously.
452 if (!registry
->metadata_key
) {
457 * On a push metadata error either the consumer is dead or the
458 * metadata channel has been destroyed because its endpoint
459 * might have died (e.g: relayd), or because the application has
460 * exited. If so, the metadata closed flag is set to 1 so we
461 * deny pushing metadata again which is not valid anymore on the
464 if (registry
->metadata_closed
) {
468 offset
= registry
->metadata_len_sent
;
469 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
471 DBG3("No metadata to push for metadata key %" PRIu64
,
472 registry
->metadata_key
);
474 if (send_zero_data
) {
475 DBG("No metadata to push");
481 /* Allocate only what we have to send. */
482 metadata_str
= zmalloc(len
);
484 PERROR("zmalloc ust app metadata string");
488 /* Copy what we haven't send out. */
489 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
490 registry
->metadata_len_sent
+= len
;
493 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
494 metadata_str
, len
, offset
);
497 * There is an acceptable race here between the registry
498 * metadata key assignment and the creation on the
499 * consumer. The session daemon can concurrently push
500 * metadata for this registry while being created on the
501 * consumer since the metadata key of the registry is
502 * assigned *before* it is setup to avoid the consumer
503 * to ask for metadata that could possibly be not found
504 * in the session daemon.
506 * The metadata will get pushed either by the session
507 * being stopped or the consumer requesting metadata if
508 * that race is triggered.
510 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
515 * Update back the actual metadata len sent since it
518 registry
->metadata_len_sent
-= len
;
530 * On error, flag the registry that the metadata is
531 * closed. We were unable to push anything and this
532 * means that either the consumer is not responding or
533 * the metadata cache has been destroyed on the
536 registry
->metadata_closed
= 1;
544 * For a given application and session, push metadata to consumer.
545 * Either sock or consumer is required : if sock is NULL, the default
546 * socket to send the metadata is retrieved from consumer, if sock
547 * is not NULL we use it to send the metadata.
548 * RCU read-side lock must be held while calling this function,
549 * therefore ensuring existance of registry. It also ensures existance
550 * of socket throughout this function.
552 * Return 0 on success else a negative error.
553 * Returning a -EPIPE return value means we could not send the metadata,
554 * but it can be caused by recoverable errors (e.g. the application has
555 * terminated concurrently).
557 static int push_metadata(struct ust_registry_session
*registry
,
558 struct consumer_output
*consumer
)
562 struct consumer_socket
*socket
;
567 pthread_mutex_lock(®istry
->lock
);
568 if (registry
->metadata_closed
) {
573 /* Get consumer socket to use to push the metadata.*/
574 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
581 ret
= ust_app_push_metadata(registry
, socket
, 0);
586 pthread_mutex_unlock(®istry
->lock
);
591 pthread_mutex_unlock(®istry
->lock
);
596 * Send to the consumer a close metadata command for the given session. Once
597 * done, the metadata channel is deleted and the session metadata pointer is
598 * nullified. The session lock MUST be held unless the application is
599 * in the destroy path.
601 * Return 0 on success else a negative value.
603 static int close_metadata(struct ust_registry_session
*registry
,
604 struct consumer_output
*consumer
)
607 struct consumer_socket
*socket
;
614 pthread_mutex_lock(®istry
->lock
);
616 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
621 /* Get consumer socket to use to push the metadata.*/
622 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
629 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
636 * Metadata closed. Even on error this means that the consumer is not
637 * responding or not found so either way a second close should NOT be emit
640 registry
->metadata_closed
= 1;
642 pthread_mutex_unlock(®istry
->lock
);
648 * We need to execute ht_destroy outside of RCU read-side critical
649 * section and outside of call_rcu thread, so we postpone its execution
650 * using ht_cleanup_push. It is simpler than to change the semantic of
651 * the many callers of delete_ust_app_session().
654 void delete_ust_app_session_rcu(struct rcu_head
*head
)
656 struct ust_app_session
*ua_sess
=
657 caa_container_of(head
, struct ust_app_session
, rcu_head
);
659 ht_cleanup_push(ua_sess
->channels
);
664 * Delete ust app session safely. RCU read lock must be held before calling
668 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
672 struct lttng_ht_iter iter
;
673 struct ust_app_channel
*ua_chan
;
674 struct ust_registry_session
*registry
;
678 pthread_mutex_lock(&ua_sess
->lock
);
680 registry
= get_session_registry(ua_sess
);
682 /* Push metadata for application before freeing the application. */
683 (void) push_metadata(registry
, ua_sess
->consumer
);
686 * Don't ask to close metadata for global per UID buffers. Close
687 * metadata only on destroy trace session in this case. Also, the
688 * previous push metadata could have flag the metadata registry to
689 * close so don't send a close command if closed.
691 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
692 /* And ask to close it for this session registry. */
693 (void) close_metadata(registry
, ua_sess
->consumer
);
697 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
699 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
701 delete_ust_app_channel(sock
, ua_chan
, app
);
704 /* In case of per PID, the registry is kept in the session. */
705 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
706 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
708 buffer_reg_pid_remove(reg_pid
);
709 buffer_reg_pid_destroy(reg_pid
);
713 if (ua_sess
->handle
!= -1) {
714 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
715 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
716 ERR("UST app sock %d release session handle failed with ret %d",
720 pthread_mutex_unlock(&ua_sess
->lock
);
722 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
726 * Delete a traceable application structure from the global list. Never call
727 * this function outside of a call_rcu call.
729 * RCU read side lock should _NOT_ be held when calling this function.
732 void delete_ust_app(struct ust_app
*app
)
735 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
737 /* Delete ust app sessions info */
742 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
744 /* Free every object in the session and the session. */
746 delete_ust_app_session(sock
, ua_sess
, app
);
750 ht_cleanup_push(app
->sessions
);
751 ht_cleanup_push(app
->ust_objd
);
754 * Wait until we have deleted the application from the sock hash table
755 * before closing this socket, otherwise an application could re-use the
756 * socket ID and race with the teardown, using the same hash table entry.
758 * It's OK to leave the close in call_rcu. We want it to stay unique for
759 * all RCU readers that could run concurrently with unregister app,
760 * therefore we _need_ to only close that socket after a grace period. So
761 * it should stay in this RCU callback.
763 * This close() is a very important step of the synchronization model so
764 * every modification to this function must be carefully reviewed.
770 lttng_fd_put(LTTNG_FD_APPS
, 1);
772 DBG2("UST app pid %d deleted", app
->pid
);
777 * URCU intermediate call to delete an UST app.
780 void delete_ust_app_rcu(struct rcu_head
*head
)
782 struct lttng_ht_node_ulong
*node
=
783 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
784 struct ust_app
*app
=
785 caa_container_of(node
, struct ust_app
, pid_n
);
787 DBG3("Call RCU deleting app PID %d", app
->pid
);
792 * Delete the session from the application ht and delete the data structure by
793 * freeing every object inside and releasing them.
795 static void destroy_app_session(struct ust_app
*app
,
796 struct ust_app_session
*ua_sess
)
799 struct lttng_ht_iter iter
;
804 iter
.iter
.node
= &ua_sess
->node
.node
;
805 ret
= lttng_ht_del(app
->sessions
, &iter
);
807 /* Already scheduled for teardown. */
811 /* Once deleted, free the data structure. */
812 delete_ust_app_session(app
->sock
, ua_sess
, app
);
819 * Alloc new UST app session.
822 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
824 struct ust_app_session
*ua_sess
;
826 /* Init most of the default value by allocating and zeroing */
827 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
828 if (ua_sess
== NULL
) {
833 ua_sess
->handle
= -1;
834 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
835 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
836 pthread_mutex_init(&ua_sess
->lock
, NULL
);
845 * Alloc new UST app channel.
848 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
849 struct ust_app_session
*ua_sess
,
850 struct lttng_ust_channel_attr
*attr
)
852 struct ust_app_channel
*ua_chan
;
854 /* Init most of the default value by allocating and zeroing */
855 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
856 if (ua_chan
== NULL
) {
861 /* Setup channel name */
862 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
863 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
865 ua_chan
->enabled
= 1;
866 ua_chan
->handle
= -1;
867 ua_chan
->session
= ua_sess
;
868 ua_chan
->key
= get_next_channel_key();
869 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
870 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
871 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
873 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
874 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
876 /* Copy attributes */
878 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
879 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
880 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
881 ua_chan
->attr
.overwrite
= attr
->overwrite
;
882 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
883 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
884 ua_chan
->attr
.output
= attr
->output
;
886 /* By default, the channel is a per cpu channel. */
887 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
889 DBG3("UST app channel %s allocated", ua_chan
->name
);
898 * Allocate and initialize a UST app stream.
900 * Return newly allocated stream pointer or NULL on error.
902 struct ust_app_stream
*ust_app_alloc_stream(void)
904 struct ust_app_stream
*stream
= NULL
;
906 stream
= zmalloc(sizeof(*stream
));
907 if (stream
== NULL
) {
908 PERROR("zmalloc ust app stream");
912 /* Zero could be a valid value for a handle so flag it to -1. */
920 * Alloc new UST app event.
923 struct ust_app_event
*alloc_ust_app_event(char *name
,
924 struct lttng_ust_event
*attr
)
926 struct ust_app_event
*ua_event
;
928 /* Init most of the default value by allocating and zeroing */
929 ua_event
= zmalloc(sizeof(struct ust_app_event
));
930 if (ua_event
== NULL
) {
935 ua_event
->enabled
= 1;
936 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
937 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
938 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
940 /* Copy attributes */
942 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
945 DBG3("UST app event %s allocated", ua_event
->name
);
954 * Alloc new UST app context.
957 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
959 struct ust_app_ctx
*ua_ctx
;
961 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
962 if (ua_ctx
== NULL
) {
966 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
969 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
972 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
979 * Allocate a filter and copy the given original filter.
981 * Return allocated filter or NULL on error.
983 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
984 struct lttng_ust_filter_bytecode
*orig_f
)
986 struct lttng_ust_filter_bytecode
*filter
= NULL
;
988 /* Copy filter bytecode */
989 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
991 PERROR("zmalloc alloc ust app filter");
995 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1002 * Find an ust_app using the sock and return it. RCU read side lock must be
1003 * held before calling this helper function.
1005 struct ust_app
*ust_app_find_by_sock(int sock
)
1007 struct lttng_ht_node_ulong
*node
;
1008 struct lttng_ht_iter iter
;
1010 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1011 node
= lttng_ht_iter_get_node_ulong(&iter
);
1013 DBG2("UST app find by sock %d not found", sock
);
1017 return caa_container_of(node
, struct ust_app
, sock_n
);
1024 * Find an ust_app using the notify sock and return it. RCU read side lock must
1025 * be held before calling this helper function.
1027 static struct ust_app
*find_app_by_notify_sock(int sock
)
1029 struct lttng_ht_node_ulong
*node
;
1030 struct lttng_ht_iter iter
;
1032 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1034 node
= lttng_ht_iter_get_node_ulong(&iter
);
1036 DBG2("UST app find by notify sock %d not found", sock
);
1040 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1047 * Lookup for an ust app event based on event name, filter bytecode and the
1050 * Return an ust_app_event object or NULL on error.
1052 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1053 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1054 const struct lttng_event_exclusion
*exclusion
)
1056 struct lttng_ht_iter iter
;
1057 struct lttng_ht_node_str
*node
;
1058 struct ust_app_event
*event
= NULL
;
1059 struct ust_app_ht_key key
;
1064 /* Setup key for event lookup. */
1066 key
.filter
= filter
;
1067 key
.loglevel
= loglevel
;
1068 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1069 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1071 /* Lookup using the event name as hash and a custom match fct. */
1072 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1073 ht_match_ust_app_event
, &key
, &iter
.iter
);
1074 node
= lttng_ht_iter_get_node_str(&iter
);
1079 event
= caa_container_of(node
, struct ust_app_event
, node
);
1086 * Create the channel context on the tracer.
1088 * Called with UST app session lock held.
1091 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1092 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1096 health_code_update();
1098 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1099 ua_chan
->obj
, &ua_ctx
->obj
);
1101 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1102 ERR("UST app create channel context failed for app (pid: %d) "
1103 "with ret %d", app
->pid
, ret
);
1106 * This is normal behavior, an application can die during the
1107 * creation process. Don't report an error so the execution can
1108 * continue normally.
1111 DBG3("UST app disable event failed. Application is dead.");
1116 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1118 DBG2("UST app context handle %d created successfully for channel %s",
1119 ua_ctx
->handle
, ua_chan
->name
);
1122 health_code_update();
1127 * Set the filter on the tracer.
1130 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1131 struct ust_app
*app
)
1135 health_code_update();
1137 if (!ua_event
->filter
) {
1142 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1145 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1146 ERR("UST app event %s filter failed for app (pid: %d) "
1147 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1150 * This is normal behavior, an application can die during the
1151 * creation process. Don't report an error so the execution can
1152 * continue normally.
1155 DBG3("UST app filter event failed. Application is dead.");
1160 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1163 health_code_update();
1168 * Set event exclusions on the tracer.
1171 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1172 struct ust_app
*app
)
1176 health_code_update();
1178 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1183 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1186 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1187 ERR("UST app event %s exclusions failed for app (pid: %d) "
1188 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1191 * This is normal behavior, an application can die during the
1192 * creation process. Don't report an error so the execution can
1193 * continue normally.
1196 DBG3("UST app event exclusion failed. Application is dead.");
1201 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1204 health_code_update();
1209 * Disable the specified event on to UST tracer for the UST session.
1211 static int disable_ust_event(struct ust_app
*app
,
1212 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1216 health_code_update();
1218 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1220 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1221 ERR("UST app event %s disable failed for app (pid: %d) "
1222 "and session handle %d with ret %d",
1223 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1226 * This is normal behavior, an application can die during the
1227 * creation process. Don't report an error so the execution can
1228 * continue normally.
1231 DBG3("UST app disable event failed. Application is dead.");
1236 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1237 ua_event
->attr
.name
, app
->pid
);
1240 health_code_update();
1245 * Disable the specified channel on to UST tracer for the UST session.
1247 static int disable_ust_channel(struct ust_app
*app
,
1248 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1252 health_code_update();
1254 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1256 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1257 ERR("UST app channel %s disable failed for app (pid: %d) "
1258 "and session handle %d with ret %d",
1259 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1262 * This is normal behavior, an application can die during the
1263 * creation process. Don't report an error so the execution can
1264 * continue normally.
1267 DBG3("UST app disable channel failed. Application is dead.");
1272 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1273 ua_chan
->name
, app
->pid
);
1276 health_code_update();
1281 * Enable the specified channel on to UST tracer for the UST session.
1283 static int enable_ust_channel(struct ust_app
*app
,
1284 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1288 health_code_update();
1290 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1292 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1293 ERR("UST app channel %s enable failed for app (pid: %d) "
1294 "and session handle %d with ret %d",
1295 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1298 * This is normal behavior, an application can die during the
1299 * creation process. Don't report an error so the execution can
1300 * continue normally.
1303 DBG3("UST app enable channel failed. Application is dead.");
1308 ua_chan
->enabled
= 1;
1310 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1311 ua_chan
->name
, app
->pid
);
1314 health_code_update();
1319 * Enable the specified event on to UST tracer for the UST session.
1321 static int enable_ust_event(struct ust_app
*app
,
1322 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1326 health_code_update();
1328 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1330 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1331 ERR("UST app event %s enable failed for app (pid: %d) "
1332 "and session handle %d with ret %d",
1333 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1336 * This is normal behavior, an application can die during the
1337 * creation process. Don't report an error so the execution can
1338 * continue normally.
1341 DBG3("UST app enable event failed. Application is dead.");
1346 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1347 ua_event
->attr
.name
, app
->pid
);
1350 health_code_update();
1355 * Send channel and stream buffer to application.
1357 * Return 0 on success. On error, a negative value is returned.
1359 static int send_channel_pid_to_ust(struct ust_app
*app
,
1360 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1363 struct ust_app_stream
*stream
, *stmp
;
1369 health_code_update();
1371 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1374 /* Send channel to the application. */
1375 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1380 health_code_update();
1382 /* Send all streams to application. */
1383 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1384 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1388 /* We don't need the stream anymore once sent to the tracer. */
1389 cds_list_del(&stream
->list
);
1390 delete_ust_app_stream(-1, stream
);
1392 /* Flag the channel that it is sent to the application. */
1393 ua_chan
->is_sent
= 1;
1396 health_code_update();
1401 * Create the specified event onto the UST tracer for a UST session.
1403 * Should be called with session mutex held.
1406 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1407 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1411 health_code_update();
1413 /* Create UST event on tracer */
1414 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1417 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1418 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1419 ua_event
->attr
.name
, app
->pid
, ret
);
1422 * This is normal behavior, an application can die during the
1423 * creation process. Don't report an error so the execution can
1424 * continue normally.
1427 DBG3("UST app create event failed. Application is dead.");
1432 ua_event
->handle
= ua_event
->obj
->handle
;
1434 DBG2("UST app event %s created successfully for pid:%d",
1435 ua_event
->attr
.name
, app
->pid
);
1437 health_code_update();
1439 /* Set filter if one is present. */
1440 if (ua_event
->filter
) {
1441 ret
= set_ust_event_filter(ua_event
, app
);
1447 /* Set exclusions for the event */
1448 if (ua_event
->exclusion
) {
1449 ret
= set_ust_event_exclusion(ua_event
, app
);
1455 /* If event not enabled, disable it on the tracer */
1456 if (ua_event
->enabled
) {
1458 * We now need to explicitly enable the event, since it
1459 * is now disabled at creation.
1461 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1464 * If we hit an EPERM, something is wrong with our enable call. If
1465 * we get an EEXIST, there is a problem on the tracer side since we
1469 case -LTTNG_UST_ERR_PERM
:
1470 /* Code flow problem */
1472 case -LTTNG_UST_ERR_EXIST
:
1473 /* It's OK for our use case. */
1482 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1485 * If we hit an EPERM, something is wrong with our disable call. If
1486 * we get an EEXIST, there is a problem on the tracer side since we
1490 case -LTTNG_UST_ERR_PERM
:
1491 /* Code flow problem */
1493 case -LTTNG_UST_ERR_EXIST
:
1494 /* It's OK for our use case. */
1505 health_code_update();
1510 * Copy data between an UST app event and a LTT event.
1512 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1513 struct ltt_ust_event
*uevent
)
1515 size_t exclusion_alloc_size
;
1517 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1518 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1520 ua_event
->enabled
= uevent
->enabled
;
1522 /* Copy event attributes */
1523 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1525 /* Copy filter bytecode */
1526 if (uevent
->filter
) {
1527 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1528 /* Filter might be NULL here in case of ENONEM. */
1531 /* Copy exclusion data */
1532 if (uevent
->exclusion
) {
1533 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1534 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1535 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1536 if (ua_event
->exclusion
== NULL
) {
1539 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1540 exclusion_alloc_size
);
1546 * Copy data between an UST app channel and a LTT channel.
1548 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1549 struct ltt_ust_channel
*uchan
)
1551 struct lttng_ht_iter iter
;
1552 struct ltt_ust_event
*uevent
;
1553 struct ltt_ust_context
*uctx
;
1554 struct ust_app_event
*ua_event
;
1555 struct ust_app_ctx
*ua_ctx
;
1557 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1559 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1560 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1562 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1563 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1565 /* Copy event attributes since the layout is different. */
1566 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1567 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1568 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1569 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1570 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1571 ua_chan
->attr
.output
= uchan
->attr
.output
;
1573 * Note that the attribute channel type is not set since the channel on the
1574 * tracing registry side does not have this information.
1577 ua_chan
->enabled
= uchan
->enabled
;
1578 ua_chan
->tracing_channel_id
= uchan
->id
;
1580 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1581 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1582 if (ua_ctx
== NULL
) {
1585 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1586 (unsigned long) ua_ctx
->ctx
.ctx
);
1587 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1588 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1591 /* Copy all events from ltt ust channel to ust app channel */
1592 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1593 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1594 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1595 if (ua_event
== NULL
) {
1596 DBG2("UST event %s not found on shadow copy channel",
1598 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1599 if (ua_event
== NULL
) {
1602 shadow_copy_event(ua_event
, uevent
);
1603 add_unique_ust_app_event(ua_chan
, ua_event
);
1607 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1611 * Copy data between a UST app session and a regular LTT session.
1613 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1614 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1616 struct lttng_ht_node_str
*ua_chan_node
;
1617 struct lttng_ht_iter iter
;
1618 struct ltt_ust_channel
*uchan
;
1619 struct ust_app_channel
*ua_chan
;
1621 struct tm
*timeinfo
;
1625 /* Get date and time for unique app path */
1627 timeinfo
= localtime(&rawtime
);
1628 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1630 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1632 ua_sess
->tracing_id
= usess
->id
;
1633 ua_sess
->id
= get_next_session_id();
1634 ua_sess
->uid
= app
->uid
;
1635 ua_sess
->gid
= app
->gid
;
1636 ua_sess
->euid
= usess
->uid
;
1637 ua_sess
->egid
= usess
->gid
;
1638 ua_sess
->buffer_type
= usess
->buffer_type
;
1639 ua_sess
->bits_per_long
= app
->bits_per_long
;
1640 /* There is only one consumer object per session possible. */
1641 ua_sess
->consumer
= usess
->consumer
;
1642 ua_sess
->output_traces
= usess
->output_traces
;
1643 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1644 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1645 &usess
->metadata_attr
);
1647 switch (ua_sess
->buffer_type
) {
1648 case LTTNG_BUFFER_PER_PID
:
1649 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1650 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1653 case LTTNG_BUFFER_PER_UID
:
1654 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1655 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1662 PERROR("asprintf UST shadow copy session");
1667 /* Iterate over all channels in global domain. */
1668 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1670 struct lttng_ht_iter uiter
;
1672 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1673 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1674 if (ua_chan_node
!= NULL
) {
1675 /* Session exist. Contiuing. */
1679 DBG2("Channel %s not found on shadow session copy, creating it",
1681 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1682 if (ua_chan
== NULL
) {
1683 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1686 shadow_copy_channel(ua_chan
, uchan
);
1688 * The concept of metadata channel does not exist on the tracing
1689 * registry side of the session daemon so this can only be a per CPU
1690 * channel and not metadata.
1692 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1694 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1702 * Lookup sesison wrapper.
1705 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1706 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1708 /* Get right UST app session from app */
1709 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1713 * Return ust app session from the app session hashtable using the UST session
1716 static struct ust_app_session
*lookup_session_by_app(
1717 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1719 struct lttng_ht_iter iter
;
1720 struct lttng_ht_node_u64
*node
;
1722 __lookup_session_by_app(usess
, app
, &iter
);
1723 node
= lttng_ht_iter_get_node_u64(&iter
);
1728 return caa_container_of(node
, struct ust_app_session
, node
);
1735 * Setup buffer registry per PID for the given session and application. If none
1736 * is found, a new one is created, added to the global registry and
1737 * initialized. If regp is valid, it's set with the newly created object.
1739 * Return 0 on success or else a negative value.
1741 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1742 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1745 struct buffer_reg_pid
*reg_pid
;
1752 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1755 * This is the create channel path meaning that if there is NO
1756 * registry available, we have to create one for this session.
1758 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1762 buffer_reg_pid_add(reg_pid
);
1767 /* Initialize registry. */
1768 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1769 app
->bits_per_long
, app
->uint8_t_alignment
,
1770 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1771 app
->uint64_t_alignment
, app
->long_alignment
,
1772 app
->byte_order
, app
->version
.major
,
1773 app
->version
.minor
);
1778 DBG3("UST app buffer registry per PID created successfully");
1790 * Setup buffer registry per UID for the given session and application. If none
1791 * is found, a new one is created, added to the global registry and
1792 * initialized. If regp is valid, it's set with the newly created object.
1794 * Return 0 on success or else a negative value.
1796 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1797 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1800 struct buffer_reg_uid
*reg_uid
;
1807 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1810 * This is the create channel path meaning that if there is NO
1811 * registry available, we have to create one for this session.
1813 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1814 LTTNG_DOMAIN_UST
, ®_uid
);
1818 buffer_reg_uid_add(reg_uid
);
1823 /* Initialize registry. */
1824 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1825 app
->bits_per_long
, app
->uint8_t_alignment
,
1826 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1827 app
->uint64_t_alignment
, app
->long_alignment
,
1828 app
->byte_order
, app
->version
.major
,
1829 app
->version
.minor
);
1833 /* Add node to teardown list of the session. */
1834 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1836 DBG3("UST app buffer registry per UID created successfully");
1848 * Create a session on the tracer side for the given app.
1850 * On success, ua_sess_ptr is populated with the session pointer or else left
1851 * untouched. If the session was created, is_created is set to 1. On error,
1852 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1855 * Returns 0 on success or else a negative code which is either -ENOMEM or
1856 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1858 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1859 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1862 int ret
, created
= 0;
1863 struct ust_app_session
*ua_sess
;
1867 assert(ua_sess_ptr
);
1869 health_code_update();
1871 ua_sess
= lookup_session_by_app(usess
, app
);
1872 if (ua_sess
== NULL
) {
1873 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1874 app
->pid
, usess
->id
);
1875 ua_sess
= alloc_ust_app_session(app
);
1876 if (ua_sess
== NULL
) {
1877 /* Only malloc can failed so something is really wrong */
1881 shadow_copy_session(ua_sess
, usess
, app
);
1885 switch (usess
->buffer_type
) {
1886 case LTTNG_BUFFER_PER_PID
:
1887 /* Init local registry. */
1888 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1893 case LTTNG_BUFFER_PER_UID
:
1894 /* Look for a global registry. If none exists, create one. */
1895 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1906 health_code_update();
1908 if (ua_sess
->handle
== -1) {
1909 ret
= ustctl_create_session(app
->sock
);
1911 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1912 ERR("Creating session for app pid %d with ret %d",
1915 DBG("UST app creating session failed. Application is dead");
1917 * This is normal behavior, an application can die during the
1918 * creation process. Don't report an error so the execution can
1919 * continue normally. This will get flagged ENOTCONN and the
1920 * caller will handle it.
1924 delete_ust_app_session(-1, ua_sess
, app
);
1925 if (ret
!= -ENOMEM
) {
1927 * Tracer is probably gone or got an internal error so let's
1928 * behave like it will soon unregister or not usable.
1935 ua_sess
->handle
= ret
;
1937 /* Add ust app session to app's HT */
1938 lttng_ht_node_init_u64(&ua_sess
->node
,
1939 ua_sess
->tracing_id
);
1940 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1942 DBG2("UST app session created successfully with handle %d", ret
);
1945 *ua_sess_ptr
= ua_sess
;
1947 *is_created
= created
;
1950 /* Everything went well. */
1954 health_code_update();
1959 * Match function for a hash table lookup of ust_app_ctx.
1961 * It matches an ust app context based on the context type and, in the case
1962 * of perf counters, their name.
1964 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1966 struct ust_app_ctx
*ctx
;
1967 const struct lttng_ust_context
*key
;
1972 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1976 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1980 /* Check the name in the case of perf thread counters. */
1981 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1982 if (strncmp(key
->u
.perf_counter
.name
,
1983 ctx
->ctx
.u
.perf_counter
.name
,
1984 sizeof(key
->u
.perf_counter
.name
))) {
1997 * Lookup for an ust app context from an lttng_ust_context.
1999 * Must be called while holding RCU read side lock.
2000 * Return an ust_app_ctx object or NULL on error.
2003 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2004 struct lttng_ust_context
*uctx
)
2006 struct lttng_ht_iter iter
;
2007 struct lttng_ht_node_ulong
*node
;
2008 struct ust_app_ctx
*app_ctx
= NULL
;
2013 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2014 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2015 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2016 node
= lttng_ht_iter_get_node_ulong(&iter
);
2021 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2028 * Create a context for the channel on the tracer.
2030 * Called with UST app session lock held and a RCU read side lock.
2033 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2034 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2035 struct ust_app
*app
)
2038 struct ust_app_ctx
*ua_ctx
;
2040 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2042 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2048 ua_ctx
= alloc_ust_app_ctx(uctx
);
2049 if (ua_ctx
== NULL
) {
2055 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2056 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2057 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2059 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2069 * Enable on the tracer side a ust app event for the session and channel.
2071 * Called with UST app session lock held.
2074 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2075 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2079 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2084 ua_event
->enabled
= 1;
2091 * Disable on the tracer side a ust app event for the session and channel.
2093 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2094 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2098 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2103 ua_event
->enabled
= 0;
2110 * Lookup ust app channel for session and disable it on the tracer side.
2113 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2114 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2118 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2123 ua_chan
->enabled
= 0;
2130 * Lookup ust app channel for session and enable it on the tracer side. This
2131 * MUST be called with a RCU read side lock acquired.
2133 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2134 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2137 struct lttng_ht_iter iter
;
2138 struct lttng_ht_node_str
*ua_chan_node
;
2139 struct ust_app_channel
*ua_chan
;
2141 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2142 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2143 if (ua_chan_node
== NULL
) {
2144 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2145 uchan
->name
, ua_sess
->tracing_id
);
2149 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2151 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2161 * Ask the consumer to create a channel and get it if successful.
2163 * Return 0 on success or else a negative value.
2165 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2166 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2167 int bitness
, struct ust_registry_session
*registry
)
2170 unsigned int nb_fd
= 0;
2171 struct consumer_socket
*socket
;
2179 health_code_update();
2181 /* Get the right consumer socket for the application. */
2182 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2188 health_code_update();
2190 /* Need one fd for the channel. */
2191 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2193 ERR("Exhausted number of available FD upon create channel");
2198 * Ask consumer to create channel. The consumer will return the number of
2199 * stream we have to expect.
2201 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2208 * Compute the number of fd needed before receiving them. It must be 2 per
2209 * stream (2 being the default value here).
2211 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2213 /* Reserve the amount of file descriptor we need. */
2214 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2216 ERR("Exhausted number of available FD upon create channel");
2217 goto error_fd_get_stream
;
2220 health_code_update();
2223 * Now get the channel from the consumer. This call wil populate the stream
2224 * list of that channel and set the ust objects.
2226 if (usess
->consumer
->enabled
) {
2227 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2237 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2238 error_fd_get_stream
:
2240 * Initiate a destroy channel on the consumer since we had an error
2241 * handling it on our side. The return value is of no importance since we
2242 * already have a ret value set by the previous error that we need to
2245 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2247 lttng_fd_put(LTTNG_FD_APPS
, 1);
2249 health_code_update();
2255 * Duplicate the ust data object of the ust app stream and save it in the
2256 * buffer registry stream.
2258 * Return 0 on success or else a negative value.
2260 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2261 struct ust_app_stream
*stream
)
2268 /* Reserve the amount of file descriptor we need. */
2269 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2271 ERR("Exhausted number of available FD upon duplicate stream");
2275 /* Duplicate object for stream once the original is in the registry. */
2276 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2277 reg_stream
->obj
.ust
);
2279 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2280 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2281 lttng_fd_put(LTTNG_FD_APPS
, 2);
2284 stream
->handle
= stream
->obj
->handle
;
2291 * Duplicate the ust data object of the ust app. channel and save it in the
2292 * buffer registry channel.
2294 * Return 0 on success or else a negative value.
2296 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2297 struct ust_app_channel
*ua_chan
)
2304 /* Need two fds for the channel. */
2305 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2307 ERR("Exhausted number of available FD upon duplicate channel");
2311 /* Duplicate object for stream once the original is in the registry. */
2312 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2314 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2315 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2318 ua_chan
->handle
= ua_chan
->obj
->handle
;
2323 lttng_fd_put(LTTNG_FD_APPS
, 1);
2329 * For a given channel buffer registry, setup all streams of the given ust
2330 * application channel.
2332 * Return 0 on success or else a negative value.
2334 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2335 struct ust_app_channel
*ua_chan
)
2338 struct ust_app_stream
*stream
, *stmp
;
2343 DBG2("UST app setup buffer registry stream");
2345 /* Send all streams to application. */
2346 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2347 struct buffer_reg_stream
*reg_stream
;
2349 ret
= buffer_reg_stream_create(®_stream
);
2355 * Keep original pointer and nullify it in the stream so the delete
2356 * stream call does not release the object.
2358 reg_stream
->obj
.ust
= stream
->obj
;
2360 buffer_reg_stream_add(reg_stream
, reg_chan
);
2362 /* We don't need the streams anymore. */
2363 cds_list_del(&stream
->list
);
2364 delete_ust_app_stream(-1, stream
);
2372 * Create a buffer registry channel for the given session registry and
2373 * application channel object. If regp pointer is valid, it's set with the
2374 * created object. Important, the created object is NOT added to the session
2375 * registry hash table.
2377 * Return 0 on success else a negative value.
2379 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2380 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2383 struct buffer_reg_channel
*reg_chan
= NULL
;
2388 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2390 /* Create buffer registry channel. */
2391 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2396 reg_chan
->consumer_key
= ua_chan
->key
;
2397 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2398 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2400 /* Create and add a channel registry to session. */
2401 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2402 ua_chan
->tracing_channel_id
);
2406 buffer_reg_channel_add(reg_sess
, reg_chan
);
2415 /* Safe because the registry channel object was not added to any HT. */
2416 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2422 * Setup buffer registry channel for the given session registry and application
2423 * channel object. If regp pointer is valid, it's set with the created object.
2425 * Return 0 on success else a negative value.
2427 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2428 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2435 assert(ua_chan
->obj
);
2437 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2439 /* Setup all streams for the registry. */
2440 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2445 reg_chan
->obj
.ust
= ua_chan
->obj
;
2446 ua_chan
->obj
= NULL
;
2451 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2452 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2457 * Send buffer registry channel to the application.
2459 * Return 0 on success else a negative value.
2461 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2462 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2463 struct ust_app_channel
*ua_chan
)
2466 struct buffer_reg_stream
*reg_stream
;
2473 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2475 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2480 /* Send channel to the application. */
2481 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2486 health_code_update();
2488 /* Send all streams to application. */
2489 pthread_mutex_lock(®_chan
->stream_list_lock
);
2490 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2491 struct ust_app_stream stream
;
2493 ret
= duplicate_stream_object(reg_stream
, &stream
);
2495 goto error_stream_unlock
;
2498 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2500 (void) release_ust_app_stream(-1, &stream
);
2501 goto error_stream_unlock
;
2505 * The return value is not important here. This function will output an
2508 (void) release_ust_app_stream(-1, &stream
);
2510 ua_chan
->is_sent
= 1;
2512 error_stream_unlock
:
2513 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2519 * Create and send to the application the created buffers with per UID buffers.
2521 * Return 0 on success else a negative value.
2523 static int create_channel_per_uid(struct ust_app
*app
,
2524 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2525 struct ust_app_channel
*ua_chan
)
2528 struct buffer_reg_uid
*reg_uid
;
2529 struct buffer_reg_channel
*reg_chan
;
2536 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2538 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2540 * The session creation handles the creation of this global registry
2541 * object. If none can be find, there is a code flow problem or a
2546 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2549 /* Create the buffer registry channel object. */
2550 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2552 ERR("Error creating the UST channel \"%s\" registry instance",
2559 * Create the buffers on the consumer side. This call populates the
2560 * ust app channel object with all streams and data object.
2562 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2563 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2565 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2569 * Let's remove the previously created buffer registry channel so
2570 * it's not visible anymore in the session registry.
2572 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2573 ua_chan
->tracing_channel_id
);
2574 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2575 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2580 * Setup the streams and add it to the session registry.
2582 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2584 ERR("Error setting up UST channel \"%s\"",
2591 /* Send buffers to the application. */
2592 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2595 * Don't report error to the console, since it may be
2596 * caused by application concurrently exiting.
2606 * Create and send to the application the created buffers with per PID buffers.
2608 * Return 0 on success else a negative value.
2610 static int create_channel_per_pid(struct ust_app
*app
,
2611 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2612 struct ust_app_channel
*ua_chan
)
2615 struct ust_registry_session
*registry
;
2622 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2626 registry
= get_session_registry(ua_sess
);
2629 /* Create and add a new channel registry to session. */
2630 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2632 ERR("Error creating the UST channel \"%s\" registry instance",
2637 /* Create and get channel on the consumer side. */
2638 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2639 app
->bits_per_long
, registry
);
2641 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2646 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2649 * Don't report error to the console, since it may be
2650 * caused by application concurrently exiting.
2661 * From an already allocated ust app channel, create the channel buffers if
2662 * need and send it to the application. This MUST be called with a RCU read
2663 * side lock acquired.
2665 * Return 0 on success or else a negative value.
2667 static int do_create_channel(struct ust_app
*app
,
2668 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2669 struct ust_app_channel
*ua_chan
)
2678 /* Handle buffer type before sending the channel to the application. */
2679 switch (usess
->buffer_type
) {
2680 case LTTNG_BUFFER_PER_UID
:
2682 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2688 case LTTNG_BUFFER_PER_PID
:
2690 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2702 /* Initialize ust objd object using the received handle and add it. */
2703 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2704 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2706 /* If channel is not enabled, disable it on the tracer */
2707 if (!ua_chan
->enabled
) {
2708 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2719 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2720 * newly created channel if not NULL.
2722 * Called with UST app session lock and RCU read-side lock held.
2724 * Return 0 on success or else a negative value.
2726 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2727 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2728 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2729 struct ust_app_channel
**ua_chanp
)
2732 struct lttng_ht_iter iter
;
2733 struct lttng_ht_node_str
*ua_chan_node
;
2734 struct ust_app_channel
*ua_chan
;
2736 /* Lookup channel in the ust app session */
2737 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2738 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2739 if (ua_chan_node
!= NULL
) {
2740 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2744 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2745 if (ua_chan
== NULL
) {
2746 /* Only malloc can fail here */
2750 shadow_copy_channel(ua_chan
, uchan
);
2752 /* Set channel type. */
2753 ua_chan
->attr
.type
= type
;
2755 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2760 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2763 /* Only add the channel if successful on the tracer side. */
2764 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2768 *ua_chanp
= ua_chan
;
2771 /* Everything went well. */
2775 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2781 * Create UST app event and create it on the tracer side.
2783 * Called with ust app session mutex held.
2786 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2787 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2788 struct ust_app
*app
)
2791 struct ust_app_event
*ua_event
;
2793 /* Get event node */
2794 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2795 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2796 if (ua_event
!= NULL
) {
2801 /* Does not exist so create one */
2802 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2803 if (ua_event
== NULL
) {
2804 /* Only malloc can failed so something is really wrong */
2808 shadow_copy_event(ua_event
, uevent
);
2810 /* Create it on the tracer side */
2811 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2813 /* Not found previously means that it does not exist on the tracer */
2814 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2818 add_unique_ust_app_event(ua_chan
, ua_event
);
2820 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2827 /* Valid. Calling here is already in a read side lock */
2828 delete_ust_app_event(-1, ua_event
);
2833 * Create UST metadata and open it on the tracer side.
2835 * Called with UST app session lock held and RCU read side lock.
2837 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2838 struct ust_app
*app
, struct consumer_output
*consumer
)
2841 struct ust_app_channel
*metadata
;
2842 struct consumer_socket
*socket
;
2843 struct ust_registry_session
*registry
;
2849 registry
= get_session_registry(ua_sess
);
2852 pthread_mutex_lock(®istry
->lock
);
2854 /* Metadata already exists for this registry or it was closed previously */
2855 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2860 /* Allocate UST metadata */
2861 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2863 /* malloc() failed */
2868 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2870 /* Need one fd for the channel. */
2871 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2873 ERR("Exhausted number of available FD upon create metadata");
2877 /* Get the right consumer socket for the application. */
2878 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2881 goto error_consumer
;
2885 * Keep metadata key so we can identify it on the consumer side. Assign it
2886 * to the registry *before* we ask the consumer so we avoid the race of the
2887 * consumer requesting the metadata and the ask_channel call on our side
2888 * did not returned yet.
2890 registry
->metadata_key
= metadata
->key
;
2893 * Ask the metadata channel creation to the consumer. The metadata object
2894 * will be created by the consumer and kept their. However, the stream is
2895 * never added or monitored until we do a first push metadata to the
2898 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2901 /* Nullify the metadata key so we don't try to close it later on. */
2902 registry
->metadata_key
= 0;
2903 goto error_consumer
;
2907 * The setup command will make the metadata stream be sent to the relayd,
2908 * if applicable, and the thread managing the metadatas. This is important
2909 * because after this point, if an error occurs, the only way the stream
2910 * can be deleted is to be monitored in the consumer.
2912 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2914 /* Nullify the metadata key so we don't try to close it later on. */
2915 registry
->metadata_key
= 0;
2916 goto error_consumer
;
2919 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2920 metadata
->key
, app
->pid
);
2923 lttng_fd_put(LTTNG_FD_APPS
, 1);
2924 delete_ust_app_channel(-1, metadata
, app
);
2926 pthread_mutex_unlock(®istry
->lock
);
2931 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2932 * acquired before calling this function.
2934 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2936 struct ust_app
*app
= NULL
;
2937 struct lttng_ht_node_ulong
*node
;
2938 struct lttng_ht_iter iter
;
2940 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2941 node
= lttng_ht_iter_get_node_ulong(&iter
);
2943 DBG2("UST app no found with pid %d", pid
);
2947 DBG2("Found UST app by pid %d", pid
);
2949 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2956 * Allocate and init an UST app object using the registration information and
2957 * the command socket. This is called when the command socket connects to the
2960 * The object is returned on success or else NULL.
2962 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2964 struct ust_app
*lta
= NULL
;
2969 DBG3("UST app creating application for socket %d", sock
);
2971 if ((msg
->bits_per_long
== 64 &&
2972 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2973 || (msg
->bits_per_long
== 32 &&
2974 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2975 ERR("Registration failed: application \"%s\" (pid: %d) has "
2976 "%d-bit long, but no consumerd for this size is available.\n",
2977 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2981 lta
= zmalloc(sizeof(struct ust_app
));
2987 lta
->ppid
= msg
->ppid
;
2988 lta
->uid
= msg
->uid
;
2989 lta
->gid
= msg
->gid
;
2991 lta
->bits_per_long
= msg
->bits_per_long
;
2992 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2993 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2994 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2995 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2996 lta
->long_alignment
= msg
->long_alignment
;
2997 lta
->byte_order
= msg
->byte_order
;
2999 lta
->v_major
= msg
->major
;
3000 lta
->v_minor
= msg
->minor
;
3001 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3002 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3003 lta
->notify_sock
= -1;
3005 /* Copy name and make sure it's NULL terminated. */
3006 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3007 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3010 * Before this can be called, when receiving the registration information,
3011 * the application compatibility is checked. So, at this point, the
3012 * application can work with this session daemon.
3014 lta
->compatible
= 1;
3016 lta
->pid
= msg
->pid
;
3017 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3019 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3021 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3028 * For a given application object, add it to every hash table.
3030 void ust_app_add(struct ust_app
*app
)
3033 assert(app
->notify_sock
>= 0);
3038 * On a re-registration, we want to kick out the previous registration of
3041 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3044 * The socket _should_ be unique until _we_ call close. So, a add_unique
3045 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3046 * already in the table.
3048 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3050 /* Add application to the notify socket hash table. */
3051 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3052 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3054 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3055 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3056 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3063 * Set the application version into the object.
3065 * Return 0 on success else a negative value either an errno code or a
3066 * LTTng-UST error code.
3068 int ust_app_version(struct ust_app
*app
)
3074 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3076 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3077 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3079 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3087 * Unregister app by removing it from the global traceable app list and freeing
3090 * The socket is already closed at this point so no close to sock.
3092 void ust_app_unregister(int sock
)
3094 struct ust_app
*lta
;
3095 struct lttng_ht_node_ulong
*node
;
3096 struct lttng_ht_iter ust_app_sock_iter
;
3097 struct lttng_ht_iter iter
;
3098 struct ust_app_session
*ua_sess
;
3103 /* Get the node reference for a call_rcu */
3104 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3105 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3108 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3109 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3112 * For per-PID buffers, perform "push metadata" and flush all
3113 * application streams before removing app from hash tables,
3114 * ensuring proper behavior of data_pending check.
3115 * Remove sessions so they are not visible during deletion.
3117 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3119 struct ust_registry_session
*registry
;
3121 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3123 /* The session was already removed so scheduled for teardown. */
3127 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3128 (void) ust_app_flush_app_session(lta
, ua_sess
);
3132 * Add session to list for teardown. This is safe since at this point we
3133 * are the only one using this list.
3135 pthread_mutex_lock(&ua_sess
->lock
);
3138 * Normally, this is done in the delete session process which is
3139 * executed in the call rcu below. However, upon registration we can't
3140 * afford to wait for the grace period before pushing data or else the
3141 * data pending feature can race between the unregistration and stop
3142 * command where the data pending command is sent *before* the grace
3145 * The close metadata below nullifies the metadata pointer in the
3146 * session so the delete session will NOT push/close a second time.
3148 registry
= get_session_registry(ua_sess
);
3150 /* Push metadata for application before freeing the application. */
3151 (void) push_metadata(registry
, ua_sess
->consumer
);
3154 * Don't ask to close metadata for global per UID buffers. Close
3155 * metadata only on destroy trace session in this case. Also, the
3156 * previous push metadata could have flag the metadata registry to
3157 * close so don't send a close command if closed.
3159 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3160 /* And ask to close it for this session registry. */
3161 (void) close_metadata(registry
, ua_sess
->consumer
);
3164 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3166 pthread_mutex_unlock(&ua_sess
->lock
);
3169 /* Remove application from PID hash table */
3170 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3174 * Remove application from notify hash table. The thread handling the
3175 * notify socket could have deleted the node so ignore on error because
3176 * either way it's valid. The close of that socket is handled by the other
3179 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3180 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3183 * Ignore return value since the node might have been removed before by an
3184 * add replace during app registration because the PID can be reassigned by
3187 iter
.iter
.node
= <a
->pid_n
.node
;
3188 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3190 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3195 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3202 * Fill events array with all events name of all registered apps.
3204 int ust_app_list_events(struct lttng_event
**events
)
3207 size_t nbmem
, count
= 0;
3208 struct lttng_ht_iter iter
;
3209 struct ust_app
*app
;
3210 struct lttng_event
*tmp_event
;
3212 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3213 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3214 if (tmp_event
== NULL
) {
3215 PERROR("zmalloc ust app events");
3222 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3223 struct lttng_ust_tracepoint_iter uiter
;
3225 health_code_update();
3227 if (!app
->compatible
) {
3229 * TODO: In time, we should notice the caller of this error by
3230 * telling him that this is a version error.
3234 handle
= ustctl_tracepoint_list(app
->sock
);
3236 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3237 ERR("UST app list events getting handle failed for app pid %d",
3243 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3244 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3245 /* Handle ustctl error. */
3247 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3248 ERR("UST app tp list get failed for app %d with ret %d",
3251 DBG3("UST app tp list get failed. Application is dead");
3253 * This is normal behavior, an application can die during the
3254 * creation process. Don't report an error so the execution can
3255 * continue normally. Continue normal execution.
3263 health_code_update();
3264 if (count
>= nbmem
) {
3265 /* In case the realloc fails, we free the memory */
3266 struct lttng_event
*new_tmp_event
;
3269 new_nbmem
= nbmem
<< 1;
3270 DBG2("Reallocating event list from %zu to %zu entries",
3272 new_tmp_event
= realloc(tmp_event
,
3273 new_nbmem
* sizeof(struct lttng_event
));
3274 if (new_tmp_event
== NULL
) {
3275 PERROR("realloc ust app events");
3280 /* Zero the new memory */
3281 memset(new_tmp_event
+ nbmem
, 0,
3282 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3284 tmp_event
= new_tmp_event
;
3286 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3287 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3288 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3289 tmp_event
[count
].pid
= app
->pid
;
3290 tmp_event
[count
].enabled
= -1;
3296 *events
= tmp_event
;
3298 DBG2("UST app list events done (%zu events)", count
);
3303 health_code_update();
3308 * Fill events array with all events name of all registered apps.
3310 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3313 size_t nbmem
, count
= 0;
3314 struct lttng_ht_iter iter
;
3315 struct ust_app
*app
;
3316 struct lttng_event_field
*tmp_event
;
3318 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3319 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3320 if (tmp_event
== NULL
) {
3321 PERROR("zmalloc ust app event fields");
3328 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3329 struct lttng_ust_field_iter uiter
;
3331 health_code_update();
3333 if (!app
->compatible
) {
3335 * TODO: In time, we should notice the caller of this error by
3336 * telling him that this is a version error.
3340 handle
= ustctl_tracepoint_field_list(app
->sock
);
3342 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3343 ERR("UST app list field getting handle failed for app pid %d",
3349 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3350 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3351 /* Handle ustctl error. */
3353 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3354 ERR("UST app tp list field failed for app %d with ret %d",
3357 DBG3("UST app tp list field failed. Application is dead");
3359 * This is normal behavior, an application can die during the
3360 * creation process. Don't report an error so the execution can
3361 * continue normally. Reset list and count for next app.
3369 health_code_update();
3370 if (count
>= nbmem
) {
3371 /* In case the realloc fails, we free the memory */
3372 struct lttng_event_field
*new_tmp_event
;
3375 new_nbmem
= nbmem
<< 1;
3376 DBG2("Reallocating event field list from %zu to %zu entries",
3378 new_tmp_event
= realloc(tmp_event
,
3379 new_nbmem
* sizeof(struct lttng_event_field
));
3380 if (new_tmp_event
== NULL
) {
3381 PERROR("realloc ust app event fields");
3386 /* Zero the new memory */
3387 memset(new_tmp_event
+ nbmem
, 0,
3388 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3390 tmp_event
= new_tmp_event
;
3393 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3394 /* Mapping between these enums matches 1 to 1. */
3395 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3396 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3398 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3399 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3400 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3401 tmp_event
[count
].event
.pid
= app
->pid
;
3402 tmp_event
[count
].event
.enabled
= -1;
3408 *fields
= tmp_event
;
3410 DBG2("UST app list event fields done (%zu events)", count
);
3415 health_code_update();
3420 * Free and clean all traceable apps of the global list.
3422 * Should _NOT_ be called with RCU read-side lock held.
3424 void ust_app_clean_list(void)
3427 struct ust_app
*app
;
3428 struct lttng_ht_iter iter
;
3430 DBG2("UST app cleaning registered apps hash table");
3434 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3435 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3437 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3440 /* Cleanup socket hash table */
3441 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3443 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3447 /* Cleanup notify socket hash table */
3448 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3449 notify_sock_n
.node
) {
3450 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3455 /* Destroy is done only when the ht is empty */
3456 ht_cleanup_push(ust_app_ht
);
3457 ht_cleanup_push(ust_app_ht_by_sock
);
3458 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3462 * Init UST app hash table.
3464 void ust_app_ht_alloc(void)
3466 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3467 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3468 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3472 * For a specific UST session, disable the channel for all registered apps.
3474 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3475 struct ltt_ust_channel
*uchan
)
3478 struct lttng_ht_iter iter
;
3479 struct lttng_ht_node_str
*ua_chan_node
;
3480 struct ust_app
*app
;
3481 struct ust_app_session
*ua_sess
;
3482 struct ust_app_channel
*ua_chan
;
3484 if (usess
== NULL
|| uchan
== NULL
) {
3485 ERR("Disabling UST global channel with NULL values");
3490 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3491 uchan
->name
, usess
->id
);
3495 /* For every registered applications */
3496 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3497 struct lttng_ht_iter uiter
;
3498 if (!app
->compatible
) {
3500 * TODO: In time, we should notice the caller of this error by
3501 * telling him that this is a version error.
3505 ua_sess
= lookup_session_by_app(usess
, app
);
3506 if (ua_sess
== NULL
) {
3511 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3512 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3513 /* If the session if found for the app, the channel must be there */
3514 assert(ua_chan_node
);
3516 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3517 /* The channel must not be already disabled */
3518 assert(ua_chan
->enabled
== 1);
3520 /* Disable channel onto application */
3521 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3523 /* XXX: We might want to report this error at some point... */
3535 * For a specific UST session, enable the channel for all registered apps.
3537 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3538 struct ltt_ust_channel
*uchan
)
3541 struct lttng_ht_iter iter
;
3542 struct ust_app
*app
;
3543 struct ust_app_session
*ua_sess
;
3545 if (usess
== NULL
|| uchan
== NULL
) {
3546 ERR("Adding UST global channel to NULL values");
3551 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3552 uchan
->name
, usess
->id
);
3556 /* For every registered applications */
3557 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3558 if (!app
->compatible
) {
3560 * TODO: In time, we should notice the caller of this error by
3561 * telling him that this is a version error.
3565 ua_sess
= lookup_session_by_app(usess
, app
);
3566 if (ua_sess
== NULL
) {
3570 /* Enable channel onto application */
3571 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3573 /* XXX: We might want to report this error at some point... */
3585 * Disable an event in a channel and for a specific session.
3587 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3588 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3591 struct lttng_ht_iter iter
, uiter
;
3592 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3593 struct ust_app
*app
;
3594 struct ust_app_session
*ua_sess
;
3595 struct ust_app_channel
*ua_chan
;
3596 struct ust_app_event
*ua_event
;
3598 DBG("UST app disabling event %s for all apps in channel "
3599 "%s for session id %" PRIu64
,
3600 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3604 /* For all registered applications */
3605 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3606 if (!app
->compatible
) {
3608 * TODO: In time, we should notice the caller of this error by
3609 * telling him that this is a version error.
3613 ua_sess
= lookup_session_by_app(usess
, app
);
3614 if (ua_sess
== NULL
) {
3619 /* Lookup channel in the ust app session */
3620 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3621 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3622 if (ua_chan_node
== NULL
) {
3623 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3624 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3627 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3629 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3630 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3631 if (ua_event_node
== NULL
) {
3632 DBG2("Event %s not found in channel %s for app pid %d."
3633 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3636 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3638 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3640 /* XXX: Report error someday... */
3651 * For a specific UST session, create the channel for all registered apps.
3653 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3654 struct ltt_ust_channel
*uchan
)
3656 int ret
= 0, created
;
3657 struct lttng_ht_iter iter
;
3658 struct ust_app
*app
;
3659 struct ust_app_session
*ua_sess
= NULL
;
3661 /* Very wrong code flow */
3665 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3666 uchan
->name
, usess
->id
);
3670 /* For every registered applications */
3671 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3672 if (!app
->compatible
) {
3674 * TODO: In time, we should notice the caller of this error by
3675 * telling him that this is a version error.
3680 * Create session on the tracer side and add it to app session HT. Note
3681 * that if session exist, it will simply return a pointer to the ust
3684 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3689 * The application's socket is not valid. Either a bad socket
3690 * or a timeout on it. We can't inform the caller that for a
3691 * specific app, the session failed so lets continue here.
3696 goto error_rcu_unlock
;
3701 pthread_mutex_lock(&ua_sess
->lock
);
3702 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3703 sizeof(uchan
->name
))) {
3704 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3707 /* Create channel onto application. We don't need the chan ref. */
3708 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3709 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3711 pthread_mutex_unlock(&ua_sess
->lock
);
3713 if (ret
== -ENOMEM
) {
3714 /* No more memory is a fatal error. Stop right now. */
3715 goto error_rcu_unlock
;
3717 /* Cleanup the created session if it's the case. */
3719 destroy_app_session(app
, ua_sess
);
3730 * Enable event for a specific session and channel on the tracer.
3732 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3733 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3736 struct lttng_ht_iter iter
, uiter
;
3737 struct lttng_ht_node_str
*ua_chan_node
;
3738 struct ust_app
*app
;
3739 struct ust_app_session
*ua_sess
;
3740 struct ust_app_channel
*ua_chan
;
3741 struct ust_app_event
*ua_event
;
3743 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3744 uevent
->attr
.name
, usess
->id
);
3747 * NOTE: At this point, this function is called only if the session and
3748 * channel passed are already created for all apps. and enabled on the
3754 /* For all registered applications */
3755 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3756 if (!app
->compatible
) {
3758 * TODO: In time, we should notice the caller of this error by
3759 * telling him that this is a version error.
3763 ua_sess
= lookup_session_by_app(usess
, app
);
3765 /* The application has problem or is probably dead. */
3769 pthread_mutex_lock(&ua_sess
->lock
);
3771 /* Lookup channel in the ust app session */
3772 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3773 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3774 /* If the channel is not found, there is a code flow error */
3775 assert(ua_chan_node
);
3777 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3779 /* Get event node */
3780 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3781 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3782 if (ua_event
== NULL
) {
3783 DBG3("UST app enable event %s not found for app PID %d."
3784 "Skipping app", uevent
->attr
.name
, app
->pid
);
3788 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3790 pthread_mutex_unlock(&ua_sess
->lock
);
3794 pthread_mutex_unlock(&ua_sess
->lock
);
3803 * For a specific existing UST session and UST channel, creates the event for
3804 * all registered apps.
3806 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3807 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3810 struct lttng_ht_iter iter
, uiter
;
3811 struct lttng_ht_node_str
*ua_chan_node
;
3812 struct ust_app
*app
;
3813 struct ust_app_session
*ua_sess
;
3814 struct ust_app_channel
*ua_chan
;
3816 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3817 uevent
->attr
.name
, usess
->id
);
3821 /* For all registered applications */
3822 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3823 if (!app
->compatible
) {
3825 * TODO: In time, we should notice the caller of this error by
3826 * telling him that this is a version error.
3830 ua_sess
= lookup_session_by_app(usess
, app
);
3832 /* The application has problem or is probably dead. */
3836 pthread_mutex_lock(&ua_sess
->lock
);
3837 /* Lookup channel in the ust app session */
3838 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3839 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3840 /* If the channel is not found, there is a code flow error */
3841 assert(ua_chan_node
);
3843 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3845 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3846 pthread_mutex_unlock(&ua_sess
->lock
);
3848 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3849 /* Possible value at this point: -ENOMEM. If so, we stop! */
3852 DBG2("UST app event %s already exist on app PID %d",
3853 uevent
->attr
.name
, app
->pid
);
3864 * Start tracing for a specific UST session and app.
3867 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3870 struct ust_app_session
*ua_sess
;
3872 DBG("Starting tracing for ust app pid %d", app
->pid
);
3876 if (!app
->compatible
) {
3880 ua_sess
= lookup_session_by_app(usess
, app
);
3881 if (ua_sess
== NULL
) {
3882 /* The session is in teardown process. Ignore and continue. */
3886 pthread_mutex_lock(&ua_sess
->lock
);
3888 /* Upon restart, we skip the setup, already done */
3889 if (ua_sess
->started
) {
3893 /* Create directories if consumer is LOCAL and has a path defined. */
3894 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3895 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3896 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3897 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3899 if (ret
!= -EEXIST
) {
3900 ERR("Trace directory creation error");
3907 * Create the metadata for the application. This returns gracefully if a
3908 * metadata was already set for the session.
3910 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3915 health_code_update();
3918 /* This start the UST tracing */
3919 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3921 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3922 ERR("Error starting tracing for app pid: %d (ret: %d)",
3925 DBG("UST app start session failed. Application is dead.");
3927 * This is normal behavior, an application can die during the
3928 * creation process. Don't report an error so the execution can
3929 * continue normally.
3931 pthread_mutex_unlock(&ua_sess
->lock
);
3937 /* Indicate that the session has been started once */
3938 ua_sess
->started
= 1;
3940 pthread_mutex_unlock(&ua_sess
->lock
);
3942 health_code_update();
3944 /* Quiescent wait after starting trace */
3945 ret
= ustctl_wait_quiescent(app
->sock
);
3946 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3947 ERR("UST app wait quiescent failed for app pid %d ret %d",
3953 health_code_update();
3957 pthread_mutex_unlock(&ua_sess
->lock
);
3959 health_code_update();
3964 * Stop tracing for a specific UST session and app.
3967 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3970 struct ust_app_session
*ua_sess
;
3971 struct ust_registry_session
*registry
;
3973 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3977 if (!app
->compatible
) {
3978 goto end_no_session
;
3981 ua_sess
= lookup_session_by_app(usess
, app
);
3982 if (ua_sess
== NULL
) {
3983 goto end_no_session
;
3986 pthread_mutex_lock(&ua_sess
->lock
);
3989 * If started = 0, it means that stop trace has been called for a session
3990 * that was never started. It's possible since we can have a fail start
3991 * from either the application manager thread or the command thread. Simply
3992 * indicate that this is a stop error.
3994 if (!ua_sess
->started
) {
3995 goto error_rcu_unlock
;
3998 health_code_update();
4000 /* This inhibits UST tracing */
4001 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4003 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4004 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4007 DBG("UST app stop session failed. Application is dead.");
4009 * This is normal behavior, an application can die during the
4010 * creation process. Don't report an error so the execution can
4011 * continue normally.
4015 goto error_rcu_unlock
;
4018 health_code_update();
4020 /* Quiescent wait after stopping trace */
4021 ret
= ustctl_wait_quiescent(app
->sock
);
4022 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4023 ERR("UST app wait quiescent failed for app pid %d ret %d",
4027 health_code_update();
4029 registry
= get_session_registry(ua_sess
);
4032 /* Push metadata for application before freeing the application. */
4033 (void) push_metadata(registry
, ua_sess
->consumer
);
4036 pthread_mutex_unlock(&ua_sess
->lock
);
4039 health_code_update();
4043 pthread_mutex_unlock(&ua_sess
->lock
);
4045 health_code_update();
4050 int ust_app_flush_app_session(struct ust_app
*app
,
4051 struct ust_app_session
*ua_sess
)
4053 int ret
, retval
= 0;
4054 struct lttng_ht_iter iter
;
4055 struct ust_app_channel
*ua_chan
;
4056 struct consumer_socket
*socket
;
4058 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4062 if (!app
->compatible
) {
4063 goto end_not_compatible
;
4066 pthread_mutex_lock(&ua_sess
->lock
);
4068 health_code_update();
4070 /* Flushing buffers */
4071 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4074 /* Flush buffers and push metadata. */
4075 switch (ua_sess
->buffer_type
) {
4076 case LTTNG_BUFFER_PER_PID
:
4077 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4079 health_code_update();
4080 assert(ua_chan
->is_sent
);
4081 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4083 ERR("Error flushing consumer channel");
4089 case LTTNG_BUFFER_PER_UID
:
4095 health_code_update();
4097 pthread_mutex_unlock(&ua_sess
->lock
);
4101 health_code_update();
4106 * Flush buffers for all applications for a specific UST session.
4107 * Called with UST session lock held.
4110 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4115 DBG("Flushing session buffers for all ust apps");
4119 /* Flush buffers and push metadata. */
4120 switch (usess
->buffer_type
) {
4121 case LTTNG_BUFFER_PER_UID
:
4123 struct buffer_reg_uid
*reg
;
4124 struct lttng_ht_iter iter
;
4126 /* Flush all per UID buffers associated to that session. */
4127 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4128 struct ust_registry_session
*ust_session_reg
;
4129 struct buffer_reg_channel
*reg_chan
;
4130 struct consumer_socket
*socket
;
4132 /* Get consumer socket to use to push the metadata.*/
4133 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4136 /* Ignore request if no consumer is found for the session. */
4140 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4141 reg_chan
, node
.node
) {
4143 * The following call will print error values so the return
4144 * code is of little importance because whatever happens, we
4145 * have to try them all.
4147 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4150 ust_session_reg
= reg
->registry
->reg
.ust
;
4151 /* Push metadata. */
4152 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4156 case LTTNG_BUFFER_PER_PID
:
4158 struct ust_app_session
*ua_sess
;
4159 struct lttng_ht_iter iter
;
4160 struct ust_app
*app
;
4162 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4163 ua_sess
= lookup_session_by_app(usess
, app
);
4164 if (ua_sess
== NULL
) {
4167 (void) ust_app_flush_app_session(app
, ua_sess
);
4179 health_code_update();
4184 * Destroy a specific UST session in apps.
4186 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4189 struct ust_app_session
*ua_sess
;
4190 struct lttng_ht_iter iter
;
4191 struct lttng_ht_node_u64
*node
;
4193 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4197 if (!app
->compatible
) {
4201 __lookup_session_by_app(usess
, app
, &iter
);
4202 node
= lttng_ht_iter_get_node_u64(&iter
);
4204 /* Session is being or is deleted. */
4207 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4209 health_code_update();
4210 destroy_app_session(app
, ua_sess
);
4212 health_code_update();
4214 /* Quiescent wait after stopping trace */
4215 ret
= ustctl_wait_quiescent(app
->sock
);
4216 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4217 ERR("UST app wait quiescent failed for app pid %d ret %d",
4222 health_code_update();
4227 * Start tracing for the UST session.
4229 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4232 struct lttng_ht_iter iter
;
4233 struct ust_app
*app
;
4235 DBG("Starting all UST traces");
4239 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4240 ret
= ust_app_start_trace(usess
, app
);
4242 /* Continue to next apps even on error */
4253 * Start tracing for the UST session.
4254 * Called with UST session lock held.
4256 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4259 struct lttng_ht_iter iter
;
4260 struct ust_app
*app
;
4262 DBG("Stopping all UST traces");
4266 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4267 ret
= ust_app_stop_trace(usess
, app
);
4269 /* Continue to next apps even on error */
4274 (void) ust_app_flush_session(usess
);
4282 * Destroy app UST session.
4284 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4287 struct lttng_ht_iter iter
;
4288 struct ust_app
*app
;
4290 DBG("Destroy all UST traces");
4294 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4295 ret
= destroy_trace(usess
, app
);
4297 /* Continue to next apps even on error */
4308 * Add channels/events from UST global domain to registered apps at sock.
4310 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4313 struct lttng_ht_iter iter
, uiter
;
4314 struct ust_app
*app
;
4315 struct ust_app_session
*ua_sess
= NULL
;
4316 struct ust_app_channel
*ua_chan
;
4317 struct ust_app_event
*ua_event
;
4318 struct ust_app_ctx
*ua_ctx
;
4323 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4328 app
= ust_app_find_by_sock(sock
);
4331 * Application can be unregistered before so this is possible hence
4332 * simply stopping the update.
4334 DBG3("UST app update failed to find app sock %d", sock
);
4338 if (!app
->compatible
) {
4342 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4344 /* Tracer is probably gone or ENOMEM. */
4349 pthread_mutex_lock(&ua_sess
->lock
);
4352 * We can iterate safely here over all UST app session since the create ust
4353 * app session above made a shadow copy of the UST global domain from the
4356 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4358 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4361 * Stop everything. On error, the application failed, no more
4362 * file descriptor are available or ENOMEM so stopping here is
4363 * the only thing we can do for now.
4369 * Add context using the list so they are enabled in the same order the
4372 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4373 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4380 /* For each events */
4381 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4383 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4390 pthread_mutex_unlock(&ua_sess
->lock
);
4392 if (usess
->active
) {
4393 ret
= ust_app_start_trace(usess
, app
);
4398 DBG2("UST trace started for app pid %d", app
->pid
);
4401 /* Everything went well at this point. */
4406 pthread_mutex_unlock(&ua_sess
->lock
);
4409 destroy_app_session(app
, ua_sess
);
4416 * Add context to a specific channel for global UST domain.
4418 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4419 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4422 struct lttng_ht_node_str
*ua_chan_node
;
4423 struct lttng_ht_iter iter
, uiter
;
4424 struct ust_app_channel
*ua_chan
= NULL
;
4425 struct ust_app_session
*ua_sess
;
4426 struct ust_app
*app
;
4430 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4431 if (!app
->compatible
) {
4433 * TODO: In time, we should notice the caller of this error by
4434 * telling him that this is a version error.
4438 ua_sess
= lookup_session_by_app(usess
, app
);
4439 if (ua_sess
== NULL
) {
4443 pthread_mutex_lock(&ua_sess
->lock
);
4444 /* Lookup channel in the ust app session */
4445 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4446 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4447 if (ua_chan_node
== NULL
) {
4450 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4452 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4457 pthread_mutex_unlock(&ua_sess
->lock
);
4465 * Enable event for a channel from a UST session for a specific PID.
4467 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4468 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4471 struct lttng_ht_iter iter
;
4472 struct lttng_ht_node_str
*ua_chan_node
;
4473 struct ust_app
*app
;
4474 struct ust_app_session
*ua_sess
;
4475 struct ust_app_channel
*ua_chan
;
4476 struct ust_app_event
*ua_event
;
4478 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4482 app
= ust_app_find_by_pid(pid
);
4484 ERR("UST app enable event per PID %d not found", pid
);
4489 if (!app
->compatible
) {
4494 ua_sess
= lookup_session_by_app(usess
, app
);
4496 /* The application has problem or is probably dead. */
4501 pthread_mutex_lock(&ua_sess
->lock
);
4502 /* Lookup channel in the ust app session */
4503 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4504 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4505 /* If the channel is not found, there is a code flow error */
4506 assert(ua_chan_node
);
4508 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4510 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4511 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4512 if (ua_event
== NULL
) {
4513 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4518 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4525 pthread_mutex_unlock(&ua_sess
->lock
);
4532 * Calibrate registered applications.
4534 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4537 struct lttng_ht_iter iter
;
4538 struct ust_app
*app
;
4542 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4543 if (!app
->compatible
) {
4545 * TODO: In time, we should notice the caller of this error by
4546 * telling him that this is a version error.
4551 health_code_update();
4553 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4557 /* Means that it's not implemented on the tracer side. */
4561 DBG2("Calibrate app PID %d returned with error %d",
4568 DBG("UST app global domain calibration finished");
4572 health_code_update();
4578 * Receive registration and populate the given msg structure.
4580 * On success return 0 else a negative value returned by the ustctl call.
4582 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4585 uint32_t pid
, ppid
, uid
, gid
;
4589 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4590 &pid
, &ppid
, &uid
, &gid
,
4591 &msg
->bits_per_long
,
4592 &msg
->uint8_t_alignment
,
4593 &msg
->uint16_t_alignment
,
4594 &msg
->uint32_t_alignment
,
4595 &msg
->uint64_t_alignment
,
4596 &msg
->long_alignment
,
4603 case LTTNG_UST_ERR_EXITING
:
4604 DBG3("UST app recv reg message failed. Application died");
4606 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4607 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4608 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4609 LTTNG_UST_ABI_MINOR_VERSION
);
4612 ERR("UST app recv reg message failed with ret %d", ret
);
4617 msg
->pid
= (pid_t
) pid
;
4618 msg
->ppid
= (pid_t
) ppid
;
4619 msg
->uid
= (uid_t
) uid
;
4620 msg
->gid
= (gid_t
) gid
;
4627 * Return a ust app channel object using the application object and the channel
4628 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4629 * lock MUST be acquired before calling this function.
4631 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4634 struct lttng_ht_node_ulong
*node
;
4635 struct lttng_ht_iter iter
;
4636 struct ust_app_channel
*ua_chan
= NULL
;
4640 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4641 node
= lttng_ht_iter_get_node_ulong(&iter
);
4643 DBG2("UST app channel find by objd %d not found", objd
);
4647 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4654 * Reply to a register channel notification from an application on the notify
4655 * socket. The channel metadata is also created.
4657 * The session UST registry lock is acquired in this function.
4659 * On success 0 is returned else a negative value.
4661 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4662 size_t nr_fields
, struct ustctl_field
*fields
)
4664 int ret
, ret_code
= 0;
4665 uint32_t chan_id
, reg_count
;
4666 uint64_t chan_reg_key
;
4667 enum ustctl_channel_header type
;
4668 struct ust_app
*app
;
4669 struct ust_app_channel
*ua_chan
;
4670 struct ust_app_session
*ua_sess
;
4671 struct ust_registry_session
*registry
;
4672 struct ust_registry_channel
*chan_reg
;
4676 /* Lookup application. If not found, there is a code flow error. */
4677 app
= find_app_by_notify_sock(sock
);
4679 DBG("Application socket %d is being teardown. Abort event notify",
4683 goto error_rcu_unlock
;
4686 /* Lookup channel by UST object descriptor. */
4687 ua_chan
= find_channel_by_objd(app
, cobjd
);
4689 DBG("Application channel is being teardown. Abort event notify");
4692 goto error_rcu_unlock
;
4695 assert(ua_chan
->session
);
4696 ua_sess
= ua_chan
->session
;
4698 /* Get right session registry depending on the session buffer type. */
4699 registry
= get_session_registry(ua_sess
);
4702 /* Depending on the buffer type, a different channel key is used. */
4703 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4704 chan_reg_key
= ua_chan
->tracing_channel_id
;
4706 chan_reg_key
= ua_chan
->key
;
4709 pthread_mutex_lock(®istry
->lock
);
4711 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4714 if (!chan_reg
->register_done
) {
4715 reg_count
= ust_registry_get_event_count(chan_reg
);
4716 if (reg_count
< 31) {
4717 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4719 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4722 chan_reg
->nr_ctx_fields
= nr_fields
;
4723 chan_reg
->ctx_fields
= fields
;
4724 chan_reg
->header_type
= type
;
4726 /* Get current already assigned values. */
4727 type
= chan_reg
->header_type
;
4729 /* Set to NULL so the error path does not do a double free. */
4732 /* Channel id is set during the object creation. */
4733 chan_id
= chan_reg
->chan_id
;
4735 /* Append to metadata */
4736 if (!chan_reg
->metadata_dumped
) {
4737 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4739 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4745 DBG3("UST app replying to register channel key %" PRIu64
4746 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4749 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4751 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4752 ERR("UST app reply channel failed with ret %d", ret
);
4754 DBG3("UST app reply channel failed. Application died");
4759 /* This channel registry registration is completed. */
4760 chan_reg
->register_done
= 1;
4763 pthread_mutex_unlock(®istry
->lock
);
4773 * Add event to the UST channel registry. When the event is added to the
4774 * registry, the metadata is also created. Once done, this replies to the
4775 * application with the appropriate error code.
4777 * The session UST registry lock is acquired in the function.
4779 * On success 0 is returned else a negative value.
4781 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4782 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4783 char *model_emf_uri
)
4786 uint32_t event_id
= 0;
4787 uint64_t chan_reg_key
;
4788 struct ust_app
*app
;
4789 struct ust_app_channel
*ua_chan
;
4790 struct ust_app_session
*ua_sess
;
4791 struct ust_registry_session
*registry
;
4795 /* Lookup application. If not found, there is a code flow error. */
4796 app
= find_app_by_notify_sock(sock
);
4798 DBG("Application socket %d is being teardown. Abort event notify",
4803 free(model_emf_uri
);
4804 goto error_rcu_unlock
;
4807 /* Lookup channel by UST object descriptor. */
4808 ua_chan
= find_channel_by_objd(app
, cobjd
);
4810 DBG("Application channel is being teardown. Abort event notify");
4814 free(model_emf_uri
);
4815 goto error_rcu_unlock
;
4818 assert(ua_chan
->session
);
4819 ua_sess
= ua_chan
->session
;
4821 registry
= get_session_registry(ua_sess
);
4824 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4825 chan_reg_key
= ua_chan
->tracing_channel_id
;
4827 chan_reg_key
= ua_chan
->key
;
4830 pthread_mutex_lock(®istry
->lock
);
4833 * From this point on, this call acquires the ownership of the sig, fields
4834 * and model_emf_uri meaning any free are done inside it if needed. These
4835 * three variables MUST NOT be read/write after this.
4837 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4838 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4839 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4843 * The return value is returned to ustctl so in case of an error, the
4844 * application can be notified. In case of an error, it's important not to
4845 * return a negative error or else the application will get closed.
4847 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4849 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4850 ERR("UST app reply event failed with ret %d", ret
);
4852 DBG3("UST app reply event failed. Application died");
4855 * No need to wipe the create event since the application socket will
4856 * get close on error hence cleaning up everything by itself.
4861 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4865 pthread_mutex_unlock(®istry
->lock
);
4872 * Handle application notification through the given notify socket.
4874 * Return 0 on success or else a negative value.
4876 int ust_app_recv_notify(int sock
)
4879 enum ustctl_notify_cmd cmd
;
4881 DBG3("UST app receiving notify from sock %d", sock
);
4883 ret
= ustctl_recv_notify(sock
, &cmd
);
4885 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4886 ERR("UST app recv notify failed with ret %d", ret
);
4888 DBG3("UST app recv notify failed. Application died");
4894 case USTCTL_NOTIFY_CMD_EVENT
:
4896 int sobjd
, cobjd
, loglevel
;
4897 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4899 struct ustctl_field
*fields
;
4901 DBG2("UST app ustctl register event received");
4903 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4904 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4906 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4907 ERR("UST app recv event failed with ret %d", ret
);
4909 DBG3("UST app recv event failed. Application died");
4915 * Add event to the UST registry coming from the notify socket. This
4916 * call will free if needed the sig, fields and model_emf_uri. This
4917 * code path loses the ownsership of these variables and transfer them
4918 * to the this function.
4920 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4921 fields
, loglevel
, model_emf_uri
);
4928 case USTCTL_NOTIFY_CMD_CHANNEL
:
4932 struct ustctl_field
*fields
;
4934 DBG2("UST app ustctl register channel received");
4936 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4939 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4940 ERR("UST app recv channel failed with ret %d", ret
);
4942 DBG3("UST app recv channel failed. Application died");
4948 * The fields ownership are transfered to this function call meaning
4949 * that if needed it will be freed. After this, it's invalid to access
4950 * fields or clean it up.
4952 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4961 /* Should NEVER happen. */
4970 * Once the notify socket hangs up, this is called. First, it tries to find the
4971 * corresponding application. On failure, the call_rcu to close the socket is
4972 * executed. If an application is found, it tries to delete it from the notify
4973 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4975 * Note that an object needs to be allocated here so on ENOMEM failure, the
4976 * call RCU is not done but the rest of the cleanup is.
4978 void ust_app_notify_sock_unregister(int sock
)
4981 struct lttng_ht_iter iter
;
4982 struct ust_app
*app
;
4983 struct ust_app_notify_sock_obj
*obj
;
4989 obj
= zmalloc(sizeof(*obj
));
4992 * An ENOMEM is kind of uncool. If this strikes we continue the
4993 * procedure but the call_rcu will not be called. In this case, we
4994 * accept the fd leak rather than possibly creating an unsynchronized
4995 * state between threads.
4997 * TODO: The notify object should be created once the notify socket is
4998 * registered and stored independantely from the ust app object. The
4999 * tricky part is to synchronize the teardown of the application and
5000 * this notify object. Let's keep that in mind so we can avoid this
5001 * kind of shenanigans with ENOMEM in the teardown path.
5008 DBG("UST app notify socket unregister %d", sock
);
5011 * Lookup application by notify socket. If this fails, this means that the
5012 * hash table delete has already been done by the application
5013 * unregistration process so we can safely close the notify socket in a
5016 app
= find_app_by_notify_sock(sock
);
5021 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5024 * Whatever happens here either we fail or succeed, in both cases we have
5025 * to close the socket after a grace period to continue to the call RCU
5026 * here. If the deletion is successful, the application is not visible
5027 * anymore by other threads and is it fails it means that it was already
5028 * deleted from the hash table so either way we just have to close the
5031 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5037 * Close socket after a grace period to avoid for the socket to be reused
5038 * before the application object is freed creating potential race between
5039 * threads trying to add unique in the global hash table.
5042 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5047 * Destroy a ust app data structure and free its memory.
5049 void ust_app_destroy(struct ust_app
*app
)
5055 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5059 * Take a snapshot for a given UST session. The snapshot is sent to the given
5062 * Return 0 on success or else a negative value.
5064 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5065 struct snapshot_output
*output
, int wait
,
5066 uint64_t nb_packets_per_stream
)
5069 unsigned int snapshot_done
= 0;
5070 struct lttng_ht_iter iter
;
5071 struct ust_app
*app
;
5072 char pathname
[PATH_MAX
];
5079 switch (usess
->buffer_type
) {
5080 case LTTNG_BUFFER_PER_UID
:
5082 struct buffer_reg_uid
*reg
;
5084 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5085 struct buffer_reg_channel
*reg_chan
;
5086 struct consumer_socket
*socket
;
5088 /* Get consumer socket to use to push the metadata.*/
5089 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5096 memset(pathname
, 0, sizeof(pathname
));
5097 ret
= snprintf(pathname
, sizeof(pathname
),
5098 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5099 reg
->uid
, reg
->bits_per_long
);
5101 PERROR("snprintf snapshot path");
5105 /* Add the UST default trace dir to path. */
5106 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5107 reg_chan
, node
.node
) {
5108 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5109 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5110 nb_packets_per_stream
);
5115 ret
= consumer_snapshot_channel(socket
,
5116 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5117 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5125 case LTTNG_BUFFER_PER_PID
:
5127 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5128 struct consumer_socket
*socket
;
5129 struct lttng_ht_iter chan_iter
;
5130 struct ust_app_channel
*ua_chan
;
5131 struct ust_app_session
*ua_sess
;
5132 struct ust_registry_session
*registry
;
5134 ua_sess
= lookup_session_by_app(usess
, app
);
5136 /* Session not associated with this app. */
5140 /* Get the right consumer socket for the application. */
5141 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5148 /* Add the UST default trace dir to path. */
5149 memset(pathname
, 0, sizeof(pathname
));
5150 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5153 PERROR("snprintf snapshot path");
5157 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5158 ua_chan
, node
.node
) {
5159 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5160 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5161 nb_packets_per_stream
);
5167 registry
= get_session_registry(ua_sess
);
5169 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5170 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5183 if (!snapshot_done
) {
5185 * If no snapshot was made and we are not in the error path, this means
5186 * that there are no buffers thus no (prior) application to snapshot
5187 * data from so we have simply NO data.
5198 * Return the size taken by one more packet per stream.
5200 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5201 uint64_t cur_nr_packets
)
5203 uint64_t tot_size
= 0;
5204 struct ust_app
*app
;
5205 struct lttng_ht_iter iter
;
5209 switch (usess
->buffer_type
) {
5210 case LTTNG_BUFFER_PER_UID
:
5212 struct buffer_reg_uid
*reg
;
5214 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5215 struct buffer_reg_channel
*reg_chan
;
5218 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5219 reg_chan
, node
.node
) {
5220 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5222 * Don't take channel into account if we
5223 * already grab all its packets.
5227 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5233 case LTTNG_BUFFER_PER_PID
:
5236 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5237 struct ust_app_channel
*ua_chan
;
5238 struct ust_app_session
*ua_sess
;
5239 struct lttng_ht_iter chan_iter
;
5241 ua_sess
= lookup_session_by_app(usess
, app
);
5243 /* Session not associated with this app. */
5247 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5248 ua_chan
, node
.node
) {
5249 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5251 * Don't take channel into account if we
5252 * already grab all its packets.
5256 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;