2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
44 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key
;
48 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id
;
52 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 * Return the incremented value of next_channel_key.
57 static uint64_t get_next_channel_key(void)
61 pthread_mutex_lock(&next_channel_key_lock
);
62 ret
= ++_next_channel_key
;
63 pthread_mutex_unlock(&next_channel_key_lock
);
68 * Return the atomically incremented value of next_session_id.
70 static uint64_t get_next_session_id(void)
74 pthread_mutex_lock(&next_session_id_lock
);
75 ret
= ++_next_session_id
;
76 pthread_mutex_unlock(&next_session_id_lock
);
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr
*attr
,
82 struct lttng_ust_channel_attr
*uattr
)
84 /* Copy event attributes since the layout is different. */
85 attr
->subbuf_size
= uattr
->subbuf_size
;
86 attr
->num_subbuf
= uattr
->num_subbuf
;
87 attr
->overwrite
= uattr
->overwrite
;
88 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
89 attr
->read_timer_interval
= uattr
->read_timer_interval
;
90 attr
->output
= uattr
->output
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
107 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
113 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
117 /* Event loglevel. */
118 if (event
->attr
.loglevel
!= key
->loglevel
) {
119 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
120 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
122 * Match is accepted. This is because on event creation, the
123 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
124 * -1 are accepted for this loglevel type since 0 is the one set by
125 * the API when receiving an enable event.
132 /* One of the filters is NULL, fail. */
133 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
137 if (key
->filter
&& event
->filter
) {
138 /* Both filters exists, check length followed by the bytecode. */
139 if (event
->filter
->len
!= key
->filter
->len
||
140 memcmp(event
->filter
->data
, key
->filter
->data
,
141 event
->filter
->len
) != 0) {
146 /* One of the exclusions is NULL, fail. */
147 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
151 if (key
->exclusion
&& event
->exclusion
) {
152 /* Both exclusions exists, check count followed by the names. */
153 if (event
->exclusion
->count
!= key
->exclusion
->count
||
154 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
155 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
169 * Unique add of an ust app event in the given ht. This uses the custom
170 * ht_match_ust_app_event match function and the event name as hash.
172 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
173 struct ust_app_event
*event
)
175 struct cds_lfht_node
*node_ptr
;
176 struct ust_app_ht_key key
;
180 assert(ua_chan
->events
);
183 ht
= ua_chan
->events
;
184 key
.name
= event
->attr
.name
;
185 key
.filter
= event
->filter
;
186 key
.loglevel
= event
->attr
.loglevel
;
187 key
.exclusion
= event
->exclusion
;
189 node_ptr
= cds_lfht_add_unique(ht
->ht
,
190 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
191 ht_match_ust_app_event
, &key
, &event
->node
.node
);
192 assert(node_ptr
== &event
->node
.node
);
196 * Close the notify socket from the given RCU head object. This MUST be called
197 * through a call_rcu().
199 static void close_notify_sock_rcu(struct rcu_head
*head
)
202 struct ust_app_notify_sock_obj
*obj
=
203 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
205 /* Must have a valid fd here. */
206 assert(obj
->fd
>= 0);
208 ret
= close(obj
->fd
);
210 ERR("close notify sock %d RCU", obj
->fd
);
212 lttng_fd_put(LTTNG_FD_APPS
, 1);
218 * Return the session registry according to the buffer type of the given
221 * A registry per UID object MUST exists before calling this function or else
222 * it assert() if not found. RCU read side lock must be acquired.
224 static struct ust_registry_session
*get_session_registry(
225 struct ust_app_session
*ua_sess
)
227 struct ust_registry_session
*registry
= NULL
;
231 switch (ua_sess
->buffer_type
) {
232 case LTTNG_BUFFER_PER_PID
:
234 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
238 registry
= reg_pid
->registry
->reg
.ust
;
241 case LTTNG_BUFFER_PER_UID
:
243 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
244 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
248 registry
= reg_uid
->registry
->reg
.ust
;
260 * Delete ust context safely. RCU read lock must be held before calling
264 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
271 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
272 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
273 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
274 sock
, ua_ctx
->obj
->handle
, ret
);
282 * Delete ust app event safely. RCU read lock must be held before calling
286 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
292 free(ua_event
->filter
);
293 if (ua_event
->exclusion
!= NULL
)
294 free(ua_event
->exclusion
);
295 if (ua_event
->obj
!= NULL
) {
296 ret
= ustctl_release_object(sock
, ua_event
->obj
);
297 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
298 ERR("UST app sock %d release event obj failed with ret %d",
307 * Release ust data object of the given stream.
309 * Return 0 on success or else a negative value.
311 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
318 ret
= ustctl_release_object(sock
, stream
->obj
);
319 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
320 ERR("UST app sock %d release stream obj failed with ret %d",
323 lttng_fd_put(LTTNG_FD_APPS
, 2);
331 * Delete ust app stream safely. RCU read lock must be held before calling
335 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
339 (void) release_ust_app_stream(sock
, stream
);
344 * We need to execute ht_destroy outside of RCU read-side critical
345 * section and outside of call_rcu thread, so we postpone its execution
346 * using ht_cleanup_push. It is simpler than to change the semantic of
347 * the many callers of delete_ust_app_session().
350 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
352 struct ust_app_channel
*ua_chan
=
353 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
355 ht_cleanup_push(ua_chan
->ctx
);
356 ht_cleanup_push(ua_chan
->events
);
361 * Delete ust app channel safely. RCU read lock must be held before calling
365 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
369 struct lttng_ht_iter iter
;
370 struct ust_app_event
*ua_event
;
371 struct ust_app_ctx
*ua_ctx
;
372 struct ust_app_stream
*stream
, *stmp
;
373 struct ust_registry_session
*registry
;
377 DBG3("UST app deleting channel %s", ua_chan
->name
);
380 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
381 cds_list_del(&stream
->list
);
382 delete_ust_app_stream(sock
, stream
);
386 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
387 cds_list_del(&ua_ctx
->list
);
388 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
390 delete_ust_app_ctx(sock
, ua_ctx
);
394 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
396 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
398 delete_ust_app_event(sock
, ua_event
);
401 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
402 /* Wipe and free registry from session registry. */
403 registry
= get_session_registry(ua_chan
->session
);
405 ust_registry_channel_del_free(registry
, ua_chan
->key
);
409 if (ua_chan
->obj
!= NULL
) {
410 /* Remove channel from application UST object descriptor. */
411 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
412 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
414 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
415 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
416 ERR("UST app sock %d release channel obj failed with ret %d",
419 lttng_fd_put(LTTNG_FD_APPS
, 1);
422 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
426 * Push metadata to consumer socket.
428 * The socket lock MUST be acquired.
429 * The ust app session lock MUST be acquired.
431 * On success, return the len of metadata pushed or else a negative value.
433 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
434 struct consumer_socket
*socket
, int send_zero_data
)
437 char *metadata_str
= NULL
;
444 pthread_mutex_lock(®istry
->lock
);
447 * Means that no metadata was assigned to the session. This can happens if
448 * no start has been done previously.
450 if (!registry
->metadata_key
) {
451 pthread_mutex_unlock(®istry
->lock
);
456 * On a push metadata error either the consumer is dead or the metadata
457 * channel has been destroyed because its endpoint might have died (e.g:
458 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
459 * metadata again which is not valid anymore on the consumer side.
461 if (registry
->metadata_closed
) {
462 pthread_mutex_unlock(®istry
->lock
);
466 offset
= registry
->metadata_len_sent
;
467 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
469 DBG3("No metadata to push for metadata key %" PRIu64
,
470 registry
->metadata_key
);
472 if (send_zero_data
) {
473 DBG("No metadata to push");
479 /* Allocate only what we have to send. */
480 metadata_str
= zmalloc(len
);
482 PERROR("zmalloc ust app metadata string");
486 /* Copy what we haven't send out. */
487 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
488 registry
->metadata_len_sent
+= len
;
491 pthread_mutex_unlock(®istry
->lock
);
492 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
493 metadata_str
, len
, offset
);
496 * There is an acceptable race here between the registry metadata key
497 * assignment and the creation on the consumer. The session daemon can
498 * concurrently push metadata for this registry while being created on
499 * the consumer since the metadata key of the registry is assigned
500 * *before* it is setup to avoid the consumer to ask for metadata that
501 * could possibly be not found in the session daemon.
503 * The metadata will get pushed either by the session being stopped or
504 * the consumer requesting metadata if that race is triggered.
506 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
510 /* Update back the actual metadata len sent since it failed here. */
511 pthread_mutex_lock(®istry
->lock
);
512 registry
->metadata_len_sent
-= len
;
513 pthread_mutex_unlock(®istry
->lock
);
525 * On error, flag the registry that the metadata is closed. We were unable
526 * to push anything and this means that either the consumer is not
527 * responding or the metadata cache has been destroyed on the consumer.
529 registry
->metadata_closed
= 1;
531 pthread_mutex_unlock(®istry
->lock
);
538 * For a given application and session, push metadata to consumer.
539 * Either sock or consumer is required : if sock is NULL, the default
540 * socket to send the metadata is retrieved from consumer, if sock
541 * is not NULL we use it to send the metadata.
542 * RCU read-side lock must be held while calling this function,
543 * therefore ensuring existance of registry.
545 * Return 0 on success else a negative error.
547 static int push_metadata(struct ust_registry_session
*registry
,
548 struct consumer_output
*consumer
)
552 struct consumer_socket
*socket
;
557 pthread_mutex_lock(®istry
->lock
);
559 if (registry
->metadata_closed
) {
560 pthread_mutex_unlock(®istry
->lock
);
564 /* Get consumer socket to use to push the metadata.*/
565 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
567 pthread_mutex_unlock(®istry
->lock
);
574 * TODO: Currently, we hold the socket lock around sampling of the next
575 * metadata segment to ensure we send metadata over the consumer socket in
576 * the correct order. This makes the registry lock nest inside the socket
579 * Please note that this is a temporary measure: we should move this lock
580 * back into ust_consumer_push_metadata() when the consumer gets the
581 * ability to reorder the metadata it receives.
583 pthread_mutex_lock(socket
->lock
);
584 ret
= ust_app_push_metadata(registry
, socket
, 0);
585 pthread_mutex_unlock(socket
->lock
);
599 * Send to the consumer a close metadata command for the given session. Once
600 * done, the metadata channel is deleted and the session metadata pointer is
601 * nullified. The session lock MUST be acquired here unless the application is
602 * in the destroy path.
604 * Return 0 on success else a negative value.
606 static int close_metadata(struct ust_registry_session
*registry
,
607 struct consumer_output
*consumer
)
610 struct consumer_socket
*socket
;
617 pthread_mutex_lock(®istry
->lock
);
619 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
624 /* Get consumer socket to use to push the metadata.*/
625 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
632 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
639 * Metadata closed. Even on error this means that the consumer is not
640 * responding or not found so either way a second close should NOT be emit
643 registry
->metadata_closed
= 1;
645 pthread_mutex_unlock(®istry
->lock
);
651 * We need to execute ht_destroy outside of RCU read-side critical
652 * section and outside of call_rcu thread, so we postpone its execution
653 * using ht_cleanup_push. It is simpler than to change the semantic of
654 * the many callers of delete_ust_app_session().
657 void delete_ust_app_session_rcu(struct rcu_head
*head
)
659 struct ust_app_session
*ua_sess
=
660 caa_container_of(head
, struct ust_app_session
, rcu_head
);
662 ht_cleanup_push(ua_sess
->channels
);
667 * Delete ust app session safely. RCU read lock must be held before calling
671 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
675 struct lttng_ht_iter iter
;
676 struct ust_app_channel
*ua_chan
;
677 struct ust_registry_session
*registry
;
681 pthread_mutex_lock(&ua_sess
->lock
);
683 registry
= get_session_registry(ua_sess
);
685 /* Push metadata for application before freeing the application. */
686 (void) push_metadata(registry
, ua_sess
->consumer
);
689 * Don't ask to close metadata for global per UID buffers. Close
690 * metadata only on destroy trace session in this case. Also, the
691 * previous push metadata could have flag the metadata registry to
692 * close so don't send a close command if closed.
694 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
695 /* And ask to close it for this session registry. */
696 (void) close_metadata(registry
, ua_sess
->consumer
);
700 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
702 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
704 delete_ust_app_channel(sock
, ua_chan
, app
);
707 /* In case of per PID, the registry is kept in the session. */
708 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
709 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
711 buffer_reg_pid_remove(reg_pid
);
712 buffer_reg_pid_destroy(reg_pid
);
716 if (ua_sess
->handle
!= -1) {
717 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
718 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
719 ERR("UST app sock %d release session handle failed with ret %d",
723 pthread_mutex_unlock(&ua_sess
->lock
);
725 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
729 * Delete a traceable application structure from the global list. Never call
730 * this function outside of a call_rcu call.
732 * RCU read side lock should _NOT_ be held when calling this function.
735 void delete_ust_app(struct ust_app
*app
)
738 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
740 /* Delete ust app sessions info */
745 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
747 /* Free every object in the session and the session. */
749 delete_ust_app_session(sock
, ua_sess
, app
);
753 ht_cleanup_push(app
->sessions
);
754 ht_cleanup_push(app
->ust_objd
);
757 * Wait until we have deleted the application from the sock hash table
758 * before closing this socket, otherwise an application could re-use the
759 * socket ID and race with the teardown, using the same hash table entry.
761 * It's OK to leave the close in call_rcu. We want it to stay unique for
762 * all RCU readers that could run concurrently with unregister app,
763 * therefore we _need_ to only close that socket after a grace period. So
764 * it should stay in this RCU callback.
766 * This close() is a very important step of the synchronization model so
767 * every modification to this function must be carefully reviewed.
773 lttng_fd_put(LTTNG_FD_APPS
, 1);
775 DBG2("UST app pid %d deleted", app
->pid
);
780 * URCU intermediate call to delete an UST app.
783 void delete_ust_app_rcu(struct rcu_head
*head
)
785 struct lttng_ht_node_ulong
*node
=
786 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
787 struct ust_app
*app
=
788 caa_container_of(node
, struct ust_app
, pid_n
);
790 DBG3("Call RCU deleting app PID %d", app
->pid
);
795 * Delete the session from the application ht and delete the data structure by
796 * freeing every object inside and releasing them.
798 static void destroy_app_session(struct ust_app
*app
,
799 struct ust_app_session
*ua_sess
)
802 struct lttng_ht_iter iter
;
807 iter
.iter
.node
= &ua_sess
->node
.node
;
808 ret
= lttng_ht_del(app
->sessions
, &iter
);
810 /* Already scheduled for teardown. */
814 /* Once deleted, free the data structure. */
815 delete_ust_app_session(app
->sock
, ua_sess
, app
);
822 * Alloc new UST app session.
825 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
827 struct ust_app_session
*ua_sess
;
829 /* Init most of the default value by allocating and zeroing */
830 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
831 if (ua_sess
== NULL
) {
836 ua_sess
->handle
= -1;
837 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
838 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
839 pthread_mutex_init(&ua_sess
->lock
, NULL
);
848 * Alloc new UST app channel.
851 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
852 struct ust_app_session
*ua_sess
,
853 struct lttng_ust_channel_attr
*attr
)
855 struct ust_app_channel
*ua_chan
;
857 /* Init most of the default value by allocating and zeroing */
858 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
859 if (ua_chan
== NULL
) {
864 /* Setup channel name */
865 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
866 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
868 ua_chan
->enabled
= 1;
869 ua_chan
->handle
= -1;
870 ua_chan
->session
= ua_sess
;
871 ua_chan
->key
= get_next_channel_key();
872 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
873 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
874 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
876 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
877 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
879 /* Copy attributes */
881 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
882 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
883 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
884 ua_chan
->attr
.overwrite
= attr
->overwrite
;
885 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
886 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
887 ua_chan
->attr
.output
= attr
->output
;
889 /* By default, the channel is a per cpu channel. */
890 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
892 DBG3("UST app channel %s allocated", ua_chan
->name
);
901 * Allocate and initialize a UST app stream.
903 * Return newly allocated stream pointer or NULL on error.
905 struct ust_app_stream
*ust_app_alloc_stream(void)
907 struct ust_app_stream
*stream
= NULL
;
909 stream
= zmalloc(sizeof(*stream
));
910 if (stream
== NULL
) {
911 PERROR("zmalloc ust app stream");
915 /* Zero could be a valid value for a handle so flag it to -1. */
923 * Alloc new UST app event.
926 struct ust_app_event
*alloc_ust_app_event(char *name
,
927 struct lttng_ust_event
*attr
)
929 struct ust_app_event
*ua_event
;
931 /* Init most of the default value by allocating and zeroing */
932 ua_event
= zmalloc(sizeof(struct ust_app_event
));
933 if (ua_event
== NULL
) {
938 ua_event
->enabled
= 1;
939 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
940 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
941 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
943 /* Copy attributes */
945 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
948 DBG3("UST app event %s allocated", ua_event
->name
);
957 * Alloc new UST app context.
960 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
962 struct ust_app_ctx
*ua_ctx
;
964 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
965 if (ua_ctx
== NULL
) {
969 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
972 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
975 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
982 * Allocate a filter and copy the given original filter.
984 * Return allocated filter or NULL on error.
986 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
987 struct lttng_ust_filter_bytecode
*orig_f
)
989 struct lttng_ust_filter_bytecode
*filter
= NULL
;
991 /* Copy filter bytecode */
992 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
994 PERROR("zmalloc alloc ust app filter");
998 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1005 * Find an ust_app using the sock and return it. RCU read side lock must be
1006 * held before calling this helper function.
1008 struct ust_app
*ust_app_find_by_sock(int sock
)
1010 struct lttng_ht_node_ulong
*node
;
1011 struct lttng_ht_iter iter
;
1013 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1014 node
= lttng_ht_iter_get_node_ulong(&iter
);
1016 DBG2("UST app find by sock %d not found", sock
);
1020 return caa_container_of(node
, struct ust_app
, sock_n
);
1027 * Find an ust_app using the notify sock and return it. RCU read side lock must
1028 * be held before calling this helper function.
1030 static struct ust_app
*find_app_by_notify_sock(int sock
)
1032 struct lttng_ht_node_ulong
*node
;
1033 struct lttng_ht_iter iter
;
1035 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1037 node
= lttng_ht_iter_get_node_ulong(&iter
);
1039 DBG2("UST app find by notify sock %d not found", sock
);
1043 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1050 * Lookup for an ust app event based on event name, filter bytecode and the
1053 * Return an ust_app_event object or NULL on error.
1055 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1056 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1057 const struct lttng_event_exclusion
*exclusion
)
1059 struct lttng_ht_iter iter
;
1060 struct lttng_ht_node_str
*node
;
1061 struct ust_app_event
*event
= NULL
;
1062 struct ust_app_ht_key key
;
1067 /* Setup key for event lookup. */
1069 key
.filter
= filter
;
1070 key
.loglevel
= loglevel
;
1071 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1072 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1074 /* Lookup using the event name as hash and a custom match fct. */
1075 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1076 ht_match_ust_app_event
, &key
, &iter
.iter
);
1077 node
= lttng_ht_iter_get_node_str(&iter
);
1082 event
= caa_container_of(node
, struct ust_app_event
, node
);
1089 * Create the channel context on the tracer.
1091 * Called with UST app session lock held.
1094 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1095 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1099 health_code_update();
1101 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1102 ua_chan
->obj
, &ua_ctx
->obj
);
1104 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1105 ERR("UST app create channel context failed for app (pid: %d) "
1106 "with ret %d", app
->pid
, ret
);
1109 * This is normal behavior, an application can die during the
1110 * creation process. Don't report an error so the execution can
1111 * continue normally.
1114 DBG3("UST app disable event failed. Application is dead.");
1119 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1121 DBG2("UST app context handle %d created successfully for channel %s",
1122 ua_ctx
->handle
, ua_chan
->name
);
1125 health_code_update();
1130 * Set the filter on the tracer.
1133 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1134 struct ust_app
*app
)
1138 health_code_update();
1140 if (!ua_event
->filter
) {
1145 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1148 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1149 ERR("UST app event %s filter failed for app (pid: %d) "
1150 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1153 * This is normal behavior, an application can die during the
1154 * creation process. Don't report an error so the execution can
1155 * continue normally.
1158 DBG3("UST app filter event failed. Application is dead.");
1163 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1166 health_code_update();
1171 * Set event exclusions on the tracer.
1174 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1175 struct ust_app
*app
)
1179 health_code_update();
1181 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1186 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1189 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1190 ERR("UST app event %s exclusions failed for app (pid: %d) "
1191 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1194 * This is normal behavior, an application can die during the
1195 * creation process. Don't report an error so the execution can
1196 * continue normally.
1199 DBG3("UST app event exclusion failed. Application is dead.");
1204 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1207 health_code_update();
1212 * Disable the specified event on to UST tracer for the UST session.
1214 static int disable_ust_event(struct ust_app
*app
,
1215 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1219 health_code_update();
1221 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1223 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1224 ERR("UST app event %s disable failed for app (pid: %d) "
1225 "and session handle %d with ret %d",
1226 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1229 * This is normal behavior, an application can die during the
1230 * creation process. Don't report an error so the execution can
1231 * continue normally.
1234 DBG3("UST app disable event failed. Application is dead.");
1239 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1240 ua_event
->attr
.name
, app
->pid
);
1243 health_code_update();
1248 * Disable the specified channel on to UST tracer for the UST session.
1250 static int disable_ust_channel(struct ust_app
*app
,
1251 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1255 health_code_update();
1257 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1259 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1260 ERR("UST app channel %s disable failed for app (pid: %d) "
1261 "and session handle %d with ret %d",
1262 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1265 * This is normal behavior, an application can die during the
1266 * creation process. Don't report an error so the execution can
1267 * continue normally.
1270 DBG3("UST app disable channel failed. Application is dead.");
1275 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1276 ua_chan
->name
, app
->pid
);
1279 health_code_update();
1284 * Enable the specified channel on to UST tracer for the UST session.
1286 static int enable_ust_channel(struct ust_app
*app
,
1287 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1291 health_code_update();
1293 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1295 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1296 ERR("UST app channel %s enable failed for app (pid: %d) "
1297 "and session handle %d with ret %d",
1298 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1301 * This is normal behavior, an application can die during the
1302 * creation process. Don't report an error so the execution can
1303 * continue normally.
1306 DBG3("UST app enable channel failed. Application is dead.");
1311 ua_chan
->enabled
= 1;
1313 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1314 ua_chan
->name
, app
->pid
);
1317 health_code_update();
1322 * Enable the specified event on to UST tracer for the UST session.
1324 static int enable_ust_event(struct ust_app
*app
,
1325 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1329 health_code_update();
1331 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1333 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1334 ERR("UST app event %s enable failed for app (pid: %d) "
1335 "and session handle %d with ret %d",
1336 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1339 * This is normal behavior, an application can die during the
1340 * creation process. Don't report an error so the execution can
1341 * continue normally.
1344 DBG3("UST app enable event failed. Application is dead.");
1349 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1350 ua_event
->attr
.name
, app
->pid
);
1353 health_code_update();
1358 * Send channel and stream buffer to application.
1360 * Return 0 on success. On error, a negative value is returned.
1362 static int send_channel_pid_to_ust(struct ust_app
*app
,
1363 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1366 struct ust_app_stream
*stream
, *stmp
;
1372 health_code_update();
1374 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1377 /* Send channel to the application. */
1378 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1383 health_code_update();
1385 /* Send all streams to application. */
1386 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1387 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1391 /* We don't need the stream anymore once sent to the tracer. */
1392 cds_list_del(&stream
->list
);
1393 delete_ust_app_stream(-1, stream
);
1395 /* Flag the channel that it is sent to the application. */
1396 ua_chan
->is_sent
= 1;
1399 health_code_update();
1404 * Create the specified event onto the UST tracer for a UST session.
1406 * Should be called with session mutex held.
1409 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1410 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1414 health_code_update();
1416 /* Create UST event on tracer */
1417 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1420 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1421 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1422 ua_event
->attr
.name
, app
->pid
, ret
);
1425 * This is normal behavior, an application can die during the
1426 * creation process. Don't report an error so the execution can
1427 * continue normally.
1430 DBG3("UST app create event failed. Application is dead.");
1435 ua_event
->handle
= ua_event
->obj
->handle
;
1437 DBG2("UST app event %s created successfully for pid:%d",
1438 ua_event
->attr
.name
, app
->pid
);
1440 health_code_update();
1442 /* Set filter if one is present. */
1443 if (ua_event
->filter
) {
1444 ret
= set_ust_event_filter(ua_event
, app
);
1450 /* Set exclusions for the event */
1451 if (ua_event
->exclusion
) {
1452 ret
= set_ust_event_exclusion(ua_event
, app
);
1458 /* If event not enabled, disable it on the tracer */
1459 if (ua_event
->enabled
) {
1461 * We now need to explicitly enable the event, since it
1462 * is now disabled at creation.
1464 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1467 * If we hit an EPERM, something is wrong with our enable call. If
1468 * we get an EEXIST, there is a problem on the tracer side since we
1472 case -LTTNG_UST_ERR_PERM
:
1473 /* Code flow problem */
1475 case -LTTNG_UST_ERR_EXIST
:
1476 /* It's OK for our use case. */
1485 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1488 * If we hit an EPERM, something is wrong with our disable call. If
1489 * we get an EEXIST, there is a problem on the tracer side since we
1493 case -LTTNG_UST_ERR_PERM
:
1494 /* Code flow problem */
1496 case -LTTNG_UST_ERR_EXIST
:
1497 /* It's OK for our use case. */
1508 health_code_update();
1513 * Copy data between an UST app event and a LTT event.
1515 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1516 struct ltt_ust_event
*uevent
)
1518 size_t exclusion_alloc_size
;
1520 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1521 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1523 ua_event
->enabled
= uevent
->enabled
;
1525 /* Copy event attributes */
1526 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1528 /* Copy filter bytecode */
1529 if (uevent
->filter
) {
1530 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1531 /* Filter might be NULL here in case of ENONEM. */
1534 /* Copy exclusion data */
1535 if (uevent
->exclusion
) {
1536 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1537 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1538 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1539 if (ua_event
->exclusion
== NULL
) {
1542 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1543 exclusion_alloc_size
);
1549 * Copy data between an UST app channel and a LTT channel.
1551 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1552 struct ltt_ust_channel
*uchan
)
1554 struct lttng_ht_iter iter
;
1555 struct ltt_ust_event
*uevent
;
1556 struct ltt_ust_context
*uctx
;
1557 struct ust_app_event
*ua_event
;
1558 struct ust_app_ctx
*ua_ctx
;
1560 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1562 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1563 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1565 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1566 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1568 /* Copy event attributes since the layout is different. */
1569 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1570 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1571 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1572 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1573 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1574 ua_chan
->attr
.output
= uchan
->attr
.output
;
1576 * Note that the attribute channel type is not set since the channel on the
1577 * tracing registry side does not have this information.
1580 ua_chan
->enabled
= uchan
->enabled
;
1581 ua_chan
->tracing_channel_id
= uchan
->id
;
1583 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1584 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1585 if (ua_ctx
== NULL
) {
1588 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1589 (unsigned long) ua_ctx
->ctx
.ctx
);
1590 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1591 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1594 /* Copy all events from ltt ust channel to ust app channel */
1595 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1596 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1597 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1598 if (ua_event
== NULL
) {
1599 DBG2("UST event %s not found on shadow copy channel",
1601 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1602 if (ua_event
== NULL
) {
1605 shadow_copy_event(ua_event
, uevent
);
1606 add_unique_ust_app_event(ua_chan
, ua_event
);
1610 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1614 * Copy data between a UST app session and a regular LTT session.
1616 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1617 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1619 struct lttng_ht_node_str
*ua_chan_node
;
1620 struct lttng_ht_iter iter
;
1621 struct ltt_ust_channel
*uchan
;
1622 struct ust_app_channel
*ua_chan
;
1624 struct tm
*timeinfo
;
1628 /* Get date and time for unique app path */
1630 timeinfo
= localtime(&rawtime
);
1631 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1633 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1635 ua_sess
->tracing_id
= usess
->id
;
1636 ua_sess
->id
= get_next_session_id();
1637 ua_sess
->uid
= app
->uid
;
1638 ua_sess
->gid
= app
->gid
;
1639 ua_sess
->euid
= usess
->uid
;
1640 ua_sess
->egid
= usess
->gid
;
1641 ua_sess
->buffer_type
= usess
->buffer_type
;
1642 ua_sess
->bits_per_long
= app
->bits_per_long
;
1643 /* There is only one consumer object per session possible. */
1644 ua_sess
->consumer
= usess
->consumer
;
1645 ua_sess
->output_traces
= usess
->output_traces
;
1646 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1647 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1648 &usess
->metadata_attr
);
1650 switch (ua_sess
->buffer_type
) {
1651 case LTTNG_BUFFER_PER_PID
:
1652 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1653 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1656 case LTTNG_BUFFER_PER_UID
:
1657 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1658 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1665 PERROR("asprintf UST shadow copy session");
1670 /* Iterate over all channels in global domain. */
1671 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1673 struct lttng_ht_iter uiter
;
1675 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1676 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1677 if (ua_chan_node
!= NULL
) {
1678 /* Session exist. Contiuing. */
1682 DBG2("Channel %s not found on shadow session copy, creating it",
1684 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1685 if (ua_chan
== NULL
) {
1686 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1689 shadow_copy_channel(ua_chan
, uchan
);
1691 * The concept of metadata channel does not exist on the tracing
1692 * registry side of the session daemon so this can only be a per CPU
1693 * channel and not metadata.
1695 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1697 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1705 * Lookup sesison wrapper.
1708 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1709 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1711 /* Get right UST app session from app */
1712 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1716 * Return ust app session from the app session hashtable using the UST session
1719 static struct ust_app_session
*lookup_session_by_app(
1720 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1722 struct lttng_ht_iter iter
;
1723 struct lttng_ht_node_u64
*node
;
1725 __lookup_session_by_app(usess
, app
, &iter
);
1726 node
= lttng_ht_iter_get_node_u64(&iter
);
1731 return caa_container_of(node
, struct ust_app_session
, node
);
1738 * Setup buffer registry per PID for the given session and application. If none
1739 * is found, a new one is created, added to the global registry and
1740 * initialized. If regp is valid, it's set with the newly created object.
1742 * Return 0 on success or else a negative value.
1744 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1745 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1748 struct buffer_reg_pid
*reg_pid
;
1755 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1758 * This is the create channel path meaning that if there is NO
1759 * registry available, we have to create one for this session.
1761 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1765 buffer_reg_pid_add(reg_pid
);
1770 /* Initialize registry. */
1771 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1772 app
->bits_per_long
, app
->uint8_t_alignment
,
1773 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1774 app
->uint64_t_alignment
, app
->long_alignment
,
1775 app
->byte_order
, app
->version
.major
,
1776 app
->version
.minor
);
1781 DBG3("UST app buffer registry per PID created successfully");
1793 * Setup buffer registry per UID for the given session and application. If none
1794 * is found, a new one is created, added to the global registry and
1795 * initialized. If regp is valid, it's set with the newly created object.
1797 * Return 0 on success or else a negative value.
1799 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1800 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1803 struct buffer_reg_uid
*reg_uid
;
1810 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1813 * This is the create channel path meaning that if there is NO
1814 * registry available, we have to create one for this session.
1816 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1817 LTTNG_DOMAIN_UST
, ®_uid
);
1821 buffer_reg_uid_add(reg_uid
);
1826 /* Initialize registry. */
1827 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1828 app
->bits_per_long
, app
->uint8_t_alignment
,
1829 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1830 app
->uint64_t_alignment
, app
->long_alignment
,
1831 app
->byte_order
, app
->version
.major
,
1832 app
->version
.minor
);
1836 /* Add node to teardown list of the session. */
1837 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1839 DBG3("UST app buffer registry per UID created successfully");
1851 * Create a session on the tracer side for the given app.
1853 * On success, ua_sess_ptr is populated with the session pointer or else left
1854 * untouched. If the session was created, is_created is set to 1. On error,
1855 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1858 * Returns 0 on success or else a negative code which is either -ENOMEM or
1859 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1861 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1862 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1865 int ret
, created
= 0;
1866 struct ust_app_session
*ua_sess
;
1870 assert(ua_sess_ptr
);
1872 health_code_update();
1874 ua_sess
= lookup_session_by_app(usess
, app
);
1875 if (ua_sess
== NULL
) {
1876 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1877 app
->pid
, usess
->id
);
1878 ua_sess
= alloc_ust_app_session(app
);
1879 if (ua_sess
== NULL
) {
1880 /* Only malloc can failed so something is really wrong */
1884 shadow_copy_session(ua_sess
, usess
, app
);
1888 switch (usess
->buffer_type
) {
1889 case LTTNG_BUFFER_PER_PID
:
1890 /* Init local registry. */
1891 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1896 case LTTNG_BUFFER_PER_UID
:
1897 /* Look for a global registry. If none exists, create one. */
1898 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1909 health_code_update();
1911 if (ua_sess
->handle
== -1) {
1912 ret
= ustctl_create_session(app
->sock
);
1914 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1915 ERR("Creating session for app pid %d with ret %d",
1918 DBG("UST app creating session failed. Application is dead");
1920 * This is normal behavior, an application can die during the
1921 * creation process. Don't report an error so the execution can
1922 * continue normally. This will get flagged ENOTCONN and the
1923 * caller will handle it.
1927 delete_ust_app_session(-1, ua_sess
, app
);
1928 if (ret
!= -ENOMEM
) {
1930 * Tracer is probably gone or got an internal error so let's
1931 * behave like it will soon unregister or not usable.
1938 ua_sess
->handle
= ret
;
1940 /* Add ust app session to app's HT */
1941 lttng_ht_node_init_u64(&ua_sess
->node
,
1942 ua_sess
->tracing_id
);
1943 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1945 DBG2("UST app session created successfully with handle %d", ret
);
1948 *ua_sess_ptr
= ua_sess
;
1950 *is_created
= created
;
1953 /* Everything went well. */
1957 health_code_update();
1962 * Create a context for the channel on the tracer.
1964 * Called with UST app session lock held and a RCU read side lock.
1967 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1968 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1969 struct ust_app
*app
)
1972 struct lttng_ht_iter iter
;
1973 struct lttng_ht_node_ulong
*node
;
1974 struct ust_app_ctx
*ua_ctx
;
1976 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1978 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1979 node
= lttng_ht_iter_get_node_ulong(&iter
);
1985 ua_ctx
= alloc_ust_app_ctx(uctx
);
1986 if (ua_ctx
== NULL
) {
1992 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1993 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1994 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1996 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2006 * Enable on the tracer side a ust app event for the session and channel.
2008 * Called with UST app session lock held.
2011 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2012 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2016 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2021 ua_event
->enabled
= 1;
2028 * Disable on the tracer side a ust app event for the session and channel.
2030 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2031 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2035 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2040 ua_event
->enabled
= 0;
2047 * Lookup ust app channel for session and disable it on the tracer side.
2050 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2051 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2055 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2060 ua_chan
->enabled
= 0;
2067 * Lookup ust app channel for session and enable it on the tracer side. This
2068 * MUST be called with a RCU read side lock acquired.
2070 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2071 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2074 struct lttng_ht_iter iter
;
2075 struct lttng_ht_node_str
*ua_chan_node
;
2076 struct ust_app_channel
*ua_chan
;
2078 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2079 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2080 if (ua_chan_node
== NULL
) {
2081 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2082 uchan
->name
, ua_sess
->tracing_id
);
2086 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2088 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2098 * Ask the consumer to create a channel and get it if successful.
2100 * Return 0 on success or else a negative value.
2102 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2103 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2104 int bitness
, struct ust_registry_session
*registry
)
2107 unsigned int nb_fd
= 0;
2108 struct consumer_socket
*socket
;
2116 health_code_update();
2118 /* Get the right consumer socket for the application. */
2119 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2125 health_code_update();
2127 /* Need one fd for the channel. */
2128 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2130 ERR("Exhausted number of available FD upon create channel");
2135 * Ask consumer to create channel. The consumer will return the number of
2136 * stream we have to expect.
2138 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2145 * Compute the number of fd needed before receiving them. It must be 2 per
2146 * stream (2 being the default value here).
2148 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2150 /* Reserve the amount of file descriptor we need. */
2151 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2153 ERR("Exhausted number of available FD upon create channel");
2154 goto error_fd_get_stream
;
2157 health_code_update();
2160 * Now get the channel from the consumer. This call wil populate the stream
2161 * list of that channel and set the ust objects.
2163 if (usess
->consumer
->enabled
) {
2164 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2174 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2175 error_fd_get_stream
:
2177 * Initiate a destroy channel on the consumer since we had an error
2178 * handling it on our side. The return value is of no importance since we
2179 * already have a ret value set by the previous error that we need to
2182 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2184 lttng_fd_put(LTTNG_FD_APPS
, 1);
2186 health_code_update();
2192 * Duplicate the ust data object of the ust app stream and save it in the
2193 * buffer registry stream.
2195 * Return 0 on success or else a negative value.
2197 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2198 struct ust_app_stream
*stream
)
2205 /* Reserve the amount of file descriptor we need. */
2206 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2208 ERR("Exhausted number of available FD upon duplicate stream");
2212 /* Duplicate object for stream once the original is in the registry. */
2213 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2214 reg_stream
->obj
.ust
);
2216 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2217 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2218 lttng_fd_put(LTTNG_FD_APPS
, 2);
2221 stream
->handle
= stream
->obj
->handle
;
2228 * Duplicate the ust data object of the ust app. channel and save it in the
2229 * buffer registry channel.
2231 * Return 0 on success or else a negative value.
2233 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2234 struct ust_app_channel
*ua_chan
)
2241 /* Need two fds for the channel. */
2242 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2244 ERR("Exhausted number of available FD upon duplicate channel");
2248 /* Duplicate object for stream once the original is in the registry. */
2249 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2251 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2252 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2255 ua_chan
->handle
= ua_chan
->obj
->handle
;
2260 lttng_fd_put(LTTNG_FD_APPS
, 1);
2266 * For a given channel buffer registry, setup all streams of the given ust
2267 * application channel.
2269 * Return 0 on success or else a negative value.
2271 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2272 struct ust_app_channel
*ua_chan
)
2275 struct ust_app_stream
*stream
, *stmp
;
2280 DBG2("UST app setup buffer registry stream");
2282 /* Send all streams to application. */
2283 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2284 struct buffer_reg_stream
*reg_stream
;
2286 ret
= buffer_reg_stream_create(®_stream
);
2292 * Keep original pointer and nullify it in the stream so the delete
2293 * stream call does not release the object.
2295 reg_stream
->obj
.ust
= stream
->obj
;
2297 buffer_reg_stream_add(reg_stream
, reg_chan
);
2299 /* We don't need the streams anymore. */
2300 cds_list_del(&stream
->list
);
2301 delete_ust_app_stream(-1, stream
);
2309 * Create a buffer registry channel for the given session registry and
2310 * application channel object. If regp pointer is valid, it's set with the
2311 * created object. Important, the created object is NOT added to the session
2312 * registry hash table.
2314 * Return 0 on success else a negative value.
2316 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2317 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2320 struct buffer_reg_channel
*reg_chan
= NULL
;
2325 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2327 /* Create buffer registry channel. */
2328 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2333 reg_chan
->consumer_key
= ua_chan
->key
;
2334 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2335 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2337 /* Create and add a channel registry to session. */
2338 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2339 ua_chan
->tracing_channel_id
);
2343 buffer_reg_channel_add(reg_sess
, reg_chan
);
2352 /* Safe because the registry channel object was not added to any HT. */
2353 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2359 * Setup buffer registry channel for the given session registry and application
2360 * channel object. If regp pointer is valid, it's set with the created object.
2362 * Return 0 on success else a negative value.
2364 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2365 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2372 assert(ua_chan
->obj
);
2374 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2376 /* Setup all streams for the registry. */
2377 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2382 reg_chan
->obj
.ust
= ua_chan
->obj
;
2383 ua_chan
->obj
= NULL
;
2388 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2389 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2394 * Send buffer registry channel to the application.
2396 * Return 0 on success else a negative value.
2398 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2399 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2400 struct ust_app_channel
*ua_chan
)
2403 struct buffer_reg_stream
*reg_stream
;
2410 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2412 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2417 /* Send channel to the application. */
2418 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2423 health_code_update();
2425 /* Send all streams to application. */
2426 pthread_mutex_lock(®_chan
->stream_list_lock
);
2427 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2428 struct ust_app_stream stream
;
2430 ret
= duplicate_stream_object(reg_stream
, &stream
);
2432 goto error_stream_unlock
;
2435 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2437 (void) release_ust_app_stream(-1, &stream
);
2438 goto error_stream_unlock
;
2442 * The return value is not important here. This function will output an
2445 (void) release_ust_app_stream(-1, &stream
);
2447 ua_chan
->is_sent
= 1;
2449 error_stream_unlock
:
2450 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2456 * Create and send to the application the created buffers with per UID buffers.
2458 * Return 0 on success else a negative value.
2460 static int create_channel_per_uid(struct ust_app
*app
,
2461 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2462 struct ust_app_channel
*ua_chan
)
2465 struct buffer_reg_uid
*reg_uid
;
2466 struct buffer_reg_channel
*reg_chan
;
2473 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2475 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2477 * The session creation handles the creation of this global registry
2478 * object. If none can be find, there is a code flow problem or a
2483 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2486 /* Create the buffer registry channel object. */
2487 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2494 * Create the buffers on the consumer side. This call populates the
2495 * ust app channel object with all streams and data object.
2497 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2498 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2501 * Let's remove the previously created buffer registry channel so
2502 * it's not visible anymore in the session registry.
2504 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2505 ua_chan
->tracing_channel_id
);
2506 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2507 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2512 * Setup the streams and add it to the session registry.
2514 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2521 /* Send buffers to the application. */
2522 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2532 * Create and send to the application the created buffers with per PID buffers.
2534 * Return 0 on success else a negative value.
2536 static int create_channel_per_pid(struct ust_app
*app
,
2537 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2538 struct ust_app_channel
*ua_chan
)
2541 struct ust_registry_session
*registry
;
2548 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2552 registry
= get_session_registry(ua_sess
);
2555 /* Create and add a new channel registry to session. */
2556 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2561 /* Create and get channel on the consumer side. */
2562 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2563 app
->bits_per_long
, registry
);
2568 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2579 * From an already allocated ust app channel, create the channel buffers if
2580 * need and send it to the application. This MUST be called with a RCU read
2581 * side lock acquired.
2583 * Return 0 on success or else a negative value.
2585 static int do_create_channel(struct ust_app
*app
,
2586 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2587 struct ust_app_channel
*ua_chan
)
2596 /* Handle buffer type before sending the channel to the application. */
2597 switch (usess
->buffer_type
) {
2598 case LTTNG_BUFFER_PER_UID
:
2600 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2606 case LTTNG_BUFFER_PER_PID
:
2608 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2620 /* Initialize ust objd object using the received handle and add it. */
2621 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2622 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2624 /* If channel is not enabled, disable it on the tracer */
2625 if (!ua_chan
->enabled
) {
2626 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2637 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2638 * newly created channel if not NULL.
2640 * Called with UST app session lock and RCU read-side lock held.
2642 * Return 0 on success or else a negative value.
2644 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2645 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2646 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2647 struct ust_app_channel
**ua_chanp
)
2650 struct lttng_ht_iter iter
;
2651 struct lttng_ht_node_str
*ua_chan_node
;
2652 struct ust_app_channel
*ua_chan
;
2654 /* Lookup channel in the ust app session */
2655 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2656 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2657 if (ua_chan_node
!= NULL
) {
2658 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2662 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2663 if (ua_chan
== NULL
) {
2664 /* Only malloc can fail here */
2668 shadow_copy_channel(ua_chan
, uchan
);
2670 /* Set channel type. */
2671 ua_chan
->attr
.type
= type
;
2673 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2678 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2681 /* Only add the channel if successful on the tracer side. */
2682 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2686 *ua_chanp
= ua_chan
;
2689 /* Everything went well. */
2693 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2699 * Create UST app event and create it on the tracer side.
2701 * Called with ust app session mutex held.
2704 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2705 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2706 struct ust_app
*app
)
2709 struct ust_app_event
*ua_event
;
2711 /* Get event node */
2712 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2713 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2714 if (ua_event
!= NULL
) {
2719 /* Does not exist so create one */
2720 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2721 if (ua_event
== NULL
) {
2722 /* Only malloc can failed so something is really wrong */
2726 shadow_copy_event(ua_event
, uevent
);
2728 /* Create it on the tracer side */
2729 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2731 /* Not found previously means that it does not exist on the tracer */
2732 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2736 add_unique_ust_app_event(ua_chan
, ua_event
);
2738 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2745 /* Valid. Calling here is already in a read side lock */
2746 delete_ust_app_event(-1, ua_event
);
2751 * Create UST metadata and open it on the tracer side.
2753 * Called with UST app session lock held and RCU read side lock.
2755 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2756 struct ust_app
*app
, struct consumer_output
*consumer
)
2759 struct ust_app_channel
*metadata
;
2760 struct consumer_socket
*socket
;
2761 struct ust_registry_session
*registry
;
2767 registry
= get_session_registry(ua_sess
);
2770 pthread_mutex_lock(®istry
->lock
);
2772 /* Metadata already exists for this registry or it was closed previously */
2773 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2778 /* Allocate UST metadata */
2779 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2781 /* malloc() failed */
2786 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2788 /* Need one fd for the channel. */
2789 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2791 ERR("Exhausted number of available FD upon create metadata");
2795 /* Get the right consumer socket for the application. */
2796 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2799 goto error_consumer
;
2803 * Keep metadata key so we can identify it on the consumer side. Assign it
2804 * to the registry *before* we ask the consumer so we avoid the race of the
2805 * consumer requesting the metadata and the ask_channel call on our side
2806 * did not returned yet.
2808 registry
->metadata_key
= metadata
->key
;
2811 * Ask the metadata channel creation to the consumer. The metadata object
2812 * will be created by the consumer and kept their. However, the stream is
2813 * never added or monitored until we do a first push metadata to the
2816 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2819 /* Nullify the metadata key so we don't try to close it later on. */
2820 registry
->metadata_key
= 0;
2821 goto error_consumer
;
2825 * The setup command will make the metadata stream be sent to the relayd,
2826 * if applicable, and the thread managing the metadatas. This is important
2827 * because after this point, if an error occurs, the only way the stream
2828 * can be deleted is to be monitored in the consumer.
2830 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2832 /* Nullify the metadata key so we don't try to close it later on. */
2833 registry
->metadata_key
= 0;
2834 goto error_consumer
;
2837 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2838 metadata
->key
, app
->pid
);
2841 lttng_fd_put(LTTNG_FD_APPS
, 1);
2842 delete_ust_app_channel(-1, metadata
, app
);
2844 pthread_mutex_unlock(®istry
->lock
);
2849 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2850 * acquired before calling this function.
2852 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2854 struct ust_app
*app
= NULL
;
2855 struct lttng_ht_node_ulong
*node
;
2856 struct lttng_ht_iter iter
;
2858 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2859 node
= lttng_ht_iter_get_node_ulong(&iter
);
2861 DBG2("UST app no found with pid %d", pid
);
2865 DBG2("Found UST app by pid %d", pid
);
2867 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2874 * Allocate and init an UST app object using the registration information and
2875 * the command socket. This is called when the command socket connects to the
2878 * The object is returned on success or else NULL.
2880 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2882 struct ust_app
*lta
= NULL
;
2887 DBG3("UST app creating application for socket %d", sock
);
2889 if ((msg
->bits_per_long
== 64 &&
2890 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2891 || (msg
->bits_per_long
== 32 &&
2892 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2893 ERR("Registration failed: application \"%s\" (pid: %d) has "
2894 "%d-bit long, but no consumerd for this size is available.\n",
2895 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2899 lta
= zmalloc(sizeof(struct ust_app
));
2905 lta
->ppid
= msg
->ppid
;
2906 lta
->uid
= msg
->uid
;
2907 lta
->gid
= msg
->gid
;
2909 lta
->bits_per_long
= msg
->bits_per_long
;
2910 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2911 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2912 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2913 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2914 lta
->long_alignment
= msg
->long_alignment
;
2915 lta
->byte_order
= msg
->byte_order
;
2917 lta
->v_major
= msg
->major
;
2918 lta
->v_minor
= msg
->minor
;
2919 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2920 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2921 lta
->notify_sock
= -1;
2923 /* Copy name and make sure it's NULL terminated. */
2924 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2925 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2928 * Before this can be called, when receiving the registration information,
2929 * the application compatibility is checked. So, at this point, the
2930 * application can work with this session daemon.
2932 lta
->compatible
= 1;
2934 lta
->pid
= msg
->pid
;
2935 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2937 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2939 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2946 * For a given application object, add it to every hash table.
2948 void ust_app_add(struct ust_app
*app
)
2951 assert(app
->notify_sock
>= 0);
2956 * On a re-registration, we want to kick out the previous registration of
2959 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2962 * The socket _should_ be unique until _we_ call close. So, a add_unique
2963 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2964 * already in the table.
2966 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2968 /* Add application to the notify socket hash table. */
2969 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2970 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2972 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2973 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2974 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2981 * Set the application version into the object.
2983 * Return 0 on success else a negative value either an errno code or a
2984 * LTTng-UST error code.
2986 int ust_app_version(struct ust_app
*app
)
2992 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2994 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2995 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2997 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
3005 * Unregister app by removing it from the global traceable app list and freeing
3008 * The socket is already closed at this point so no close to sock.
3010 void ust_app_unregister(int sock
)
3012 struct ust_app
*lta
;
3013 struct lttng_ht_node_ulong
*node
;
3014 struct lttng_ht_iter ust_app_sock_iter
;
3015 struct lttng_ht_iter iter
;
3016 struct ust_app_session
*ua_sess
;
3021 /* Get the node reference for a call_rcu */
3022 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3023 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3026 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3027 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3030 * For per-PID buffers, perform "push metadata" and flush all
3031 * application streams before removing app from hash tables,
3032 * ensuring proper behavior of data_pending check.
3033 * Remove sessions so they are not visible during deletion.
3035 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3037 struct ust_registry_session
*registry
;
3039 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3041 /* The session was already removed so scheduled for teardown. */
3045 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3046 (void) ust_app_flush_app_session(lta
, ua_sess
);
3050 * Add session to list for teardown. This is safe since at this point we
3051 * are the only one using this list.
3053 pthread_mutex_lock(&ua_sess
->lock
);
3056 * Normally, this is done in the delete session process which is
3057 * executed in the call rcu below. However, upon registration we can't
3058 * afford to wait for the grace period before pushing data or else the
3059 * data pending feature can race between the unregistration and stop
3060 * command where the data pending command is sent *before* the grace
3063 * The close metadata below nullifies the metadata pointer in the
3064 * session so the delete session will NOT push/close a second time.
3066 registry
= get_session_registry(ua_sess
);
3068 /* Push metadata for application before freeing the application. */
3069 (void) push_metadata(registry
, ua_sess
->consumer
);
3072 * Don't ask to close metadata for global per UID buffers. Close
3073 * metadata only on destroy trace session in this case. Also, the
3074 * previous push metadata could have flag the metadata registry to
3075 * close so don't send a close command if closed.
3077 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3078 /* And ask to close it for this session registry. */
3079 (void) close_metadata(registry
, ua_sess
->consumer
);
3082 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3084 pthread_mutex_unlock(&ua_sess
->lock
);
3087 /* Remove application from PID hash table */
3088 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3092 * Remove application from notify hash table. The thread handling the
3093 * notify socket could have deleted the node so ignore on error because
3094 * either way it's valid. The close of that socket is handled by the other
3097 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3098 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3101 * Ignore return value since the node might have been removed before by an
3102 * add replace during app registration because the PID can be reassigned by
3105 iter
.iter
.node
= <a
->pid_n
.node
;
3106 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3108 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3113 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3120 * Fill events array with all events name of all registered apps.
3122 int ust_app_list_events(struct lttng_event
**events
)
3125 size_t nbmem
, count
= 0;
3126 struct lttng_ht_iter iter
;
3127 struct ust_app
*app
;
3128 struct lttng_event
*tmp_event
;
3130 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3131 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3132 if (tmp_event
== NULL
) {
3133 PERROR("zmalloc ust app events");
3140 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3141 struct lttng_ust_tracepoint_iter uiter
;
3143 health_code_update();
3145 if (!app
->compatible
) {
3147 * TODO: In time, we should notice the caller of this error by
3148 * telling him that this is a version error.
3152 handle
= ustctl_tracepoint_list(app
->sock
);
3154 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3155 ERR("UST app list events getting handle failed for app pid %d",
3161 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3162 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3163 /* Handle ustctl error. */
3165 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3166 ERR("UST app tp list get failed for app %d with ret %d",
3169 DBG3("UST app tp list get failed. Application is dead");
3171 * This is normal behavior, an application can die during the
3172 * creation process. Don't report an error so the execution can
3173 * continue normally. Continue normal execution.
3181 health_code_update();
3182 if (count
>= nbmem
) {
3183 /* In case the realloc fails, we free the memory */
3184 struct lttng_event
*new_tmp_event
;
3187 new_nbmem
= nbmem
<< 1;
3188 DBG2("Reallocating event list from %zu to %zu entries",
3190 new_tmp_event
= realloc(tmp_event
,
3191 new_nbmem
* sizeof(struct lttng_event
));
3192 if (new_tmp_event
== NULL
) {
3193 PERROR("realloc ust app events");
3198 /* Zero the new memory */
3199 memset(new_tmp_event
+ nbmem
, 0,
3200 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3202 tmp_event
= new_tmp_event
;
3204 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3205 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3206 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3207 tmp_event
[count
].pid
= app
->pid
;
3208 tmp_event
[count
].enabled
= -1;
3214 *events
= tmp_event
;
3216 DBG2("UST app list events done (%zu events)", count
);
3221 health_code_update();
3226 * Fill events array with all events name of all registered apps.
3228 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3231 size_t nbmem
, count
= 0;
3232 struct lttng_ht_iter iter
;
3233 struct ust_app
*app
;
3234 struct lttng_event_field
*tmp_event
;
3236 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3237 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3238 if (tmp_event
== NULL
) {
3239 PERROR("zmalloc ust app event fields");
3246 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3247 struct lttng_ust_field_iter uiter
;
3249 health_code_update();
3251 if (!app
->compatible
) {
3253 * TODO: In time, we should notice the caller of this error by
3254 * telling him that this is a version error.
3258 handle
= ustctl_tracepoint_field_list(app
->sock
);
3260 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3261 ERR("UST app list field getting handle failed for app pid %d",
3267 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3268 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3269 /* Handle ustctl error. */
3271 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3272 ERR("UST app tp list field failed for app %d with ret %d",
3275 DBG3("UST app tp list field failed. Application is dead");
3277 * This is normal behavior, an application can die during the
3278 * creation process. Don't report an error so the execution can
3279 * continue normally. Reset list and count for next app.
3287 health_code_update();
3288 if (count
>= nbmem
) {
3289 /* In case the realloc fails, we free the memory */
3290 struct lttng_event_field
*new_tmp_event
;
3293 new_nbmem
= nbmem
<< 1;
3294 DBG2("Reallocating event field list from %zu to %zu entries",
3296 new_tmp_event
= realloc(tmp_event
,
3297 new_nbmem
* sizeof(struct lttng_event_field
));
3298 if (new_tmp_event
== NULL
) {
3299 PERROR("realloc ust app event fields");
3304 /* Zero the new memory */
3305 memset(new_tmp_event
+ nbmem
, 0,
3306 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3308 tmp_event
= new_tmp_event
;
3311 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3312 /* Mapping between these enums matches 1 to 1. */
3313 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3314 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3316 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3317 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3318 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3319 tmp_event
[count
].event
.pid
= app
->pid
;
3320 tmp_event
[count
].event
.enabled
= -1;
3326 *fields
= tmp_event
;
3328 DBG2("UST app list event fields done (%zu events)", count
);
3333 health_code_update();
3338 * Free and clean all traceable apps of the global list.
3340 * Should _NOT_ be called with RCU read-side lock held.
3342 void ust_app_clean_list(void)
3345 struct ust_app
*app
;
3346 struct lttng_ht_iter iter
;
3348 DBG2("UST app cleaning registered apps hash table");
3352 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3353 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3355 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3358 /* Cleanup socket hash table */
3359 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3361 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3365 /* Cleanup notify socket hash table */
3366 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3367 notify_sock_n
.node
) {
3368 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3373 /* Destroy is done only when the ht is empty */
3374 ht_cleanup_push(ust_app_ht
);
3375 ht_cleanup_push(ust_app_ht_by_sock
);
3376 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3380 * Init UST app hash table.
3382 void ust_app_ht_alloc(void)
3384 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3385 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3386 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3390 * For a specific UST session, disable the channel for all registered apps.
3392 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3393 struct ltt_ust_channel
*uchan
)
3396 struct lttng_ht_iter iter
;
3397 struct lttng_ht_node_str
*ua_chan_node
;
3398 struct ust_app
*app
;
3399 struct ust_app_session
*ua_sess
;
3400 struct ust_app_channel
*ua_chan
;
3402 if (usess
== NULL
|| uchan
== NULL
) {
3403 ERR("Disabling UST global channel with NULL values");
3408 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3409 uchan
->name
, usess
->id
);
3413 /* For every registered applications */
3414 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3415 struct lttng_ht_iter uiter
;
3416 if (!app
->compatible
) {
3418 * TODO: In time, we should notice the caller of this error by
3419 * telling him that this is a version error.
3423 ua_sess
= lookup_session_by_app(usess
, app
);
3424 if (ua_sess
== NULL
) {
3429 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3430 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3431 /* If the session if found for the app, the channel must be there */
3432 assert(ua_chan_node
);
3434 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3435 /* The channel must not be already disabled */
3436 assert(ua_chan
->enabled
== 1);
3438 /* Disable channel onto application */
3439 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3441 /* XXX: We might want to report this error at some point... */
3453 * For a specific UST session, enable the channel for all registered apps.
3455 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3456 struct ltt_ust_channel
*uchan
)
3459 struct lttng_ht_iter iter
;
3460 struct ust_app
*app
;
3461 struct ust_app_session
*ua_sess
;
3463 if (usess
== NULL
|| uchan
== NULL
) {
3464 ERR("Adding UST global channel to NULL values");
3469 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3470 uchan
->name
, usess
->id
);
3474 /* For every registered applications */
3475 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3476 if (!app
->compatible
) {
3478 * TODO: In time, we should notice the caller of this error by
3479 * telling him that this is a version error.
3483 ua_sess
= lookup_session_by_app(usess
, app
);
3484 if (ua_sess
== NULL
) {
3488 /* Enable channel onto application */
3489 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3491 /* XXX: We might want to report this error at some point... */
3503 * Disable an event in a channel and for a specific session.
3505 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3506 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3509 struct lttng_ht_iter iter
, uiter
;
3510 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3511 struct ust_app
*app
;
3512 struct ust_app_session
*ua_sess
;
3513 struct ust_app_channel
*ua_chan
;
3514 struct ust_app_event
*ua_event
;
3516 DBG("UST app disabling event %s for all apps in channel "
3517 "%s for session id %" PRIu64
,
3518 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3522 /* For all registered applications */
3523 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3524 if (!app
->compatible
) {
3526 * TODO: In time, we should notice the caller of this error by
3527 * telling him that this is a version error.
3531 ua_sess
= lookup_session_by_app(usess
, app
);
3532 if (ua_sess
== NULL
) {
3537 /* Lookup channel in the ust app session */
3538 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3539 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3540 if (ua_chan_node
== NULL
) {
3541 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3542 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3545 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3547 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3548 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3549 if (ua_event_node
== NULL
) {
3550 DBG2("Event %s not found in channel %s for app pid %d."
3551 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3554 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3556 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3558 /* XXX: Report error someday... */
3569 * For a specific UST session, create the channel for all registered apps.
3571 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3572 struct ltt_ust_channel
*uchan
)
3574 int ret
= 0, created
;
3575 struct lttng_ht_iter iter
;
3576 struct ust_app
*app
;
3577 struct ust_app_session
*ua_sess
= NULL
;
3579 /* Very wrong code flow */
3583 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3584 uchan
->name
, usess
->id
);
3588 /* For every registered applications */
3589 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3590 if (!app
->compatible
) {
3592 * TODO: In time, we should notice the caller of this error by
3593 * telling him that this is a version error.
3598 * Create session on the tracer side and add it to app session HT. Note
3599 * that if session exist, it will simply return a pointer to the ust
3602 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3607 * The application's socket is not valid. Either a bad socket
3608 * or a timeout on it. We can't inform the caller that for a
3609 * specific app, the session failed so lets continue here.
3614 goto error_rcu_unlock
;
3619 pthread_mutex_lock(&ua_sess
->lock
);
3620 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3621 sizeof(uchan
->name
))) {
3622 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3625 /* Create channel onto application. We don't need the chan ref. */
3626 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3627 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3629 pthread_mutex_unlock(&ua_sess
->lock
);
3631 if (ret
== -ENOMEM
) {
3632 /* No more memory is a fatal error. Stop right now. */
3633 goto error_rcu_unlock
;
3635 /* Cleanup the created session if it's the case. */
3637 destroy_app_session(app
, ua_sess
);
3648 * Enable event for a specific session and channel on the tracer.
3650 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3651 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3654 struct lttng_ht_iter iter
, uiter
;
3655 struct lttng_ht_node_str
*ua_chan_node
;
3656 struct ust_app
*app
;
3657 struct ust_app_session
*ua_sess
;
3658 struct ust_app_channel
*ua_chan
;
3659 struct ust_app_event
*ua_event
;
3661 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3662 uevent
->attr
.name
, usess
->id
);
3665 * NOTE: At this point, this function is called only if the session and
3666 * channel passed are already created for all apps. and enabled on the
3672 /* For all registered applications */
3673 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3674 if (!app
->compatible
) {
3676 * TODO: In time, we should notice the caller of this error by
3677 * telling him that this is a version error.
3681 ua_sess
= lookup_session_by_app(usess
, app
);
3683 /* The application has problem or is probably dead. */
3687 pthread_mutex_lock(&ua_sess
->lock
);
3689 /* Lookup channel in the ust app session */
3690 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3691 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3692 /* If the channel is not found, there is a code flow error */
3693 assert(ua_chan_node
);
3695 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3697 /* Get event node */
3698 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3699 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3700 if (ua_event
== NULL
) {
3701 DBG3("UST app enable event %s not found for app PID %d."
3702 "Skipping app", uevent
->attr
.name
, app
->pid
);
3706 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3708 pthread_mutex_unlock(&ua_sess
->lock
);
3712 pthread_mutex_unlock(&ua_sess
->lock
);
3721 * For a specific existing UST session and UST channel, creates the event for
3722 * all registered apps.
3724 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3725 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3728 struct lttng_ht_iter iter
, uiter
;
3729 struct lttng_ht_node_str
*ua_chan_node
;
3730 struct ust_app
*app
;
3731 struct ust_app_session
*ua_sess
;
3732 struct ust_app_channel
*ua_chan
;
3734 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3735 uevent
->attr
.name
, usess
->id
);
3739 /* For all registered applications */
3740 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3741 if (!app
->compatible
) {
3743 * TODO: In time, we should notice the caller of this error by
3744 * telling him that this is a version error.
3748 ua_sess
= lookup_session_by_app(usess
, app
);
3750 /* The application has problem or is probably dead. */
3754 pthread_mutex_lock(&ua_sess
->lock
);
3755 /* Lookup channel in the ust app session */
3756 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3757 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3758 /* If the channel is not found, there is a code flow error */
3759 assert(ua_chan_node
);
3761 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3763 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3764 pthread_mutex_unlock(&ua_sess
->lock
);
3766 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3767 /* Possible value at this point: -ENOMEM. If so, we stop! */
3770 DBG2("UST app event %s already exist on app PID %d",
3771 uevent
->attr
.name
, app
->pid
);
3782 * Start tracing for a specific UST session and app.
3785 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3788 struct ust_app_session
*ua_sess
;
3790 DBG("Starting tracing for ust app pid %d", app
->pid
);
3794 if (!app
->compatible
) {
3798 ua_sess
= lookup_session_by_app(usess
, app
);
3799 if (ua_sess
== NULL
) {
3800 /* The session is in teardown process. Ignore and continue. */
3804 pthread_mutex_lock(&ua_sess
->lock
);
3806 /* Upon restart, we skip the setup, already done */
3807 if (ua_sess
->started
) {
3811 /* Create directories if consumer is LOCAL and has a path defined. */
3812 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3813 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3814 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3815 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3817 if (ret
!= -EEXIST
) {
3818 ERR("Trace directory creation error");
3825 * Create the metadata for the application. This returns gracefully if a
3826 * metadata was already set for the session.
3828 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3833 health_code_update();
3836 /* This start the UST tracing */
3837 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3839 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3840 ERR("Error starting tracing for app pid: %d (ret: %d)",
3843 DBG("UST app start session failed. Application is dead.");
3845 * This is normal behavior, an application can die during the
3846 * creation process. Don't report an error so the execution can
3847 * continue normally.
3849 pthread_mutex_unlock(&ua_sess
->lock
);
3855 /* Indicate that the session has been started once */
3856 ua_sess
->started
= 1;
3858 pthread_mutex_unlock(&ua_sess
->lock
);
3860 health_code_update();
3862 /* Quiescent wait after starting trace */
3863 ret
= ustctl_wait_quiescent(app
->sock
);
3864 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3865 ERR("UST app wait quiescent failed for app pid %d ret %d",
3871 health_code_update();
3875 pthread_mutex_unlock(&ua_sess
->lock
);
3877 health_code_update();
3882 * Stop tracing for a specific UST session and app.
3885 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3888 struct ust_app_session
*ua_sess
;
3889 struct ust_registry_session
*registry
;
3891 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3895 if (!app
->compatible
) {
3896 goto end_no_session
;
3899 ua_sess
= lookup_session_by_app(usess
, app
);
3900 if (ua_sess
== NULL
) {
3901 goto end_no_session
;
3904 pthread_mutex_lock(&ua_sess
->lock
);
3907 * If started = 0, it means that stop trace has been called for a session
3908 * that was never started. It's possible since we can have a fail start
3909 * from either the application manager thread or the command thread. Simply
3910 * indicate that this is a stop error.
3912 if (!ua_sess
->started
) {
3913 goto error_rcu_unlock
;
3916 health_code_update();
3918 /* This inhibits UST tracing */
3919 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3921 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3922 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3925 DBG("UST app stop 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.
3933 goto error_rcu_unlock
;
3936 health_code_update();
3938 /* Quiescent wait after stopping trace */
3939 ret
= ustctl_wait_quiescent(app
->sock
);
3940 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3941 ERR("UST app wait quiescent failed for app pid %d ret %d",
3945 health_code_update();
3947 registry
= get_session_registry(ua_sess
);
3950 /* Push metadata for application before freeing the application. */
3951 (void) push_metadata(registry
, ua_sess
->consumer
);
3954 pthread_mutex_unlock(&ua_sess
->lock
);
3957 health_code_update();
3961 pthread_mutex_unlock(&ua_sess
->lock
);
3963 health_code_update();
3968 int ust_app_flush_app_session(struct ust_app
*app
,
3969 struct ust_app_session
*ua_sess
)
3971 int ret
, retval
= 0;
3972 struct lttng_ht_iter iter
;
3973 struct ust_app_channel
*ua_chan
;
3974 struct consumer_socket
*socket
;
3976 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
3980 if (!app
->compatible
) {
3981 goto end_not_compatible
;
3984 pthread_mutex_lock(&ua_sess
->lock
);
3986 health_code_update();
3988 /* Flushing buffers */
3989 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
3992 /* Flush buffers and push metadata. */
3993 switch (ua_sess
->buffer_type
) {
3994 case LTTNG_BUFFER_PER_PID
:
3995 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3997 health_code_update();
3998 assert(ua_chan
->is_sent
);
3999 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4001 ERR("Error flushing consumer channel");
4007 case LTTNG_BUFFER_PER_UID
:
4013 health_code_update();
4015 pthread_mutex_unlock(&ua_sess
->lock
);
4019 health_code_update();
4024 * Flush buffers for all applications for a specific UST session.
4025 * Called with UST session lock held.
4028 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4033 DBG("Flushing session buffers for all ust apps");
4037 /* Flush buffers and push metadata. */
4038 switch (usess
->buffer_type
) {
4039 case LTTNG_BUFFER_PER_UID
:
4041 struct buffer_reg_uid
*reg
;
4042 struct lttng_ht_iter iter
;
4044 /* Flush all per UID buffers associated to that session. */
4045 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4046 struct ust_registry_session
*ust_session_reg
;
4047 struct buffer_reg_channel
*reg_chan
;
4048 struct consumer_socket
*socket
;
4050 /* Get consumer socket to use to push the metadata.*/
4051 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4054 /* Ignore request if no consumer is found for the session. */
4058 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4059 reg_chan
, node
.node
) {
4061 * The following call will print error values so the return
4062 * code is of little importance because whatever happens, we
4063 * have to try them all.
4065 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4068 ust_session_reg
= reg
->registry
->reg
.ust
;
4069 /* Push metadata. */
4070 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4075 case LTTNG_BUFFER_PER_PID
:
4077 struct ust_app_session
*ua_sess
;
4078 struct lttng_ht_iter iter
;
4079 struct ust_app
*app
;
4081 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4082 ua_sess
= lookup_session_by_app(usess
, app
);
4083 if (ua_sess
== NULL
) {
4086 (void) ust_app_flush_app_session(app
, ua_sess
);
4097 health_code_update();
4102 * Destroy a specific UST session in apps.
4104 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4107 struct ust_app_session
*ua_sess
;
4108 struct lttng_ht_iter iter
;
4109 struct lttng_ht_node_u64
*node
;
4111 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4115 if (!app
->compatible
) {
4119 __lookup_session_by_app(usess
, app
, &iter
);
4120 node
= lttng_ht_iter_get_node_u64(&iter
);
4122 /* Session is being or is deleted. */
4125 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4127 health_code_update();
4128 destroy_app_session(app
, ua_sess
);
4130 health_code_update();
4132 /* Quiescent wait after stopping trace */
4133 ret
= ustctl_wait_quiescent(app
->sock
);
4134 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4135 ERR("UST app wait quiescent failed for app pid %d ret %d",
4140 health_code_update();
4145 * Start tracing for the UST session.
4147 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4150 struct lttng_ht_iter iter
;
4151 struct ust_app
*app
;
4153 DBG("Starting all UST traces");
4157 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4158 ret
= ust_app_start_trace(usess
, app
);
4160 /* Continue to next apps even on error */
4171 * Start tracing for the UST session.
4172 * Called with UST session lock held.
4174 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4177 struct lttng_ht_iter iter
;
4178 struct ust_app
*app
;
4180 DBG("Stopping all UST traces");
4184 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4185 ret
= ust_app_stop_trace(usess
, app
);
4187 /* Continue to next apps even on error */
4192 (void) ust_app_flush_session(usess
);
4200 * Destroy app UST session.
4202 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4205 struct lttng_ht_iter iter
;
4206 struct ust_app
*app
;
4208 DBG("Destroy all UST traces");
4212 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4213 ret
= destroy_trace(usess
, app
);
4215 /* Continue to next apps even on error */
4226 * Add channels/events from UST global domain to registered apps at sock.
4228 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4231 struct lttng_ht_iter iter
, uiter
;
4232 struct ust_app
*app
;
4233 struct ust_app_session
*ua_sess
= NULL
;
4234 struct ust_app_channel
*ua_chan
;
4235 struct ust_app_event
*ua_event
;
4236 struct ust_app_ctx
*ua_ctx
;
4241 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4246 app
= ust_app_find_by_sock(sock
);
4249 * Application can be unregistered before so this is possible hence
4250 * simply stopping the update.
4252 DBG3("UST app update failed to find app sock %d", sock
);
4256 if (!app
->compatible
) {
4260 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4262 /* Tracer is probably gone or ENOMEM. */
4267 pthread_mutex_lock(&ua_sess
->lock
);
4270 * We can iterate safely here over all UST app session since the create ust
4271 * app session above made a shadow copy of the UST global domain from the
4274 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4276 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4279 * Stop everything. On error, the application failed, no more
4280 * file descriptor are available or ENOMEM so stopping here is
4281 * the only thing we can do for now.
4287 * Add context using the list so they are enabled in the same order the
4290 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4291 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4298 /* For each events */
4299 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4301 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4308 pthread_mutex_unlock(&ua_sess
->lock
);
4310 if (usess
->start_trace
) {
4311 ret
= ust_app_start_trace(usess
, app
);
4316 DBG2("UST trace started for app pid %d", app
->pid
);
4319 /* Everything went well at this point. */
4324 pthread_mutex_unlock(&ua_sess
->lock
);
4327 destroy_app_session(app
, ua_sess
);
4334 * Add context to a specific channel for global UST domain.
4336 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4337 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4340 struct lttng_ht_node_str
*ua_chan_node
;
4341 struct lttng_ht_iter iter
, uiter
;
4342 struct ust_app_channel
*ua_chan
= NULL
;
4343 struct ust_app_session
*ua_sess
;
4344 struct ust_app
*app
;
4348 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4349 if (!app
->compatible
) {
4351 * TODO: In time, we should notice the caller of this error by
4352 * telling him that this is a version error.
4356 ua_sess
= lookup_session_by_app(usess
, app
);
4357 if (ua_sess
== NULL
) {
4361 pthread_mutex_lock(&ua_sess
->lock
);
4362 /* Lookup channel in the ust app session */
4363 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4364 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4365 if (ua_chan_node
== NULL
) {
4368 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4370 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4375 pthread_mutex_unlock(&ua_sess
->lock
);
4383 * Enable event for a channel from a UST session for a specific PID.
4385 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4386 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4389 struct lttng_ht_iter iter
;
4390 struct lttng_ht_node_str
*ua_chan_node
;
4391 struct ust_app
*app
;
4392 struct ust_app_session
*ua_sess
;
4393 struct ust_app_channel
*ua_chan
;
4394 struct ust_app_event
*ua_event
;
4396 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4400 app
= ust_app_find_by_pid(pid
);
4402 ERR("UST app enable event per PID %d not found", pid
);
4407 if (!app
->compatible
) {
4412 ua_sess
= lookup_session_by_app(usess
, app
);
4414 /* The application has problem or is probably dead. */
4419 pthread_mutex_lock(&ua_sess
->lock
);
4420 /* Lookup channel in the ust app session */
4421 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4422 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4423 /* If the channel is not found, there is a code flow error */
4424 assert(ua_chan_node
);
4426 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4428 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4429 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4430 if (ua_event
== NULL
) {
4431 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4436 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4443 pthread_mutex_unlock(&ua_sess
->lock
);
4450 * Calibrate registered applications.
4452 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4455 struct lttng_ht_iter iter
;
4456 struct ust_app
*app
;
4460 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4461 if (!app
->compatible
) {
4463 * TODO: In time, we should notice the caller of this error by
4464 * telling him that this is a version error.
4469 health_code_update();
4471 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4475 /* Means that it's not implemented on the tracer side. */
4479 DBG2("Calibrate app PID %d returned with error %d",
4486 DBG("UST app global domain calibration finished");
4490 health_code_update();
4496 * Receive registration and populate the given msg structure.
4498 * On success return 0 else a negative value returned by the ustctl call.
4500 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4503 uint32_t pid
, ppid
, uid
, gid
;
4507 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4508 &pid
, &ppid
, &uid
, &gid
,
4509 &msg
->bits_per_long
,
4510 &msg
->uint8_t_alignment
,
4511 &msg
->uint16_t_alignment
,
4512 &msg
->uint32_t_alignment
,
4513 &msg
->uint64_t_alignment
,
4514 &msg
->long_alignment
,
4521 case LTTNG_UST_ERR_EXITING
:
4522 DBG3("UST app recv reg message failed. Application died");
4524 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4525 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4526 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4527 LTTNG_UST_ABI_MINOR_VERSION
);
4530 ERR("UST app recv reg message failed with ret %d", ret
);
4535 msg
->pid
= (pid_t
) pid
;
4536 msg
->ppid
= (pid_t
) ppid
;
4537 msg
->uid
= (uid_t
) uid
;
4538 msg
->gid
= (gid_t
) gid
;
4545 * Return a ust app channel object using the application object and the channel
4546 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4547 * lock MUST be acquired before calling this function.
4549 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4552 struct lttng_ht_node_ulong
*node
;
4553 struct lttng_ht_iter iter
;
4554 struct ust_app_channel
*ua_chan
= NULL
;
4558 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4559 node
= lttng_ht_iter_get_node_ulong(&iter
);
4561 DBG2("UST app channel find by objd %d not found", objd
);
4565 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4572 * Reply to a register channel notification from an application on the notify
4573 * socket. The channel metadata is also created.
4575 * The session UST registry lock is acquired in this function.
4577 * On success 0 is returned else a negative value.
4579 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4580 size_t nr_fields
, struct ustctl_field
*fields
)
4582 int ret
, ret_code
= 0;
4583 uint32_t chan_id
, reg_count
;
4584 uint64_t chan_reg_key
;
4585 enum ustctl_channel_header type
;
4586 struct ust_app
*app
;
4587 struct ust_app_channel
*ua_chan
;
4588 struct ust_app_session
*ua_sess
;
4589 struct ust_registry_session
*registry
;
4590 struct ust_registry_channel
*chan_reg
;
4594 /* Lookup application. If not found, there is a code flow error. */
4595 app
= find_app_by_notify_sock(sock
);
4597 DBG("Application socket %d is being teardown. Abort event notify",
4601 goto error_rcu_unlock
;
4604 /* Lookup channel by UST object descriptor. */
4605 ua_chan
= find_channel_by_objd(app
, cobjd
);
4607 DBG("Application channel is being teardown. Abort event notify");
4610 goto error_rcu_unlock
;
4613 assert(ua_chan
->session
);
4614 ua_sess
= ua_chan
->session
;
4616 /* Get right session registry depending on the session buffer type. */
4617 registry
= get_session_registry(ua_sess
);
4620 /* Depending on the buffer type, a different channel key is used. */
4621 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4622 chan_reg_key
= ua_chan
->tracing_channel_id
;
4624 chan_reg_key
= ua_chan
->key
;
4627 pthread_mutex_lock(®istry
->lock
);
4629 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4632 if (!chan_reg
->register_done
) {
4633 reg_count
= ust_registry_get_event_count(chan_reg
);
4634 if (reg_count
< 31) {
4635 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4637 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4640 chan_reg
->nr_ctx_fields
= nr_fields
;
4641 chan_reg
->ctx_fields
= fields
;
4642 chan_reg
->header_type
= type
;
4644 /* Get current already assigned values. */
4645 type
= chan_reg
->header_type
;
4647 /* Set to NULL so the error path does not do a double free. */
4650 /* Channel id is set during the object creation. */
4651 chan_id
= chan_reg
->chan_id
;
4653 /* Append to metadata */
4654 if (!chan_reg
->metadata_dumped
) {
4655 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4657 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4663 DBG3("UST app replying to register channel key %" PRIu64
4664 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4667 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4669 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4670 ERR("UST app reply channel failed with ret %d", ret
);
4672 DBG3("UST app reply channel failed. Application died");
4677 /* This channel registry registration is completed. */
4678 chan_reg
->register_done
= 1;
4681 pthread_mutex_unlock(®istry
->lock
);
4691 * Add event to the UST channel registry. When the event is added to the
4692 * registry, the metadata is also created. Once done, this replies to the
4693 * application with the appropriate error code.
4695 * The session UST registry lock is acquired in the function.
4697 * On success 0 is returned else a negative value.
4699 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4700 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4701 char *model_emf_uri
)
4704 uint32_t event_id
= 0;
4705 uint64_t chan_reg_key
;
4706 struct ust_app
*app
;
4707 struct ust_app_channel
*ua_chan
;
4708 struct ust_app_session
*ua_sess
;
4709 struct ust_registry_session
*registry
;
4713 /* Lookup application. If not found, there is a code flow error. */
4714 app
= find_app_by_notify_sock(sock
);
4716 DBG("Application socket %d is being teardown. Abort event notify",
4721 free(model_emf_uri
);
4722 goto error_rcu_unlock
;
4725 /* Lookup channel by UST object descriptor. */
4726 ua_chan
= find_channel_by_objd(app
, cobjd
);
4728 DBG("Application channel is being teardown. Abort event notify");
4732 free(model_emf_uri
);
4733 goto error_rcu_unlock
;
4736 assert(ua_chan
->session
);
4737 ua_sess
= ua_chan
->session
;
4739 registry
= get_session_registry(ua_sess
);
4742 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4743 chan_reg_key
= ua_chan
->tracing_channel_id
;
4745 chan_reg_key
= ua_chan
->key
;
4748 pthread_mutex_lock(®istry
->lock
);
4751 * From this point on, this call acquires the ownership of the sig, fields
4752 * and model_emf_uri meaning any free are done inside it if needed. These
4753 * three variables MUST NOT be read/write after this.
4755 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4756 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4757 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4761 * The return value is returned to ustctl so in case of an error, the
4762 * application can be notified. In case of an error, it's important not to
4763 * return a negative error or else the application will get closed.
4765 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4767 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4768 ERR("UST app reply event failed with ret %d", ret
);
4770 DBG3("UST app reply event failed. Application died");
4773 * No need to wipe the create event since the application socket will
4774 * get close on error hence cleaning up everything by itself.
4779 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4783 pthread_mutex_unlock(®istry
->lock
);
4790 * Handle application notification through the given notify socket.
4792 * Return 0 on success or else a negative value.
4794 int ust_app_recv_notify(int sock
)
4797 enum ustctl_notify_cmd cmd
;
4799 DBG3("UST app receiving notify from sock %d", sock
);
4801 ret
= ustctl_recv_notify(sock
, &cmd
);
4803 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4804 ERR("UST app recv notify failed with ret %d", ret
);
4806 DBG3("UST app recv notify failed. Application died");
4812 case USTCTL_NOTIFY_CMD_EVENT
:
4814 int sobjd
, cobjd
, loglevel
;
4815 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4817 struct ustctl_field
*fields
;
4819 DBG2("UST app ustctl register event received");
4821 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4822 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4824 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4825 ERR("UST app recv event failed with ret %d", ret
);
4827 DBG3("UST app recv event failed. Application died");
4833 * Add event to the UST registry coming from the notify socket. This
4834 * call will free if needed the sig, fields and model_emf_uri. This
4835 * code path loses the ownsership of these variables and transfer them
4836 * to the this function.
4838 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4839 fields
, loglevel
, model_emf_uri
);
4846 case USTCTL_NOTIFY_CMD_CHANNEL
:
4850 struct ustctl_field
*fields
;
4852 DBG2("UST app ustctl register channel received");
4854 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4857 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4858 ERR("UST app recv channel failed with ret %d", ret
);
4860 DBG3("UST app recv channel failed. Application died");
4866 * The fields ownership are transfered to this function call meaning
4867 * that if needed it will be freed. After this, it's invalid to access
4868 * fields or clean it up.
4870 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4879 /* Should NEVER happen. */
4888 * Once the notify socket hangs up, this is called. First, it tries to find the
4889 * corresponding application. On failure, the call_rcu to close the socket is
4890 * executed. If an application is found, it tries to delete it from the notify
4891 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4893 * Note that an object needs to be allocated here so on ENOMEM failure, the
4894 * call RCU is not done but the rest of the cleanup is.
4896 void ust_app_notify_sock_unregister(int sock
)
4899 struct lttng_ht_iter iter
;
4900 struct ust_app
*app
;
4901 struct ust_app_notify_sock_obj
*obj
;
4907 obj
= zmalloc(sizeof(*obj
));
4910 * An ENOMEM is kind of uncool. If this strikes we continue the
4911 * procedure but the call_rcu will not be called. In this case, we
4912 * accept the fd leak rather than possibly creating an unsynchronized
4913 * state between threads.
4915 * TODO: The notify object should be created once the notify socket is
4916 * registered and stored independantely from the ust app object. The
4917 * tricky part is to synchronize the teardown of the application and
4918 * this notify object. Let's keep that in mind so we can avoid this
4919 * kind of shenanigans with ENOMEM in the teardown path.
4926 DBG("UST app notify socket unregister %d", sock
);
4929 * Lookup application by notify socket. If this fails, this means that the
4930 * hash table delete has already been done by the application
4931 * unregistration process so we can safely close the notify socket in a
4934 app
= find_app_by_notify_sock(sock
);
4939 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4942 * Whatever happens here either we fail or succeed, in both cases we have
4943 * to close the socket after a grace period to continue to the call RCU
4944 * here. If the deletion is successful, the application is not visible
4945 * anymore by other threads and is it fails it means that it was already
4946 * deleted from the hash table so either way we just have to close the
4949 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4955 * Close socket after a grace period to avoid for the socket to be reused
4956 * before the application object is freed creating potential race between
4957 * threads trying to add unique in the global hash table.
4960 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4965 * Destroy a ust app data structure and free its memory.
4967 void ust_app_destroy(struct ust_app
*app
)
4973 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4977 * Take a snapshot for a given UST session. The snapshot is sent to the given
4980 * Return 0 on success or else a negative value.
4982 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4983 struct snapshot_output
*output
, int wait
,
4984 uint64_t nb_packets_per_stream
)
4987 unsigned int snapshot_done
= 0;
4988 struct lttng_ht_iter iter
;
4989 struct ust_app
*app
;
4990 char pathname
[PATH_MAX
];
4991 uint64_t max_stream_size
= 0;
4998 switch (usess
->buffer_type
) {
4999 case LTTNG_BUFFER_PER_UID
:
5001 struct buffer_reg_uid
*reg
;
5003 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5004 struct buffer_reg_channel
*reg_chan
;
5005 struct consumer_socket
*socket
;
5007 /* Get consumer socket to use to push the metadata.*/
5008 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5015 memset(pathname
, 0, sizeof(pathname
));
5016 ret
= snprintf(pathname
, sizeof(pathname
),
5017 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5018 reg
->uid
, reg
->bits_per_long
);
5020 PERROR("snprintf snapshot path");
5024 /* Add the UST default trace dir to path. */
5025 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5026 reg_chan
, node
.node
) {
5027 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5028 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5029 nb_packets_per_stream
);
5034 ret
= consumer_snapshot_channel(socket
,
5035 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5036 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5044 case LTTNG_BUFFER_PER_PID
:
5046 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5047 struct consumer_socket
*socket
;
5048 struct lttng_ht_iter chan_iter
;
5049 struct ust_app_channel
*ua_chan
;
5050 struct ust_app_session
*ua_sess
;
5051 struct ust_registry_session
*registry
;
5053 ua_sess
= lookup_session_by_app(usess
, app
);
5055 /* Session not associated with this app. */
5059 /* Get the right consumer socket for the application. */
5060 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5067 /* Add the UST default trace dir to path. */
5068 memset(pathname
, 0, sizeof(pathname
));
5069 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5072 PERROR("snprintf snapshot path");
5076 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5077 ua_chan
, node
.node
) {
5078 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5079 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5080 nb_packets_per_stream
);
5086 registry
= get_session_registry(ua_sess
);
5088 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5089 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5102 if (!snapshot_done
) {
5104 * If no snapshot was made and we are not in the error path, this means
5105 * that there are no buffers thus no (prior) application to snapshot
5106 * data from so we have simply NO data.
5117 * Return the size taken by one more packet per stream.
5119 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5120 uint64_t cur_nr_packets
)
5122 uint64_t tot_size
= 0;
5123 struct ust_app
*app
;
5124 struct lttng_ht_iter iter
;
5128 switch (usess
->buffer_type
) {
5129 case LTTNG_BUFFER_PER_UID
:
5131 struct buffer_reg_uid
*reg
;
5133 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5134 struct buffer_reg_channel
*reg_chan
;
5137 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5138 reg_chan
, node
.node
) {
5139 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5141 * Don't take channel into account if we
5142 * already grab all its packets.
5146 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5152 case LTTNG_BUFFER_PER_PID
:
5155 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5156 struct ust_app_channel
*ua_chan
;
5157 struct ust_app_session
*ua_sess
;
5158 struct lttng_ht_iter chan_iter
;
5160 ua_sess
= lookup_session_by_app(usess
, app
);
5162 /* Session not associated with this app. */
5166 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5167 ua_chan
, node
.node
) {
5168 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5170 * Don't take channel into account if we
5171 * already grab all its packets.
5175 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;