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"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
143 /* One of the exclusions is NULL, fail. */
144 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
148 if (key
->exclusion
&& event
->exclusion
) {
149 /* Both exclusions exists, check count followed by the names. */
150 if (event
->exclusion
->count
!= key
->exclusion
->count
||
151 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
152 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
166 * Unique add of an ust app event in the given ht. This uses the custom
167 * ht_match_ust_app_event match function and the event name as hash.
169 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
170 struct ust_app_event
*event
)
172 struct cds_lfht_node
*node_ptr
;
173 struct ust_app_ht_key key
;
177 assert(ua_chan
->events
);
180 ht
= ua_chan
->events
;
181 key
.name
= event
->attr
.name
;
182 key
.filter
= event
->filter
;
183 key
.loglevel
= event
->attr
.loglevel
;
184 key
.exclusion
= event
->exclusion
;
186 node_ptr
= cds_lfht_add_unique(ht
->ht
,
187 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
188 ht_match_ust_app_event
, &key
, &event
->node
.node
);
189 assert(node_ptr
== &event
->node
.node
);
193 * Close the notify socket from the given RCU head object. This MUST be called
194 * through a call_rcu().
196 static void close_notify_sock_rcu(struct rcu_head
*head
)
199 struct ust_app_notify_sock_obj
*obj
=
200 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
202 /* Must have a valid fd here. */
203 assert(obj
->fd
>= 0);
205 ret
= close(obj
->fd
);
207 ERR("close notify sock %d RCU", obj
->fd
);
209 lttng_fd_put(LTTNG_FD_APPS
, 1);
215 * Return the session registry according to the buffer type of the given
218 * A registry per UID object MUST exists before calling this function or else
219 * it assert() if not found. RCU read side lock must be acquired.
221 static struct ust_registry_session
*get_session_registry(
222 struct ust_app_session
*ua_sess
)
224 struct ust_registry_session
*registry
= NULL
;
228 switch (ua_sess
->buffer_type
) {
229 case LTTNG_BUFFER_PER_PID
:
231 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
235 registry
= reg_pid
->registry
->reg
.ust
;
238 case LTTNG_BUFFER_PER_UID
:
240 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
241 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
245 registry
= reg_uid
->registry
->reg
.ust
;
257 * Delete ust context safely. RCU read lock must be held before calling
261 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
268 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
269 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
270 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
271 sock
, ua_ctx
->obj
->handle
, ret
);
279 * Delete ust app event safely. RCU read lock must be held before calling
283 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
289 free(ua_event
->filter
);
290 if (ua_event
->exclusion
!= NULL
)
291 free(ua_event
->exclusion
);
292 if (ua_event
->obj
!= NULL
) {
293 ret
= ustctl_release_object(sock
, ua_event
->obj
);
294 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
295 ERR("UST app sock %d release event obj failed with ret %d",
304 * Release ust data object of the given stream.
306 * Return 0 on success or else a negative value.
308 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
315 ret
= ustctl_release_object(sock
, stream
->obj
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release stream obj failed with ret %d",
320 lttng_fd_put(LTTNG_FD_APPS
, 2);
328 * Delete ust app stream safely. RCU read lock must be held before calling
332 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
336 (void) release_ust_app_stream(sock
, stream
);
341 * We need to execute ht_destroy outside of RCU read-side critical
342 * section and outside of call_rcu thread, so we postpone its execution
343 * using ht_cleanup_push. It is simpler than to change the semantic of
344 * the many callers of delete_ust_app_session().
347 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
349 struct ust_app_channel
*ua_chan
=
350 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
352 ht_cleanup_push(ua_chan
->ctx
);
353 ht_cleanup_push(ua_chan
->events
);
358 * Delete ust app channel safely. RCU read lock must be held before calling
362 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
366 struct lttng_ht_iter iter
;
367 struct ust_app_event
*ua_event
;
368 struct ust_app_ctx
*ua_ctx
;
369 struct ust_app_stream
*stream
, *stmp
;
370 struct ust_registry_session
*registry
;
374 DBG3("UST app deleting channel %s", ua_chan
->name
);
377 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
378 cds_list_del(&stream
->list
);
379 delete_ust_app_stream(sock
, stream
);
383 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
384 cds_list_del(&ua_ctx
->list
);
385 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
387 delete_ust_app_ctx(sock
, ua_ctx
);
391 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
393 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
395 delete_ust_app_event(sock
, ua_event
);
398 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
399 /* Wipe and free registry from session registry. */
400 registry
= get_session_registry(ua_chan
->session
);
402 ust_registry_channel_del_free(registry
, ua_chan
->key
);
406 if (ua_chan
->obj
!= NULL
) {
407 /* Remove channel from application UST object descriptor. */
408 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
409 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
411 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
412 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
413 ERR("UST app sock %d release channel obj failed with ret %d",
416 lttng_fd_put(LTTNG_FD_APPS
, 1);
419 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
423 * Push metadata to consumer socket.
425 * The socket lock MUST be acquired.
426 * The ust app session lock MUST be acquired.
428 * On success, return the len of metadata pushed or else a negative value.
430 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
431 struct consumer_socket
*socket
, int send_zero_data
)
434 char *metadata_str
= NULL
;
442 * On a push metadata error either the consumer is dead or the metadata
443 * channel has been destroyed because its endpoint might have died (e.g:
444 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
445 * metadata again which is not valid anymore on the consumer side.
447 * The ust app session mutex locked allows us to make this check without
450 if (registry
->metadata_closed
) {
454 pthread_mutex_lock(®istry
->lock
);
456 offset
= registry
->metadata_len_sent
;
457 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
459 DBG3("No metadata to push for metadata key %" PRIu64
,
460 registry
->metadata_key
);
462 if (send_zero_data
) {
463 DBG("No metadata to push");
469 /* Allocate only what we have to send. */
470 metadata_str
= zmalloc(len
);
472 PERROR("zmalloc ust app metadata string");
476 /* Copy what we haven't send out. */
477 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
478 registry
->metadata_len_sent
+= len
;
481 pthread_mutex_unlock(®istry
->lock
);
482 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
483 metadata_str
, len
, offset
);
486 * There is an acceptable race here between the registry metadata key
487 * assignment and the creation on the consumer. The session daemon can
488 * concurrently push metadata for this registry while being created on
489 * the consumer since the metadata key of the registry is assigned
490 * *before* it is setup to avoid the consumer to ask for metadata that
491 * could possibly be not found in the session daemon.
493 * The metadata will get pushed either by the session being stopped or
494 * the consumer requesting metadata if that race is triggered.
496 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
500 /* Update back the actual metadata len sent since it failed here. */
501 pthread_mutex_lock(®istry
->lock
);
502 registry
->metadata_len_sent
-= len
;
503 pthread_mutex_unlock(®istry
->lock
);
513 pthread_mutex_unlock(®istry
->lock
);
520 * For a given application and session, push metadata to consumer. The session
521 * lock MUST be acquired here before calling this.
522 * Either sock or consumer is required : if sock is NULL, the default
523 * socket to send the metadata is retrieved from consumer, if sock
524 * is not NULL we use it to send the metadata.
526 * Return 0 on success else a negative error.
528 static int push_metadata(struct ust_registry_session
*registry
,
529 struct consumer_output
*consumer
)
533 struct consumer_socket
*socket
;
541 * Means that no metadata was assigned to the session. This can happens if
542 * no start has been done previously.
544 if (!registry
->metadata_key
) {
549 /* Get consumer socket to use to push the metadata.*/
550 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
554 goto error_rcu_unlock
;
558 * TODO: Currently, we hold the socket lock around sampling of the next
559 * metadata segment to ensure we send metadata over the consumer socket in
560 * the correct order. This makes the registry lock nest inside the socket
563 * Please note that this is a temporary measure: we should move this lock
564 * back into ust_consumer_push_metadata() when the consumer gets the
565 * ability to reorder the metadata it receives.
567 pthread_mutex_lock(socket
->lock
);
568 ret
= ust_app_push_metadata(registry
, socket
, 0);
569 pthread_mutex_unlock(socket
->lock
);
572 goto error_rcu_unlock
;
580 * On error, flag the registry that the metadata is closed. We were unable
581 * to push anything and this means that either the consumer is not
582 * responding or the metadata cache has been destroyed on the consumer.
584 registry
->metadata_closed
= 1;
591 * Send to the consumer a close metadata command for the given session. Once
592 * done, the metadata channel is deleted and the session metadata pointer is
593 * nullified. The session lock MUST be acquired here unless the application is
594 * in the destroy path.
596 * Return 0 on success else a negative value.
598 static int close_metadata(struct ust_registry_session
*registry
,
599 struct consumer_output
*consumer
)
602 struct consumer_socket
*socket
;
609 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
614 /* Get consumer socket to use to push the metadata.*/
615 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
622 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
629 * Metadata closed. Even on error this means that the consumer is not
630 * responding or not found so either way a second close should NOT be emit
633 registry
->metadata_closed
= 1;
640 * We need to execute ht_destroy outside of RCU read-side critical
641 * section and outside of call_rcu thread, so we postpone its execution
642 * using ht_cleanup_push. It is simpler than to change the semantic of
643 * the many callers of delete_ust_app_session().
646 void delete_ust_app_session_rcu(struct rcu_head
*head
)
648 struct ust_app_session
*ua_sess
=
649 caa_container_of(head
, struct ust_app_session
, rcu_head
);
651 ht_cleanup_push(ua_sess
->channels
);
656 * Delete ust app session safely. RCU read lock must be held before calling
660 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
664 struct lttng_ht_iter iter
;
665 struct ust_app_channel
*ua_chan
;
666 struct ust_registry_session
*registry
;
670 pthread_mutex_lock(&ua_sess
->lock
);
672 registry
= get_session_registry(ua_sess
);
673 if (registry
&& !registry
->metadata_closed
) {
674 /* Push metadata for application before freeing the application. */
675 (void) push_metadata(registry
, ua_sess
->consumer
);
678 * Don't ask to close metadata for global per UID buffers. Close
679 * metadata only on destroy trace session in this case. Also, the
680 * previous push metadata could have flag the metadata registry to
681 * close so don't send a close command if closed.
683 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
684 !registry
->metadata_closed
) {
685 /* And ask to close it for this session registry. */
686 (void) close_metadata(registry
, ua_sess
->consumer
);
690 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
692 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
694 delete_ust_app_channel(sock
, ua_chan
, app
);
697 /* In case of per PID, the registry is kept in the session. */
698 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
699 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
701 buffer_reg_pid_remove(reg_pid
);
702 buffer_reg_pid_destroy(reg_pid
);
706 if (ua_sess
->handle
!= -1) {
707 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
708 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
709 ERR("UST app sock %d release session handle failed with ret %d",
713 pthread_mutex_unlock(&ua_sess
->lock
);
715 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
719 * Delete a traceable application structure from the global list. Never call
720 * this function outside of a call_rcu call.
722 * RCU read side lock should _NOT_ be held when calling this function.
725 void delete_ust_app(struct ust_app
*app
)
728 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
730 /* Delete ust app sessions info */
735 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
737 /* Free every object in the session and the session. */
739 delete_ust_app_session(sock
, ua_sess
, app
);
743 ht_cleanup_push(app
->sessions
);
744 ht_cleanup_push(app
->ust_objd
);
747 * Wait until we have deleted the application from the sock hash table
748 * before closing this socket, otherwise an application could re-use the
749 * socket ID and race with the teardown, using the same hash table entry.
751 * It's OK to leave the close in call_rcu. We want it to stay unique for
752 * all RCU readers that could run concurrently with unregister app,
753 * therefore we _need_ to only close that socket after a grace period. So
754 * it should stay in this RCU callback.
756 * This close() is a very important step of the synchronization model so
757 * every modification to this function must be carefully reviewed.
763 lttng_fd_put(LTTNG_FD_APPS
, 1);
765 DBG2("UST app pid %d deleted", app
->pid
);
770 * URCU intermediate call to delete an UST app.
773 void delete_ust_app_rcu(struct rcu_head
*head
)
775 struct lttng_ht_node_ulong
*node
=
776 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
777 struct ust_app
*app
=
778 caa_container_of(node
, struct ust_app
, pid_n
);
780 DBG3("Call RCU deleting app PID %d", app
->pid
);
785 * Delete the session from the application ht and delete the data structure by
786 * freeing every object inside and releasing them.
788 static void destroy_app_session(struct ust_app
*app
,
789 struct ust_app_session
*ua_sess
)
792 struct lttng_ht_iter iter
;
797 iter
.iter
.node
= &ua_sess
->node
.node
;
798 ret
= lttng_ht_del(app
->sessions
, &iter
);
800 /* Already scheduled for teardown. */
804 /* Once deleted, free the data structure. */
805 delete_ust_app_session(app
->sock
, ua_sess
, app
);
812 * Alloc new UST app session.
815 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
817 struct ust_app_session
*ua_sess
;
819 /* Init most of the default value by allocating and zeroing */
820 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
821 if (ua_sess
== NULL
) {
826 ua_sess
->handle
= -1;
827 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
828 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
829 pthread_mutex_init(&ua_sess
->lock
, NULL
);
838 * Alloc new UST app channel.
841 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
842 struct ust_app_session
*ua_sess
,
843 struct lttng_ust_channel_attr
*attr
)
845 struct ust_app_channel
*ua_chan
;
847 /* Init most of the default value by allocating and zeroing */
848 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
849 if (ua_chan
== NULL
) {
854 /* Setup channel name */
855 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
856 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
858 ua_chan
->enabled
= 1;
859 ua_chan
->handle
= -1;
860 ua_chan
->session
= ua_sess
;
861 ua_chan
->key
= get_next_channel_key();
862 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
863 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
864 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
866 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
867 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
869 /* Copy attributes */
871 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
872 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
873 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
874 ua_chan
->attr
.overwrite
= attr
->overwrite
;
875 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
876 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
877 ua_chan
->attr
.output
= attr
->output
;
879 /* By default, the channel is a per cpu channel. */
880 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
882 DBG3("UST app channel %s allocated", ua_chan
->name
);
891 * Allocate and initialize a UST app stream.
893 * Return newly allocated stream pointer or NULL on error.
895 struct ust_app_stream
*ust_app_alloc_stream(void)
897 struct ust_app_stream
*stream
= NULL
;
899 stream
= zmalloc(sizeof(*stream
));
900 if (stream
== NULL
) {
901 PERROR("zmalloc ust app stream");
905 /* Zero could be a valid value for a handle so flag it to -1. */
913 * Alloc new UST app event.
916 struct ust_app_event
*alloc_ust_app_event(char *name
,
917 struct lttng_ust_event
*attr
)
919 struct ust_app_event
*ua_event
;
921 /* Init most of the default value by allocating and zeroing */
922 ua_event
= zmalloc(sizeof(struct ust_app_event
));
923 if (ua_event
== NULL
) {
928 ua_event
->enabled
= 1;
929 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
930 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
931 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
933 /* Copy attributes */
935 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
938 DBG3("UST app event %s allocated", ua_event
->name
);
947 * Alloc new UST app context.
950 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
952 struct ust_app_ctx
*ua_ctx
;
954 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
955 if (ua_ctx
== NULL
) {
959 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
962 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
965 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
972 * Allocate a filter and copy the given original filter.
974 * Return allocated filter or NULL on error.
976 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
977 struct lttng_ust_filter_bytecode
*orig_f
)
979 struct lttng_ust_filter_bytecode
*filter
= NULL
;
981 /* Copy filter bytecode */
982 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
984 PERROR("zmalloc alloc ust app filter");
988 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
995 * Find an ust_app using the sock and return it. RCU read side lock must be
996 * held before calling this helper function.
998 struct ust_app
*ust_app_find_by_sock(int sock
)
1000 struct lttng_ht_node_ulong
*node
;
1001 struct lttng_ht_iter iter
;
1003 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1004 node
= lttng_ht_iter_get_node_ulong(&iter
);
1006 DBG2("UST app find by sock %d not found", sock
);
1010 return caa_container_of(node
, struct ust_app
, sock_n
);
1017 * Find an ust_app using the notify sock and return it. RCU read side lock must
1018 * be held before calling this helper function.
1020 static struct ust_app
*find_app_by_notify_sock(int sock
)
1022 struct lttng_ht_node_ulong
*node
;
1023 struct lttng_ht_iter iter
;
1025 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1027 node
= lttng_ht_iter_get_node_ulong(&iter
);
1029 DBG2("UST app find by notify sock %d not found", sock
);
1033 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1040 * Lookup for an ust app event based on event name, filter bytecode and the
1043 * Return an ust_app_event object or NULL on error.
1045 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1046 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1047 const struct lttng_event_exclusion
*exclusion
)
1049 struct lttng_ht_iter iter
;
1050 struct lttng_ht_node_str
*node
;
1051 struct ust_app_event
*event
= NULL
;
1052 struct ust_app_ht_key key
;
1057 /* Setup key for event lookup. */
1059 key
.filter
= filter
;
1060 key
.loglevel
= loglevel
;
1061 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1062 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1064 /* Lookup using the event name as hash and a custom match fct. */
1065 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1066 ht_match_ust_app_event
, &key
, &iter
.iter
);
1067 node
= lttng_ht_iter_get_node_str(&iter
);
1072 event
= caa_container_of(node
, struct ust_app_event
, node
);
1079 * Create the channel context on the tracer.
1081 * Called with UST app session lock held.
1084 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1085 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1089 health_code_update();
1091 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1092 ua_chan
->obj
, &ua_ctx
->obj
);
1094 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1095 ERR("UST app create channel context failed for app (pid: %d) "
1096 "with ret %d", app
->pid
, ret
);
1099 * This is normal behavior, an application can die during the
1100 * creation process. Don't report an error so the execution can
1101 * continue normally.
1104 DBG3("UST app disable event failed. Application is dead.");
1109 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1111 DBG2("UST app context handle %d created successfully for channel %s",
1112 ua_ctx
->handle
, ua_chan
->name
);
1115 health_code_update();
1120 * Set the filter on the tracer.
1123 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1124 struct ust_app
*app
)
1128 health_code_update();
1130 if (!ua_event
->filter
) {
1135 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1138 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1139 ERR("UST app event %s filter failed for app (pid: %d) "
1140 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1143 * This is normal behavior, an application can die during the
1144 * creation process. Don't report an error so the execution can
1145 * continue normally.
1148 DBG3("UST app filter event failed. Application is dead.");
1153 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1156 health_code_update();
1161 * Set event exclusions on the tracer.
1164 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1165 struct ust_app
*app
)
1169 health_code_update();
1171 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1176 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1179 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1180 ERR("UST app event %s exclusions failed for app (pid: %d) "
1181 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1184 * This is normal behavior, an application can die during the
1185 * creation process. Don't report an error so the execution can
1186 * continue normally.
1189 DBG3("UST app event exclusion failed. Application is dead.");
1194 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1197 health_code_update();
1202 * Disable the specified event on to UST tracer for the UST session.
1204 static int disable_ust_event(struct ust_app
*app
,
1205 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1209 health_code_update();
1211 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1213 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1214 ERR("UST app event %s disable failed for app (pid: %d) "
1215 "and session handle %d with ret %d",
1216 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1219 * This is normal behavior, an application can die during the
1220 * creation process. Don't report an error so the execution can
1221 * continue normally.
1224 DBG3("UST app disable event failed. Application is dead.");
1229 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1230 ua_event
->attr
.name
, app
->pid
);
1233 health_code_update();
1238 * Disable the specified channel on to UST tracer for the UST session.
1240 static int disable_ust_channel(struct ust_app
*app
,
1241 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1245 health_code_update();
1247 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1249 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1250 ERR("UST app channel %s disable failed for app (pid: %d) "
1251 "and session handle %d with ret %d",
1252 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1255 * This is normal behavior, an application can die during the
1256 * creation process. Don't report an error so the execution can
1257 * continue normally.
1260 DBG3("UST app disable channel failed. Application is dead.");
1265 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1266 ua_chan
->name
, app
->pid
);
1269 health_code_update();
1274 * Enable the specified channel on to UST tracer for the UST session.
1276 static int enable_ust_channel(struct ust_app
*app
,
1277 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1281 health_code_update();
1283 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1285 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1286 ERR("UST app channel %s enable failed for app (pid: %d) "
1287 "and session handle %d with ret %d",
1288 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1291 * This is normal behavior, an application can die during the
1292 * creation process. Don't report an error so the execution can
1293 * continue normally.
1296 DBG3("UST app enable channel failed. Application is dead.");
1301 ua_chan
->enabled
= 1;
1303 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1304 ua_chan
->name
, app
->pid
);
1307 health_code_update();
1312 * Enable the specified event on to UST tracer for the UST session.
1314 static int enable_ust_event(struct ust_app
*app
,
1315 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1319 health_code_update();
1321 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1323 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1324 ERR("UST app event %s enable failed for app (pid: %d) "
1325 "and session handle %d with ret %d",
1326 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1329 * This is normal behavior, an application can die during the
1330 * creation process. Don't report an error so the execution can
1331 * continue normally.
1334 DBG3("UST app enable event failed. Application is dead.");
1339 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1340 ua_event
->attr
.name
, app
->pid
);
1343 health_code_update();
1348 * Send channel and stream buffer to application.
1350 * Return 0 on success. On error, a negative value is returned.
1352 static int send_channel_pid_to_ust(struct ust_app
*app
,
1353 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1356 struct ust_app_stream
*stream
, *stmp
;
1362 health_code_update();
1364 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1367 /* Send channel to the application. */
1368 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1373 health_code_update();
1375 /* Send all streams to application. */
1376 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1377 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1381 /* We don't need the stream anymore once sent to the tracer. */
1382 cds_list_del(&stream
->list
);
1383 delete_ust_app_stream(-1, stream
);
1385 /* Flag the channel that it is sent to the application. */
1386 ua_chan
->is_sent
= 1;
1389 health_code_update();
1394 * Create the specified event onto the UST tracer for a UST session.
1396 * Should be called with session mutex held.
1399 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1400 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1404 health_code_update();
1406 /* Create UST event on tracer */
1407 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1410 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1411 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1412 ua_event
->attr
.name
, app
->pid
, ret
);
1415 * This is normal behavior, an application can die during the
1416 * creation process. Don't report an error so the execution can
1417 * continue normally.
1420 DBG3("UST app create event failed. Application is dead.");
1425 ua_event
->handle
= ua_event
->obj
->handle
;
1427 DBG2("UST app event %s created successfully for pid:%d",
1428 ua_event
->attr
.name
, app
->pid
);
1430 health_code_update();
1432 /* Set filter if one is present. */
1433 if (ua_event
->filter
) {
1434 ret
= set_ust_event_filter(ua_event
, app
);
1440 /* Set exclusions for the event */
1441 if (ua_event
->exclusion
) {
1442 ret
= set_ust_event_exclusion(ua_event
, app
);
1448 /* If event not enabled, disable it on the tracer */
1449 if (ua_event
->enabled
) {
1451 * We now need to explicitly enable the event, since it
1452 * is now disabled at creation.
1454 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1457 * If we hit an EPERM, something is wrong with our enable call. If
1458 * we get an EEXIST, there is a problem on the tracer side since we
1462 case -LTTNG_UST_ERR_PERM
:
1463 /* Code flow problem */
1465 case -LTTNG_UST_ERR_EXIST
:
1466 /* It's OK for our use case. */
1475 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1478 * If we hit an EPERM, something is wrong with our disable call. If
1479 * we get an EEXIST, there is a problem on the tracer side since we
1483 case -LTTNG_UST_ERR_PERM
:
1484 /* Code flow problem */
1486 case -LTTNG_UST_ERR_EXIST
:
1487 /* It's OK for our use case. */
1498 health_code_update();
1503 * Copy data between an UST app event and a LTT event.
1505 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1506 struct ltt_ust_event
*uevent
)
1508 size_t exclusion_alloc_size
;
1510 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1511 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1513 ua_event
->enabled
= uevent
->enabled
;
1515 /* Copy event attributes */
1516 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1518 /* Copy filter bytecode */
1519 if (uevent
->filter
) {
1520 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1521 /* Filter might be NULL here in case of ENONEM. */
1524 /* Copy exclusion data */
1525 if (uevent
->exclusion
) {
1526 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1527 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1528 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1529 if (ua_event
->exclusion
== NULL
) {
1532 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1533 exclusion_alloc_size
);
1539 * Copy data between an UST app channel and a LTT channel.
1541 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1542 struct ltt_ust_channel
*uchan
)
1544 struct lttng_ht_iter iter
;
1545 struct ltt_ust_event
*uevent
;
1546 struct ltt_ust_context
*uctx
;
1547 struct ust_app_event
*ua_event
;
1548 struct ust_app_ctx
*ua_ctx
;
1550 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1552 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1553 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1555 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1556 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1558 /* Copy event attributes since the layout is different. */
1559 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1560 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1561 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1562 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1563 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1564 ua_chan
->attr
.output
= uchan
->attr
.output
;
1566 * Note that the attribute channel type is not set since the channel on the
1567 * tracing registry side does not have this information.
1570 ua_chan
->enabled
= uchan
->enabled
;
1571 ua_chan
->tracing_channel_id
= uchan
->id
;
1573 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1574 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1575 if (ua_ctx
== NULL
) {
1578 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1579 (unsigned long) ua_ctx
->ctx
.ctx
);
1580 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1581 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1584 /* Copy all events from ltt ust channel to ust app channel */
1585 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1586 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1587 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1588 if (ua_event
== NULL
) {
1589 DBG2("UST event %s not found on shadow copy channel",
1591 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1592 if (ua_event
== NULL
) {
1595 shadow_copy_event(ua_event
, uevent
);
1596 add_unique_ust_app_event(ua_chan
, ua_event
);
1600 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1604 * Copy data between a UST app session and a regular LTT session.
1606 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1607 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1609 struct lttng_ht_node_str
*ua_chan_node
;
1610 struct lttng_ht_iter iter
;
1611 struct ltt_ust_channel
*uchan
;
1612 struct ust_app_channel
*ua_chan
;
1614 struct tm
*timeinfo
;
1618 /* Get date and time for unique app path */
1620 timeinfo
= localtime(&rawtime
);
1621 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1623 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1625 ua_sess
->tracing_id
= usess
->id
;
1626 ua_sess
->id
= get_next_session_id();
1627 ua_sess
->uid
= app
->uid
;
1628 ua_sess
->gid
= app
->gid
;
1629 ua_sess
->euid
= usess
->uid
;
1630 ua_sess
->egid
= usess
->gid
;
1631 ua_sess
->buffer_type
= usess
->buffer_type
;
1632 ua_sess
->bits_per_long
= app
->bits_per_long
;
1633 /* There is only one consumer object per session possible. */
1634 ua_sess
->consumer
= usess
->consumer
;
1635 ua_sess
->output_traces
= usess
->output_traces
;
1636 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1637 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1638 &usess
->metadata_attr
);
1640 switch (ua_sess
->buffer_type
) {
1641 case LTTNG_BUFFER_PER_PID
:
1642 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1643 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1646 case LTTNG_BUFFER_PER_UID
:
1647 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1648 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1655 PERROR("asprintf UST shadow copy session");
1660 /* Iterate over all channels in global domain. */
1661 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1663 struct lttng_ht_iter uiter
;
1665 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1666 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1667 if (ua_chan_node
!= NULL
) {
1668 /* Session exist. Contiuing. */
1672 DBG2("Channel %s not found on shadow session copy, creating it",
1674 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1675 if (ua_chan
== NULL
) {
1676 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1679 shadow_copy_channel(ua_chan
, uchan
);
1681 * The concept of metadata channel does not exist on the tracing
1682 * registry side of the session daemon so this can only be a per CPU
1683 * channel and not metadata.
1685 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1687 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1695 * Lookup sesison wrapper.
1698 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1699 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1701 /* Get right UST app session from app */
1702 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1706 * Return ust app session from the app session hashtable using the UST session
1709 static struct ust_app_session
*lookup_session_by_app(
1710 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1712 struct lttng_ht_iter iter
;
1713 struct lttng_ht_node_u64
*node
;
1715 __lookup_session_by_app(usess
, app
, &iter
);
1716 node
= lttng_ht_iter_get_node_u64(&iter
);
1721 return caa_container_of(node
, struct ust_app_session
, node
);
1728 * Setup buffer registry per PID for the given session and application. If none
1729 * is found, a new one is created, added to the global registry and
1730 * initialized. If regp is valid, it's set with the newly created object.
1732 * Return 0 on success or else a negative value.
1734 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1735 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1738 struct buffer_reg_pid
*reg_pid
;
1745 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1748 * This is the create channel path meaning that if there is NO
1749 * registry available, we have to create one for this session.
1751 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1755 buffer_reg_pid_add(reg_pid
);
1760 /* Initialize registry. */
1761 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1762 app
->bits_per_long
, app
->uint8_t_alignment
,
1763 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1764 app
->uint64_t_alignment
, app
->long_alignment
,
1765 app
->byte_order
, app
->version
.major
,
1766 app
->version
.minor
);
1771 DBG3("UST app buffer registry per PID created successfully");
1783 * Setup buffer registry per UID for the given session and application. If none
1784 * is found, a new one is created, added to the global registry and
1785 * initialized. If regp is valid, it's set with the newly created object.
1787 * Return 0 on success or else a negative value.
1789 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1790 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1793 struct buffer_reg_uid
*reg_uid
;
1800 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1803 * This is the create channel path meaning that if there is NO
1804 * registry available, we have to create one for this session.
1806 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1807 LTTNG_DOMAIN_UST
, ®_uid
);
1811 buffer_reg_uid_add(reg_uid
);
1816 /* Initialize registry. */
1817 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1818 app
->bits_per_long
, app
->uint8_t_alignment
,
1819 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1820 app
->uint64_t_alignment
, app
->long_alignment
,
1821 app
->byte_order
, app
->version
.major
,
1822 app
->version
.minor
);
1826 /* Add node to teardown list of the session. */
1827 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1829 DBG3("UST app buffer registry per UID created successfully");
1841 * Create a session on the tracer side for the given app.
1843 * On success, ua_sess_ptr is populated with the session pointer or else left
1844 * untouched. If the session was created, is_created is set to 1. On error,
1845 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1848 * Returns 0 on success or else a negative code which is either -ENOMEM or
1849 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1851 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1852 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1855 int ret
, created
= 0;
1856 struct ust_app_session
*ua_sess
;
1860 assert(ua_sess_ptr
);
1862 health_code_update();
1864 ua_sess
= lookup_session_by_app(usess
, app
);
1865 if (ua_sess
== NULL
) {
1866 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1867 app
->pid
, usess
->id
);
1868 ua_sess
= alloc_ust_app_session(app
);
1869 if (ua_sess
== NULL
) {
1870 /* Only malloc can failed so something is really wrong */
1874 shadow_copy_session(ua_sess
, usess
, app
);
1878 switch (usess
->buffer_type
) {
1879 case LTTNG_BUFFER_PER_PID
:
1880 /* Init local registry. */
1881 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1886 case LTTNG_BUFFER_PER_UID
:
1887 /* Look for a global registry. If none exists, create one. */
1888 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1899 health_code_update();
1901 if (ua_sess
->handle
== -1) {
1902 ret
= ustctl_create_session(app
->sock
);
1904 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1905 ERR("Creating session for app pid %d with ret %d",
1908 DBG("UST app creating session failed. Application is dead");
1910 * This is normal behavior, an application can die during the
1911 * creation process. Don't report an error so the execution can
1912 * continue normally. This will get flagged ENOTCONN and the
1913 * caller will handle it.
1917 delete_ust_app_session(-1, ua_sess
, app
);
1918 if (ret
!= -ENOMEM
) {
1920 * Tracer is probably gone or got an internal error so let's
1921 * behave like it will soon unregister or not usable.
1928 ua_sess
->handle
= ret
;
1930 /* Add ust app session to app's HT */
1931 lttng_ht_node_init_u64(&ua_sess
->node
,
1932 ua_sess
->tracing_id
);
1933 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1935 DBG2("UST app session created successfully with handle %d", ret
);
1938 *ua_sess_ptr
= ua_sess
;
1940 *is_created
= created
;
1943 /* Everything went well. */
1947 health_code_update();
1952 * Create a context for the channel on the tracer.
1954 * Called with UST app session lock held and a RCU read side lock.
1957 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1958 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1959 struct ust_app
*app
)
1962 struct lttng_ht_iter iter
;
1963 struct lttng_ht_node_ulong
*node
;
1964 struct ust_app_ctx
*ua_ctx
;
1966 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1968 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1969 node
= lttng_ht_iter_get_node_ulong(&iter
);
1975 ua_ctx
= alloc_ust_app_ctx(uctx
);
1976 if (ua_ctx
== NULL
) {
1982 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1983 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1984 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1986 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1996 * Enable on the tracer side a ust app event for the session and channel.
1998 * Called with UST app session lock held.
2001 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2002 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2006 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2011 ua_event
->enabled
= 1;
2018 * Disable on the tracer side a ust app event for the session and channel.
2020 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2021 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2025 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2030 ua_event
->enabled
= 0;
2037 * Lookup ust app channel for session and disable it on the tracer side.
2040 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2041 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2045 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2050 ua_chan
->enabled
= 0;
2057 * Lookup ust app channel for session and enable it on the tracer side. This
2058 * MUST be called with a RCU read side lock acquired.
2060 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2061 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2064 struct lttng_ht_iter iter
;
2065 struct lttng_ht_node_str
*ua_chan_node
;
2066 struct ust_app_channel
*ua_chan
;
2068 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2069 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2070 if (ua_chan_node
== NULL
) {
2071 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2072 uchan
->name
, ua_sess
->tracing_id
);
2076 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2078 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2088 * Ask the consumer to create a channel and get it if successful.
2090 * Return 0 on success or else a negative value.
2092 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2093 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2094 int bitness
, struct ust_registry_session
*registry
)
2097 unsigned int nb_fd
= 0;
2098 struct consumer_socket
*socket
;
2106 health_code_update();
2108 /* Get the right consumer socket for the application. */
2109 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2115 health_code_update();
2117 /* Need one fd for the channel. */
2118 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2120 ERR("Exhausted number of available FD upon create channel");
2125 * Ask consumer to create channel. The consumer will return the number of
2126 * stream we have to expect.
2128 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2135 * Compute the number of fd needed before receiving them. It must be 2 per
2136 * stream (2 being the default value here).
2138 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2140 /* Reserve the amount of file descriptor we need. */
2141 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2143 ERR("Exhausted number of available FD upon create channel");
2144 goto error_fd_get_stream
;
2147 health_code_update();
2150 * Now get the channel from the consumer. This call wil populate the stream
2151 * list of that channel and set the ust objects.
2153 if (usess
->consumer
->enabled
) {
2154 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2164 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2165 error_fd_get_stream
:
2167 * Initiate a destroy channel on the consumer since we had an error
2168 * handling it on our side. The return value is of no importance since we
2169 * already have a ret value set by the previous error that we need to
2172 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2174 lttng_fd_put(LTTNG_FD_APPS
, 1);
2176 health_code_update();
2182 * Duplicate the ust data object of the ust app stream and save it in the
2183 * buffer registry stream.
2185 * Return 0 on success or else a negative value.
2187 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2188 struct ust_app_stream
*stream
)
2195 /* Reserve the amount of file descriptor we need. */
2196 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2198 ERR("Exhausted number of available FD upon duplicate stream");
2202 /* Duplicate object for stream once the original is in the registry. */
2203 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2204 reg_stream
->obj
.ust
);
2206 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2207 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2208 lttng_fd_put(LTTNG_FD_APPS
, 2);
2211 stream
->handle
= stream
->obj
->handle
;
2218 * Duplicate the ust data object of the ust app. channel and save it in the
2219 * buffer registry channel.
2221 * Return 0 on success or else a negative value.
2223 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2224 struct ust_app_channel
*ua_chan
)
2231 /* Need two fds for the channel. */
2232 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2234 ERR("Exhausted number of available FD upon duplicate channel");
2238 /* Duplicate object for stream once the original is in the registry. */
2239 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2241 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2242 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2245 ua_chan
->handle
= ua_chan
->obj
->handle
;
2250 lttng_fd_put(LTTNG_FD_APPS
, 1);
2256 * For a given channel buffer registry, setup all streams of the given ust
2257 * application channel.
2259 * Return 0 on success or else a negative value.
2261 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2262 struct ust_app_channel
*ua_chan
)
2265 struct ust_app_stream
*stream
, *stmp
;
2270 DBG2("UST app setup buffer registry stream");
2272 /* Send all streams to application. */
2273 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2274 struct buffer_reg_stream
*reg_stream
;
2276 ret
= buffer_reg_stream_create(®_stream
);
2282 * Keep original pointer and nullify it in the stream so the delete
2283 * stream call does not release the object.
2285 reg_stream
->obj
.ust
= stream
->obj
;
2287 buffer_reg_stream_add(reg_stream
, reg_chan
);
2289 /* We don't need the streams anymore. */
2290 cds_list_del(&stream
->list
);
2291 delete_ust_app_stream(-1, stream
);
2299 * Create a buffer registry channel for the given session registry and
2300 * application channel object. If regp pointer is valid, it's set with the
2301 * created object. Important, the created object is NOT added to the session
2302 * registry hash table.
2304 * Return 0 on success else a negative value.
2306 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2307 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2310 struct buffer_reg_channel
*reg_chan
= NULL
;
2315 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2317 /* Create buffer registry channel. */
2318 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2323 reg_chan
->consumer_key
= ua_chan
->key
;
2324 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2326 /* Create and add a channel registry to session. */
2327 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2328 ua_chan
->tracing_channel_id
);
2332 buffer_reg_channel_add(reg_sess
, reg_chan
);
2341 /* Safe because the registry channel object was not added to any HT. */
2342 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2348 * Setup buffer registry channel for the given session registry and application
2349 * channel object. If regp pointer is valid, it's set with the created object.
2351 * Return 0 on success else a negative value.
2353 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2354 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2361 assert(ua_chan
->obj
);
2363 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2365 /* Setup all streams for the registry. */
2366 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2371 reg_chan
->obj
.ust
= ua_chan
->obj
;
2372 ua_chan
->obj
= NULL
;
2377 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2378 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2383 * Send buffer registry channel to the application.
2385 * Return 0 on success else a negative value.
2387 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2388 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2389 struct ust_app_channel
*ua_chan
)
2392 struct buffer_reg_stream
*reg_stream
;
2399 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2401 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2406 /* Send channel to the application. */
2407 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2412 health_code_update();
2414 /* Send all streams to application. */
2415 pthread_mutex_lock(®_chan
->stream_list_lock
);
2416 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2417 struct ust_app_stream stream
;
2419 ret
= duplicate_stream_object(reg_stream
, &stream
);
2421 goto error_stream_unlock
;
2424 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2426 (void) release_ust_app_stream(-1, &stream
);
2427 goto error_stream_unlock
;
2431 * The return value is not important here. This function will output an
2434 (void) release_ust_app_stream(-1, &stream
);
2436 ua_chan
->is_sent
= 1;
2438 error_stream_unlock
:
2439 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2445 * Create and send to the application the created buffers with per UID buffers.
2447 * Return 0 on success else a negative value.
2449 static int create_channel_per_uid(struct ust_app
*app
,
2450 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2451 struct ust_app_channel
*ua_chan
)
2454 struct buffer_reg_uid
*reg_uid
;
2455 struct buffer_reg_channel
*reg_chan
;
2462 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2464 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2466 * The session creation handles the creation of this global registry
2467 * object. If none can be find, there is a code flow problem or a
2472 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2475 /* Create the buffer registry channel object. */
2476 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2483 * Create the buffers on the consumer side. This call populates the
2484 * ust app channel object with all streams and data object.
2486 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2487 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2490 * Let's remove the previously created buffer registry channel so
2491 * it's not visible anymore in the session registry.
2493 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2494 ua_chan
->tracing_channel_id
);
2495 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2496 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2501 * Setup the streams and add it to the session registry.
2503 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2510 /* Send buffers to the application. */
2511 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2521 * Create and send to the application the created buffers with per PID buffers.
2523 * Return 0 on success else a negative value.
2525 static int create_channel_per_pid(struct ust_app
*app
,
2526 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2527 struct ust_app_channel
*ua_chan
)
2530 struct ust_registry_session
*registry
;
2537 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2541 registry
= get_session_registry(ua_sess
);
2544 /* Create and add a new channel registry to session. */
2545 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2550 /* Create and get channel on the consumer side. */
2551 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2552 app
->bits_per_long
, registry
);
2557 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2568 * From an already allocated ust app channel, create the channel buffers if
2569 * need and send it to the application. This MUST be called with a RCU read
2570 * side lock acquired.
2572 * Return 0 on success or else a negative value.
2574 static int do_create_channel(struct ust_app
*app
,
2575 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2576 struct ust_app_channel
*ua_chan
)
2585 /* Handle buffer type before sending the channel to the application. */
2586 switch (usess
->buffer_type
) {
2587 case LTTNG_BUFFER_PER_UID
:
2589 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2595 case LTTNG_BUFFER_PER_PID
:
2597 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2609 /* Initialize ust objd object using the received handle and add it. */
2610 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2611 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2613 /* If channel is not enabled, disable it on the tracer */
2614 if (!ua_chan
->enabled
) {
2615 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2626 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2627 * newly created channel if not NULL.
2629 * Called with UST app session lock and RCU read-side lock held.
2631 * Return 0 on success or else a negative value.
2633 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2634 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2635 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2636 struct ust_app_channel
**ua_chanp
)
2639 struct lttng_ht_iter iter
;
2640 struct lttng_ht_node_str
*ua_chan_node
;
2641 struct ust_app_channel
*ua_chan
;
2643 /* Lookup channel in the ust app session */
2644 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2645 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2646 if (ua_chan_node
!= NULL
) {
2647 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2651 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2652 if (ua_chan
== NULL
) {
2653 /* Only malloc can fail here */
2657 shadow_copy_channel(ua_chan
, uchan
);
2659 /* Set channel type. */
2660 ua_chan
->attr
.type
= type
;
2662 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2667 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2670 /* Only add the channel if successful on the tracer side. */
2671 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2675 *ua_chanp
= ua_chan
;
2678 /* Everything went well. */
2682 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2688 * Create UST app event and create it on the tracer side.
2690 * Called with ust app session mutex held.
2693 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2694 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2695 struct ust_app
*app
)
2698 struct ust_app_event
*ua_event
;
2700 /* Get event node */
2701 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2702 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2703 if (ua_event
!= NULL
) {
2708 /* Does not exist so create one */
2709 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2710 if (ua_event
== NULL
) {
2711 /* Only malloc can failed so something is really wrong */
2715 shadow_copy_event(ua_event
, uevent
);
2717 /* Create it on the tracer side */
2718 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2720 /* Not found previously means that it does not exist on the tracer */
2721 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2725 add_unique_ust_app_event(ua_chan
, ua_event
);
2727 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2734 /* Valid. Calling here is already in a read side lock */
2735 delete_ust_app_event(-1, ua_event
);
2740 * Create UST metadata and open it on the tracer side.
2742 * Called with UST app session lock held and RCU read side lock.
2744 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2745 struct ust_app
*app
, struct consumer_output
*consumer
)
2748 struct ust_app_channel
*metadata
;
2749 struct consumer_socket
*socket
;
2750 struct ust_registry_session
*registry
;
2756 registry
= get_session_registry(ua_sess
);
2759 /* Metadata already exists for this registry or it was closed previously */
2760 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2765 /* Allocate UST metadata */
2766 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2768 /* malloc() failed */
2773 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2775 /* Need one fd for the channel. */
2776 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2778 ERR("Exhausted number of available FD upon create metadata");
2782 /* Get the right consumer socket for the application. */
2783 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2786 goto error_consumer
;
2790 * Keep metadata key so we can identify it on the consumer side. Assign it
2791 * to the registry *before* we ask the consumer so we avoid the race of the
2792 * consumer requesting the metadata and the ask_channel call on our side
2793 * did not returned yet.
2795 registry
->metadata_key
= metadata
->key
;
2798 * Ask the metadata channel creation to the consumer. The metadata object
2799 * will be created by the consumer and kept their. However, the stream is
2800 * never added or monitored until we do a first push metadata to the
2803 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2806 /* Nullify the metadata key so we don't try to close it later on. */
2807 registry
->metadata_key
= 0;
2808 goto error_consumer
;
2812 * The setup command will make the metadata stream be sent to the relayd,
2813 * if applicable, and the thread managing the metadatas. This is important
2814 * because after this point, if an error occurs, the only way the stream
2815 * can be deleted is to be monitored in the consumer.
2817 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2819 /* Nullify the metadata key so we don't try to close it later on. */
2820 registry
->metadata_key
= 0;
2821 goto error_consumer
;
2824 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2825 metadata
->key
, app
->pid
);
2828 lttng_fd_put(LTTNG_FD_APPS
, 1);
2829 delete_ust_app_channel(-1, metadata
, app
);
2835 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2836 * acquired before calling this function.
2838 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2840 struct ust_app
*app
= NULL
;
2841 struct lttng_ht_node_ulong
*node
;
2842 struct lttng_ht_iter iter
;
2844 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2845 node
= lttng_ht_iter_get_node_ulong(&iter
);
2847 DBG2("UST app no found with pid %d", pid
);
2851 DBG2("Found UST app by pid %d", pid
);
2853 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2860 * Allocate and init an UST app object using the registration information and
2861 * the command socket. This is called when the command socket connects to the
2864 * The object is returned on success or else NULL.
2866 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2868 struct ust_app
*lta
= NULL
;
2873 DBG3("UST app creating application for socket %d", sock
);
2875 if ((msg
->bits_per_long
== 64 &&
2876 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2877 || (msg
->bits_per_long
== 32 &&
2878 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2879 ERR("Registration failed: application \"%s\" (pid: %d) has "
2880 "%d-bit long, but no consumerd for this size is available.\n",
2881 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2885 lta
= zmalloc(sizeof(struct ust_app
));
2891 lta
->ppid
= msg
->ppid
;
2892 lta
->uid
= msg
->uid
;
2893 lta
->gid
= msg
->gid
;
2895 lta
->bits_per_long
= msg
->bits_per_long
;
2896 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2897 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2898 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2899 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2900 lta
->long_alignment
= msg
->long_alignment
;
2901 lta
->byte_order
= msg
->byte_order
;
2903 lta
->v_major
= msg
->major
;
2904 lta
->v_minor
= msg
->minor
;
2905 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2906 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2907 lta
->notify_sock
= -1;
2909 /* Copy name and make sure it's NULL terminated. */
2910 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2911 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2914 * Before this can be called, when receiving the registration information,
2915 * the application compatibility is checked. So, at this point, the
2916 * application can work with this session daemon.
2918 lta
->compatible
= 1;
2920 lta
->pid
= msg
->pid
;
2921 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2923 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2925 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2932 * For a given application object, add it to every hash table.
2934 void ust_app_add(struct ust_app
*app
)
2937 assert(app
->notify_sock
>= 0);
2942 * On a re-registration, we want to kick out the previous registration of
2945 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2948 * The socket _should_ be unique until _we_ call close. So, a add_unique
2949 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2950 * already in the table.
2952 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2954 /* Add application to the notify socket hash table. */
2955 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2956 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2958 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2959 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2960 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2967 * Set the application version into the object.
2969 * Return 0 on success else a negative value either an errno code or a
2970 * LTTng-UST error code.
2972 int ust_app_version(struct ust_app
*app
)
2978 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2980 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2981 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2983 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2991 * Unregister app by removing it from the global traceable app list and freeing
2994 * The socket is already closed at this point so no close to sock.
2996 void ust_app_unregister(int sock
)
2998 struct ust_app
*lta
;
2999 struct lttng_ht_node_ulong
*node
;
3000 struct lttng_ht_iter iter
;
3001 struct ust_app_session
*ua_sess
;
3006 /* Get the node reference for a call_rcu */
3007 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
3008 node
= lttng_ht_iter_get_node_ulong(&iter
);
3011 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3012 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3014 /* Remove application from PID hash table */
3015 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3019 * Remove application from notify hash table. The thread handling the
3020 * notify socket could have deleted the node so ignore on error because
3021 * either way it's valid. The close of that socket is handled by the other
3024 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3025 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3028 * Ignore return value since the node might have been removed before by an
3029 * add replace during app registration because the PID can be reassigned by
3032 iter
.iter
.node
= <a
->pid_n
.node
;
3033 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3035 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3039 /* Remove sessions so they are not visible during deletion.*/
3040 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3042 struct ust_registry_session
*registry
;
3044 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3046 /* The session was already removed so scheduled for teardown. */
3051 * Add session to list for teardown. This is safe since at this point we
3052 * are the only one using this list.
3054 pthread_mutex_lock(&ua_sess
->lock
);
3057 * Normally, this is done in the delete session process which is
3058 * executed in the call rcu below. However, upon registration we can't
3059 * afford to wait for the grace period before pushing data or else the
3060 * data pending feature can race between the unregistration and stop
3061 * command where the data pending command is sent *before* the grace
3064 * The close metadata below nullifies the metadata pointer in the
3065 * session so the delete session will NOT push/close a second time.
3067 registry
= get_session_registry(ua_sess
);
3068 if (registry
&& !registry
->metadata_closed
) {
3069 /* Push metadata for application before freeing the application. */
3070 (void) push_metadata(registry
, ua_sess
->consumer
);
3073 * Don't ask to close metadata for global per UID buffers. Close
3074 * metadata only on destroy trace session in this case. Also, the
3075 * previous push metadata could have flag the metadata registry to
3076 * close so don't send a close command if closed.
3078 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3079 !registry
->metadata_closed
) {
3080 /* And ask to close it for this session registry. */
3081 (void) close_metadata(registry
, ua_sess
->consumer
);
3085 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3086 pthread_mutex_unlock(&ua_sess
->lock
);
3090 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3097 * Fill events array with all events name of all registered apps.
3099 int ust_app_list_events(struct lttng_event
**events
)
3102 size_t nbmem
, count
= 0;
3103 struct lttng_ht_iter iter
;
3104 struct ust_app
*app
;
3105 struct lttng_event
*tmp_event
;
3107 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3108 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3109 if (tmp_event
== NULL
) {
3110 PERROR("zmalloc ust app events");
3117 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3118 struct lttng_ust_tracepoint_iter uiter
;
3120 health_code_update();
3122 if (!app
->compatible
) {
3124 * TODO: In time, we should notice the caller of this error by
3125 * telling him that this is a version error.
3129 handle
= ustctl_tracepoint_list(app
->sock
);
3131 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3132 ERR("UST app list events getting handle failed for app pid %d",
3138 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3139 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3140 /* Handle ustctl error. */
3142 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3143 ERR("UST app tp list get failed for app %d with ret %d",
3146 DBG3("UST app tp list get failed. Application is dead");
3148 * This is normal behavior, an application can die during the
3149 * creation process. Don't report an error so the execution can
3150 * continue normally. Continue normal execution.
3158 health_code_update();
3159 if (count
>= nbmem
) {
3160 /* In case the realloc fails, we free the memory */
3161 struct lttng_event
*new_tmp_event
;
3164 new_nbmem
= nbmem
<< 1;
3165 DBG2("Reallocating event list from %zu to %zu entries",
3167 new_tmp_event
= realloc(tmp_event
,
3168 new_nbmem
* sizeof(struct lttng_event
));
3169 if (new_tmp_event
== NULL
) {
3170 PERROR("realloc ust app events");
3175 /* Zero the new memory */
3176 memset(new_tmp_event
+ nbmem
, 0,
3177 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3179 tmp_event
= new_tmp_event
;
3181 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3182 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3183 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3184 tmp_event
[count
].pid
= app
->pid
;
3185 tmp_event
[count
].enabled
= -1;
3191 *events
= tmp_event
;
3193 DBG2("UST app list events done (%zu events)", count
);
3198 health_code_update();
3203 * Fill events array with all events name of all registered apps.
3205 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3208 size_t nbmem
, count
= 0;
3209 struct lttng_ht_iter iter
;
3210 struct ust_app
*app
;
3211 struct lttng_event_field
*tmp_event
;
3213 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3214 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3215 if (tmp_event
== NULL
) {
3216 PERROR("zmalloc ust app event fields");
3223 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3224 struct lttng_ust_field_iter uiter
;
3226 health_code_update();
3228 if (!app
->compatible
) {
3230 * TODO: In time, we should notice the caller of this error by
3231 * telling him that this is a version error.
3235 handle
= ustctl_tracepoint_field_list(app
->sock
);
3237 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3238 ERR("UST app list field getting handle failed for app pid %d",
3244 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3245 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3246 /* Handle ustctl error. */
3248 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3249 ERR("UST app tp list field failed for app %d with ret %d",
3252 DBG3("UST app tp list field failed. Application is dead");
3254 * This is normal behavior, an application can die during the
3255 * creation process. Don't report an error so the execution can
3256 * continue normally. Reset list and count for next app.
3264 health_code_update();
3265 if (count
>= nbmem
) {
3266 /* In case the realloc fails, we free the memory */
3267 struct lttng_event_field
*new_tmp_event
;
3270 new_nbmem
= nbmem
<< 1;
3271 DBG2("Reallocating event field list from %zu to %zu entries",
3273 new_tmp_event
= realloc(tmp_event
,
3274 new_nbmem
* sizeof(struct lttng_event_field
));
3275 if (new_tmp_event
== NULL
) {
3276 PERROR("realloc ust app event fields");
3281 /* Zero the new memory */
3282 memset(new_tmp_event
+ nbmem
, 0,
3283 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3285 tmp_event
= new_tmp_event
;
3288 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3289 /* Mapping between these enums matches 1 to 1. */
3290 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3291 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3293 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3294 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3295 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3296 tmp_event
[count
].event
.pid
= app
->pid
;
3297 tmp_event
[count
].event
.enabled
= -1;
3303 *fields
= tmp_event
;
3305 DBG2("UST app list event fields done (%zu events)", count
);
3310 health_code_update();
3315 * Free and clean all traceable apps of the global list.
3317 * Should _NOT_ be called with RCU read-side lock held.
3319 void ust_app_clean_list(void)
3322 struct ust_app
*app
;
3323 struct lttng_ht_iter iter
;
3325 DBG2("UST app cleaning registered apps hash table");
3329 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3330 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3332 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3335 /* Cleanup socket hash table */
3336 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3338 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3342 /* Cleanup notify socket hash table */
3343 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3344 notify_sock_n
.node
) {
3345 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3350 /* Destroy is done only when the ht is empty */
3351 ht_cleanup_push(ust_app_ht
);
3352 ht_cleanup_push(ust_app_ht_by_sock
);
3353 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3357 * Init UST app hash table.
3359 void ust_app_ht_alloc(void)
3361 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3362 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3363 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3367 * For a specific UST session, disable the channel for all registered apps.
3369 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3370 struct ltt_ust_channel
*uchan
)
3373 struct lttng_ht_iter iter
;
3374 struct lttng_ht_node_str
*ua_chan_node
;
3375 struct ust_app
*app
;
3376 struct ust_app_session
*ua_sess
;
3377 struct ust_app_channel
*ua_chan
;
3379 if (usess
== NULL
|| uchan
== NULL
) {
3380 ERR("Disabling UST global channel with NULL values");
3385 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3386 uchan
->name
, usess
->id
);
3390 /* For every registered applications */
3391 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3392 struct lttng_ht_iter uiter
;
3393 if (!app
->compatible
) {
3395 * TODO: In time, we should notice the caller of this error by
3396 * telling him that this is a version error.
3400 ua_sess
= lookup_session_by_app(usess
, app
);
3401 if (ua_sess
== NULL
) {
3406 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3407 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3408 /* If the session if found for the app, the channel must be there */
3409 assert(ua_chan_node
);
3411 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3412 /* The channel must not be already disabled */
3413 assert(ua_chan
->enabled
== 1);
3415 /* Disable channel onto application */
3416 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3418 /* XXX: We might want to report this error at some point... */
3430 * For a specific UST session, enable the channel for all registered apps.
3432 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3433 struct ltt_ust_channel
*uchan
)
3436 struct lttng_ht_iter iter
;
3437 struct ust_app
*app
;
3438 struct ust_app_session
*ua_sess
;
3440 if (usess
== NULL
|| uchan
== NULL
) {
3441 ERR("Adding UST global channel to NULL values");
3446 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3447 uchan
->name
, usess
->id
);
3451 /* For every registered applications */
3452 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3453 if (!app
->compatible
) {
3455 * TODO: In time, we should notice the caller of this error by
3456 * telling him that this is a version error.
3460 ua_sess
= lookup_session_by_app(usess
, app
);
3461 if (ua_sess
== NULL
) {
3465 /* Enable channel onto application */
3466 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3468 /* XXX: We might want to report this error at some point... */
3480 * Disable an event in a channel and for a specific session.
3482 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3483 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3486 struct lttng_ht_iter iter
, uiter
;
3487 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3488 struct ust_app
*app
;
3489 struct ust_app_session
*ua_sess
;
3490 struct ust_app_channel
*ua_chan
;
3491 struct ust_app_event
*ua_event
;
3493 DBG("UST app disabling event %s for all apps in channel "
3494 "%s for session id %" PRIu64
,
3495 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3499 /* For all registered applications */
3500 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3501 if (!app
->compatible
) {
3503 * TODO: In time, we should notice the caller of this error by
3504 * telling him that this is a version error.
3508 ua_sess
= lookup_session_by_app(usess
, app
);
3509 if (ua_sess
== NULL
) {
3514 /* Lookup channel in the ust app session */
3515 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3516 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3517 if (ua_chan_node
== NULL
) {
3518 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3519 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3522 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3524 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3525 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3526 if (ua_event_node
== NULL
) {
3527 DBG2("Event %s not found in channel %s for app pid %d."
3528 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3531 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3533 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3535 /* XXX: Report error someday... */
3546 * For a specific UST session, create the channel for all registered apps.
3548 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3549 struct ltt_ust_channel
*uchan
)
3551 int ret
= 0, created
;
3552 struct lttng_ht_iter iter
;
3553 struct ust_app
*app
;
3554 struct ust_app_session
*ua_sess
= NULL
;
3556 /* Very wrong code flow */
3560 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3561 uchan
->name
, usess
->id
);
3565 /* For every registered applications */
3566 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3567 if (!app
->compatible
) {
3569 * TODO: In time, we should notice the caller of this error by
3570 * telling him that this is a version error.
3575 * Create session on the tracer side and add it to app session HT. Note
3576 * that if session exist, it will simply return a pointer to the ust
3579 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3584 * The application's socket is not valid. Either a bad socket
3585 * or a timeout on it. We can't inform the caller that for a
3586 * specific app, the session failed so lets continue here.
3591 goto error_rcu_unlock
;
3596 pthread_mutex_lock(&ua_sess
->lock
);
3597 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3598 sizeof(uchan
->name
))) {
3599 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3602 /* Create channel onto application. We don't need the chan ref. */
3603 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3604 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3606 pthread_mutex_unlock(&ua_sess
->lock
);
3608 if (ret
== -ENOMEM
) {
3609 /* No more memory is a fatal error. Stop right now. */
3610 goto error_rcu_unlock
;
3612 /* Cleanup the created session if it's the case. */
3614 destroy_app_session(app
, ua_sess
);
3625 * Enable event for a specific session and channel on the tracer.
3627 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3628 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3631 struct lttng_ht_iter iter
, uiter
;
3632 struct lttng_ht_node_str
*ua_chan_node
;
3633 struct ust_app
*app
;
3634 struct ust_app_session
*ua_sess
;
3635 struct ust_app_channel
*ua_chan
;
3636 struct ust_app_event
*ua_event
;
3638 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3639 uevent
->attr
.name
, usess
->id
);
3642 * NOTE: At this point, this function is called only if the session and
3643 * channel passed are already created for all apps. and enabled on the
3649 /* For all registered applications */
3650 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3651 if (!app
->compatible
) {
3653 * TODO: In time, we should notice the caller of this error by
3654 * telling him that this is a version error.
3658 ua_sess
= lookup_session_by_app(usess
, app
);
3660 /* The application has problem or is probably dead. */
3664 pthread_mutex_lock(&ua_sess
->lock
);
3666 /* Lookup channel in the ust app session */
3667 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3668 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3669 /* If the channel is not found, there is a code flow error */
3670 assert(ua_chan_node
);
3672 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3674 /* Get event node */
3675 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3676 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3677 if (ua_event
== NULL
) {
3678 DBG3("UST app enable event %s not found for app PID %d."
3679 "Skipping app", uevent
->attr
.name
, app
->pid
);
3683 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3685 pthread_mutex_unlock(&ua_sess
->lock
);
3689 pthread_mutex_unlock(&ua_sess
->lock
);
3698 * For a specific existing UST session and UST channel, creates the event for
3699 * all registered apps.
3701 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3702 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3705 struct lttng_ht_iter iter
, uiter
;
3706 struct lttng_ht_node_str
*ua_chan_node
;
3707 struct ust_app
*app
;
3708 struct ust_app_session
*ua_sess
;
3709 struct ust_app_channel
*ua_chan
;
3711 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3712 uevent
->attr
.name
, usess
->id
);
3716 /* For all registered applications */
3717 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3718 if (!app
->compatible
) {
3720 * TODO: In time, we should notice the caller of this error by
3721 * telling him that this is a version error.
3725 ua_sess
= lookup_session_by_app(usess
, app
);
3727 /* The application has problem or is probably dead. */
3731 pthread_mutex_lock(&ua_sess
->lock
);
3732 /* Lookup channel in the ust app session */
3733 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3734 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3735 /* If the channel is not found, there is a code flow error */
3736 assert(ua_chan_node
);
3738 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3740 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3741 pthread_mutex_unlock(&ua_sess
->lock
);
3743 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3744 /* Possible value at this point: -ENOMEM. If so, we stop! */
3747 DBG2("UST app event %s already exist on app PID %d",
3748 uevent
->attr
.name
, app
->pid
);
3759 * Start tracing for a specific UST session and app.
3762 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3765 struct ust_app_session
*ua_sess
;
3767 DBG("Starting tracing for ust app pid %d", app
->pid
);
3771 if (!app
->compatible
) {
3775 ua_sess
= lookup_session_by_app(usess
, app
);
3776 if (ua_sess
== NULL
) {
3777 /* The session is in teardown process. Ignore and continue. */
3781 pthread_mutex_lock(&ua_sess
->lock
);
3783 /* Upon restart, we skip the setup, already done */
3784 if (ua_sess
->started
) {
3788 /* Create directories if consumer is LOCAL and has a path defined. */
3789 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3790 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3791 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3792 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3794 if (ret
!= -EEXIST
) {
3795 ERR("Trace directory creation error");
3802 * Create the metadata for the application. This returns gracefully if a
3803 * metadata was already set for the session.
3805 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3810 health_code_update();
3813 /* This start the UST tracing */
3814 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3816 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3817 ERR("Error starting tracing for app pid: %d (ret: %d)",
3820 DBG("UST app start session failed. Application is dead.");
3822 * This is normal behavior, an application can die during the
3823 * creation process. Don't report an error so the execution can
3824 * continue normally.
3826 pthread_mutex_unlock(&ua_sess
->lock
);
3832 /* Indicate that the session has been started once */
3833 ua_sess
->started
= 1;
3835 pthread_mutex_unlock(&ua_sess
->lock
);
3837 health_code_update();
3839 /* Quiescent wait after starting trace */
3840 ret
= ustctl_wait_quiescent(app
->sock
);
3841 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3842 ERR("UST app wait quiescent failed for app pid %d ret %d",
3848 health_code_update();
3852 pthread_mutex_unlock(&ua_sess
->lock
);
3854 health_code_update();
3859 * Stop tracing for a specific UST session and app.
3862 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3865 struct ust_app_session
*ua_sess
;
3866 struct ust_registry_session
*registry
;
3868 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3872 if (!app
->compatible
) {
3873 goto end_no_session
;
3876 ua_sess
= lookup_session_by_app(usess
, app
);
3877 if (ua_sess
== NULL
) {
3878 goto end_no_session
;
3881 pthread_mutex_lock(&ua_sess
->lock
);
3884 * If started = 0, it means that stop trace has been called for a session
3885 * that was never started. It's possible since we can have a fail start
3886 * from either the application manager thread or the command thread. Simply
3887 * indicate that this is a stop error.
3889 if (!ua_sess
->started
) {
3890 goto error_rcu_unlock
;
3893 health_code_update();
3895 /* This inhibits UST tracing */
3896 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3898 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3899 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3902 DBG("UST app stop session failed. Application is dead.");
3904 * This is normal behavior, an application can die during the
3905 * creation process. Don't report an error so the execution can
3906 * continue normally.
3910 goto error_rcu_unlock
;
3913 health_code_update();
3915 /* Quiescent wait after stopping trace */
3916 ret
= ustctl_wait_quiescent(app
->sock
);
3917 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3918 ERR("UST app wait quiescent failed for app pid %d ret %d",
3922 health_code_update();
3924 registry
= get_session_registry(ua_sess
);
3927 if (!registry
->metadata_closed
) {
3928 /* Push metadata for application before freeing the application. */
3929 (void) push_metadata(registry
, ua_sess
->consumer
);
3933 pthread_mutex_unlock(&ua_sess
->lock
);
3936 health_code_update();
3940 pthread_mutex_unlock(&ua_sess
->lock
);
3942 health_code_update();
3947 * Flush buffers for a specific UST session and app.
3950 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3953 struct lttng_ht_iter iter
;
3954 struct ust_app_session
*ua_sess
;
3955 struct ust_app_channel
*ua_chan
;
3957 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3961 if (!app
->compatible
) {
3962 goto end_no_session
;
3965 ua_sess
= lookup_session_by_app(usess
, app
);
3966 if (ua_sess
== NULL
) {
3967 goto end_no_session
;
3970 pthread_mutex_lock(&ua_sess
->lock
);
3972 health_code_update();
3974 /* Flushing buffers */
3975 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3977 health_code_update();
3978 assert(ua_chan
->is_sent
);
3979 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3981 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3982 ERR("UST app PID %d channel %s flush failed with ret %d",
3983 app
->pid
, ua_chan
->name
, ret
);
3985 DBG3("UST app failed to flush %s. Application is dead.",
3988 * This is normal behavior, an application can die during the
3989 * creation process. Don't report an error so the execution can
3990 * continue normally.
3993 /* Continuing flushing all buffers */
3998 health_code_update();
4000 pthread_mutex_unlock(&ua_sess
->lock
);
4003 health_code_update();
4008 * Destroy a specific UST session in apps.
4010 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4013 struct ust_app_session
*ua_sess
;
4014 struct lttng_ht_iter iter
;
4015 struct lttng_ht_node_u64
*node
;
4017 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4021 if (!app
->compatible
) {
4025 __lookup_session_by_app(usess
, app
, &iter
);
4026 node
= lttng_ht_iter_get_node_u64(&iter
);
4028 /* Session is being or is deleted. */
4031 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4033 health_code_update();
4034 destroy_app_session(app
, ua_sess
);
4036 health_code_update();
4038 /* Quiescent wait after stopping trace */
4039 ret
= ustctl_wait_quiescent(app
->sock
);
4040 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4041 ERR("UST app wait quiescent failed for app pid %d ret %d",
4046 health_code_update();
4051 * Start tracing for the UST session.
4053 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4056 struct lttng_ht_iter iter
;
4057 struct ust_app
*app
;
4059 DBG("Starting all UST traces");
4063 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4064 ret
= ust_app_start_trace(usess
, app
);
4066 /* Continue to next apps even on error */
4077 * Start tracing for the UST session.
4079 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4082 struct lttng_ht_iter iter
;
4083 struct ust_app
*app
;
4085 DBG("Stopping all UST traces");
4089 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4090 ret
= ust_app_stop_trace(usess
, app
);
4092 /* Continue to next apps even on error */
4097 /* Flush buffers and push metadata (for UID buffers). */
4098 switch (usess
->buffer_type
) {
4099 case LTTNG_BUFFER_PER_UID
:
4101 struct buffer_reg_uid
*reg
;
4103 /* Flush all per UID buffers associated to that session. */
4104 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4105 struct ust_registry_session
*ust_session_reg
;
4106 struct buffer_reg_channel
*reg_chan
;
4107 struct consumer_socket
*socket
;
4109 /* Get consumer socket to use to push the metadata.*/
4110 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4113 /* Ignore request if no consumer is found for the session. */
4117 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4118 reg_chan
, node
.node
) {
4120 * The following call will print error values so the return
4121 * code is of little importance because whatever happens, we
4122 * have to try them all.
4124 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4127 ust_session_reg
= reg
->registry
->reg
.ust
;
4128 if (!ust_session_reg
->metadata_closed
) {
4129 /* Push metadata. */
4130 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4136 case LTTNG_BUFFER_PER_PID
:
4137 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4138 ret
= ust_app_flush_trace(usess
, app
);
4140 /* Continue to next apps even on error */
4156 * Destroy app UST session.
4158 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4161 struct lttng_ht_iter iter
;
4162 struct ust_app
*app
;
4164 DBG("Destroy all UST traces");
4168 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4169 ret
= destroy_trace(usess
, app
);
4171 /* Continue to next apps even on error */
4182 * Add channels/events from UST global domain to registered apps at sock.
4184 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4187 struct lttng_ht_iter iter
, uiter
;
4188 struct ust_app
*app
;
4189 struct ust_app_session
*ua_sess
= NULL
;
4190 struct ust_app_channel
*ua_chan
;
4191 struct ust_app_event
*ua_event
;
4192 struct ust_app_ctx
*ua_ctx
;
4197 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4202 app
= ust_app_find_by_sock(sock
);
4205 * Application can be unregistered before so this is possible hence
4206 * simply stopping the update.
4208 DBG3("UST app update failed to find app sock %d", sock
);
4212 if (!app
->compatible
) {
4216 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4218 /* Tracer is probably gone or ENOMEM. */
4223 pthread_mutex_lock(&ua_sess
->lock
);
4226 * We can iterate safely here over all UST app session since the create ust
4227 * app session above made a shadow copy of the UST global domain from the
4230 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4232 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4235 * Stop everything. On error, the application failed, no more
4236 * file descriptor are available or ENOMEM so stopping here is
4237 * the only thing we can do for now.
4243 * Add context using the list so they are enabled in the same order the
4246 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4247 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4254 /* For each events */
4255 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4257 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4264 pthread_mutex_unlock(&ua_sess
->lock
);
4266 if (usess
->start_trace
) {
4267 ret
= ust_app_start_trace(usess
, app
);
4272 DBG2("UST trace started for app pid %d", app
->pid
);
4275 /* Everything went well at this point. */
4280 pthread_mutex_unlock(&ua_sess
->lock
);
4283 destroy_app_session(app
, ua_sess
);
4290 * Add context to a specific channel for global UST domain.
4292 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4293 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4296 struct lttng_ht_node_str
*ua_chan_node
;
4297 struct lttng_ht_iter iter
, uiter
;
4298 struct ust_app_channel
*ua_chan
= NULL
;
4299 struct ust_app_session
*ua_sess
;
4300 struct ust_app
*app
;
4304 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4305 if (!app
->compatible
) {
4307 * TODO: In time, we should notice the caller of this error by
4308 * telling him that this is a version error.
4312 ua_sess
= lookup_session_by_app(usess
, app
);
4313 if (ua_sess
== NULL
) {
4317 pthread_mutex_lock(&ua_sess
->lock
);
4318 /* Lookup channel in the ust app session */
4319 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4320 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4321 if (ua_chan_node
== NULL
) {
4324 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4326 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4331 pthread_mutex_unlock(&ua_sess
->lock
);
4339 * Enable event for a channel from a UST session for a specific PID.
4341 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4342 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4345 struct lttng_ht_iter iter
;
4346 struct lttng_ht_node_str
*ua_chan_node
;
4347 struct ust_app
*app
;
4348 struct ust_app_session
*ua_sess
;
4349 struct ust_app_channel
*ua_chan
;
4350 struct ust_app_event
*ua_event
;
4352 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4356 app
= ust_app_find_by_pid(pid
);
4358 ERR("UST app enable event per PID %d not found", pid
);
4363 if (!app
->compatible
) {
4368 ua_sess
= lookup_session_by_app(usess
, app
);
4370 /* The application has problem or is probably dead. */
4375 pthread_mutex_lock(&ua_sess
->lock
);
4376 /* Lookup channel in the ust app session */
4377 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4378 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4379 /* If the channel is not found, there is a code flow error */
4380 assert(ua_chan_node
);
4382 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4384 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4385 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4386 if (ua_event
== NULL
) {
4387 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4392 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4399 pthread_mutex_unlock(&ua_sess
->lock
);
4406 * Calibrate registered applications.
4408 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4411 struct lttng_ht_iter iter
;
4412 struct ust_app
*app
;
4416 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4417 if (!app
->compatible
) {
4419 * TODO: In time, we should notice the caller of this error by
4420 * telling him that this is a version error.
4425 health_code_update();
4427 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4431 /* Means that it's not implemented on the tracer side. */
4435 DBG2("Calibrate app PID %d returned with error %d",
4442 DBG("UST app global domain calibration finished");
4446 health_code_update();
4452 * Receive registration and populate the given msg structure.
4454 * On success return 0 else a negative value returned by the ustctl call.
4456 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4459 uint32_t pid
, ppid
, uid
, gid
;
4463 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4464 &pid
, &ppid
, &uid
, &gid
,
4465 &msg
->bits_per_long
,
4466 &msg
->uint8_t_alignment
,
4467 &msg
->uint16_t_alignment
,
4468 &msg
->uint32_t_alignment
,
4469 &msg
->uint64_t_alignment
,
4470 &msg
->long_alignment
,
4477 case LTTNG_UST_ERR_EXITING
:
4478 DBG3("UST app recv reg message failed. Application died");
4480 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4481 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4482 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4483 LTTNG_UST_ABI_MINOR_VERSION
);
4486 ERR("UST app recv reg message failed with ret %d", ret
);
4491 msg
->pid
= (pid_t
) pid
;
4492 msg
->ppid
= (pid_t
) ppid
;
4493 msg
->uid
= (uid_t
) uid
;
4494 msg
->gid
= (gid_t
) gid
;
4501 * Return a ust app channel object using the application object and the channel
4502 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4503 * lock MUST be acquired before calling this function.
4505 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4508 struct lttng_ht_node_ulong
*node
;
4509 struct lttng_ht_iter iter
;
4510 struct ust_app_channel
*ua_chan
= NULL
;
4514 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4515 node
= lttng_ht_iter_get_node_ulong(&iter
);
4517 DBG2("UST app channel find by objd %d not found", objd
);
4521 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4528 * Reply to a register channel notification from an application on the notify
4529 * socket. The channel metadata is also created.
4531 * The session UST registry lock is acquired in this function.
4533 * On success 0 is returned else a negative value.
4535 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4536 size_t nr_fields
, struct ustctl_field
*fields
)
4538 int ret
, ret_code
= 0;
4539 uint32_t chan_id
, reg_count
;
4540 uint64_t chan_reg_key
;
4541 enum ustctl_channel_header type
;
4542 struct ust_app
*app
;
4543 struct ust_app_channel
*ua_chan
;
4544 struct ust_app_session
*ua_sess
;
4545 struct ust_registry_session
*registry
;
4546 struct ust_registry_channel
*chan_reg
;
4550 /* Lookup application. If not found, there is a code flow error. */
4551 app
= find_app_by_notify_sock(sock
);
4553 DBG("Application socket %d is being teardown. Abort event notify",
4557 goto error_rcu_unlock
;
4560 /* Lookup channel by UST object descriptor. */
4561 ua_chan
= find_channel_by_objd(app
, cobjd
);
4563 DBG("Application channel is being teardown. Abort event notify");
4566 goto error_rcu_unlock
;
4569 assert(ua_chan
->session
);
4570 ua_sess
= ua_chan
->session
;
4572 /* Get right session registry depending on the session buffer type. */
4573 registry
= get_session_registry(ua_sess
);
4576 /* Depending on the buffer type, a different channel key is used. */
4577 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4578 chan_reg_key
= ua_chan
->tracing_channel_id
;
4580 chan_reg_key
= ua_chan
->key
;
4583 pthread_mutex_lock(®istry
->lock
);
4585 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4588 if (!chan_reg
->register_done
) {
4589 reg_count
= ust_registry_get_event_count(chan_reg
);
4590 if (reg_count
< 31) {
4591 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4593 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4596 chan_reg
->nr_ctx_fields
= nr_fields
;
4597 chan_reg
->ctx_fields
= fields
;
4598 chan_reg
->header_type
= type
;
4600 /* Get current already assigned values. */
4601 type
= chan_reg
->header_type
;
4603 /* Set to NULL so the error path does not do a double free. */
4606 /* Channel id is set during the object creation. */
4607 chan_id
= chan_reg
->chan_id
;
4609 /* Append to metadata */
4610 if (!chan_reg
->metadata_dumped
) {
4611 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4613 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4619 DBG3("UST app replying to register channel key %" PRIu64
4620 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4623 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4625 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4626 ERR("UST app reply channel failed with ret %d", ret
);
4628 DBG3("UST app reply channel failed. Application died");
4633 /* This channel registry registration is completed. */
4634 chan_reg
->register_done
= 1;
4637 pthread_mutex_unlock(®istry
->lock
);
4647 * Add event to the UST channel registry. When the event is added to the
4648 * registry, the metadata is also created. Once done, this replies to the
4649 * application with the appropriate error code.
4651 * The session UST registry lock is acquired in the function.
4653 * On success 0 is returned else a negative value.
4655 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4656 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4657 char *model_emf_uri
)
4660 uint32_t event_id
= 0;
4661 uint64_t chan_reg_key
;
4662 struct ust_app
*app
;
4663 struct ust_app_channel
*ua_chan
;
4664 struct ust_app_session
*ua_sess
;
4665 struct ust_registry_session
*registry
;
4669 /* Lookup application. If not found, there is a code flow error. */
4670 app
= find_app_by_notify_sock(sock
);
4672 DBG("Application socket %d is being teardown. Abort event notify",
4677 free(model_emf_uri
);
4678 goto error_rcu_unlock
;
4681 /* Lookup channel by UST object descriptor. */
4682 ua_chan
= find_channel_by_objd(app
, cobjd
);
4684 DBG("Application channel is being teardown. Abort event notify");
4688 free(model_emf_uri
);
4689 goto error_rcu_unlock
;
4692 assert(ua_chan
->session
);
4693 ua_sess
= ua_chan
->session
;
4695 registry
= get_session_registry(ua_sess
);
4698 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4699 chan_reg_key
= ua_chan
->tracing_channel_id
;
4701 chan_reg_key
= ua_chan
->key
;
4704 pthread_mutex_lock(®istry
->lock
);
4707 * From this point on, this call acquires the ownership of the sig, fields
4708 * and model_emf_uri meaning any free are done inside it if needed. These
4709 * three variables MUST NOT be read/write after this.
4711 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4712 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4713 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4717 * The return value is returned to ustctl so in case of an error, the
4718 * application can be notified. In case of an error, it's important not to
4719 * return a negative error or else the application will get closed.
4721 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4723 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4724 ERR("UST app reply event failed with ret %d", ret
);
4726 DBG3("UST app reply event failed. Application died");
4729 * No need to wipe the create event since the application socket will
4730 * get close on error hence cleaning up everything by itself.
4735 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4739 pthread_mutex_unlock(®istry
->lock
);
4746 * Handle application notification through the given notify socket.
4748 * Return 0 on success or else a negative value.
4750 int ust_app_recv_notify(int sock
)
4753 enum ustctl_notify_cmd cmd
;
4755 DBG3("UST app receiving notify from sock %d", sock
);
4757 ret
= ustctl_recv_notify(sock
, &cmd
);
4759 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4760 ERR("UST app recv notify failed with ret %d", ret
);
4762 DBG3("UST app recv notify failed. Application died");
4768 case USTCTL_NOTIFY_CMD_EVENT
:
4770 int sobjd
, cobjd
, loglevel
;
4771 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4773 struct ustctl_field
*fields
;
4775 DBG2("UST app ustctl register event received");
4777 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4778 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4780 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4781 ERR("UST app recv event failed with ret %d", ret
);
4783 DBG3("UST app recv event failed. Application died");
4789 * Add event to the UST registry coming from the notify socket. This
4790 * call will free if needed the sig, fields and model_emf_uri. This
4791 * code path loses the ownsership of these variables and transfer them
4792 * to the this function.
4794 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4795 fields
, loglevel
, model_emf_uri
);
4802 case USTCTL_NOTIFY_CMD_CHANNEL
:
4806 struct ustctl_field
*fields
;
4808 DBG2("UST app ustctl register channel received");
4810 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4813 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4814 ERR("UST app recv channel failed with ret %d", ret
);
4816 DBG3("UST app recv channel failed. Application died");
4822 * The fields ownership are transfered to this function call meaning
4823 * that if needed it will be freed. After this, it's invalid to access
4824 * fields or clean it up.
4826 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4835 /* Should NEVER happen. */
4844 * Once the notify socket hangs up, this is called. First, it tries to find the
4845 * corresponding application. On failure, the call_rcu to close the socket is
4846 * executed. If an application is found, it tries to delete it from the notify
4847 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4849 * Note that an object needs to be allocated here so on ENOMEM failure, the
4850 * call RCU is not done but the rest of the cleanup is.
4852 void ust_app_notify_sock_unregister(int sock
)
4855 struct lttng_ht_iter iter
;
4856 struct ust_app
*app
;
4857 struct ust_app_notify_sock_obj
*obj
;
4863 obj
= zmalloc(sizeof(*obj
));
4866 * An ENOMEM is kind of uncool. If this strikes we continue the
4867 * procedure but the call_rcu will not be called. In this case, we
4868 * accept the fd leak rather than possibly creating an unsynchronized
4869 * state between threads.
4871 * TODO: The notify object should be created once the notify socket is
4872 * registered and stored independantely from the ust app object. The
4873 * tricky part is to synchronize the teardown of the application and
4874 * this notify object. Let's keep that in mind so we can avoid this
4875 * kind of shenanigans with ENOMEM in the teardown path.
4882 DBG("UST app notify socket unregister %d", sock
);
4885 * Lookup application by notify socket. If this fails, this means that the
4886 * hash table delete has already been done by the application
4887 * unregistration process so we can safely close the notify socket in a
4890 app
= find_app_by_notify_sock(sock
);
4895 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4898 * Whatever happens here either we fail or succeed, in both cases we have
4899 * to close the socket after a grace period to continue to the call RCU
4900 * here. If the deletion is successful, the application is not visible
4901 * anymore by other threads and is it fails it means that it was already
4902 * deleted from the hash table so either way we just have to close the
4905 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4911 * Close socket after a grace period to avoid for the socket to be reused
4912 * before the application object is freed creating potential race between
4913 * threads trying to add unique in the global hash table.
4916 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4921 * Destroy a ust app data structure and free its memory.
4923 void ust_app_destroy(struct ust_app
*app
)
4929 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4933 * Take a snapshot for a given UST session. The snapshot is sent to the given
4936 * Return 0 on success or else a negative value.
4938 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4939 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4942 unsigned int snapshot_done
= 0;
4943 struct lttng_ht_iter iter
;
4944 struct ust_app
*app
;
4945 char pathname
[PATH_MAX
];
4946 uint64_t max_stream_size
= 0;
4954 * Compute the maximum size of a single stream if a max size is asked by
4957 if (output
->max_size
> 0 && nb_streams
> 0) {
4958 max_stream_size
= output
->max_size
/ nb_streams
;
4961 switch (usess
->buffer_type
) {
4962 case LTTNG_BUFFER_PER_UID
:
4964 struct buffer_reg_uid
*reg
;
4966 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4967 struct buffer_reg_channel
*reg_chan
;
4968 struct consumer_socket
*socket
;
4970 /* Get consumer socket to use to push the metadata.*/
4971 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4978 memset(pathname
, 0, sizeof(pathname
));
4979 ret
= snprintf(pathname
, sizeof(pathname
),
4980 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
4981 reg
->uid
, reg
->bits_per_long
);
4983 PERROR("snprintf snapshot path");
4987 /* Add the UST default trace dir to path. */
4988 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4989 reg_chan
, node
.node
) {
4992 * Make sure the maximum stream size is not lower than the
4993 * subbuffer size or else it's an error since we won't be able to
4994 * snapshot anything.
4996 if (max_stream_size
&&
4997 reg_chan
->subbuf_size
> max_stream_size
) {
4999 DBG3("UST app snapshot record maximum stream size %" PRIu64
5000 " is smaller than subbuffer size of %zu",
5001 max_stream_size
, reg_chan
->subbuf_size
);
5004 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
5005 usess
->uid
, usess
->gid
, pathname
, wait
,
5011 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5012 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5021 case LTTNG_BUFFER_PER_PID
:
5023 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5024 struct consumer_socket
*socket
;
5025 struct lttng_ht_iter chan_iter
;
5026 struct ust_app_channel
*ua_chan
;
5027 struct ust_app_session
*ua_sess
;
5028 struct ust_registry_session
*registry
;
5030 ua_sess
= lookup_session_by_app(usess
, app
);
5032 /* Session not associated with this app. */
5036 /* Get the right consumer socket for the application. */
5037 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5044 /* Add the UST default trace dir to path. */
5045 memset(pathname
, 0, sizeof(pathname
));
5046 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5049 PERROR("snprintf snapshot path");
5053 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5054 ua_chan
, node
.node
) {
5056 * Make sure the maximum stream size is not lower than the
5057 * subbuffer size or else it's an error since we won't be able to
5058 * snapshot anything.
5060 if (max_stream_size
&&
5061 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5063 DBG3("UST app snapshot record maximum stream size %" PRIu64
5064 " is smaller than subbuffer size of %" PRIu64
,
5065 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5069 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5070 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5077 registry
= get_session_registry(ua_sess
);
5079 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5080 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5094 if (!snapshot_done
) {
5096 * If no snapshot was made and we are not in the error path, this means
5097 * that there are no buffers thus no (prior) application to snapshot
5098 * data from so we have simply NO data.
5109 * Return the number of streams for a UST session.
5111 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5113 unsigned int ret
= 0;
5114 struct ust_app
*app
;
5115 struct lttng_ht_iter iter
;
5119 switch (usess
->buffer_type
) {
5120 case LTTNG_BUFFER_PER_UID
:
5122 struct buffer_reg_uid
*reg
;
5124 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5125 struct buffer_reg_channel
*reg_chan
;
5127 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5128 reg_chan
, node
.node
) {
5129 ret
+= reg_chan
->stream_count
;
5134 case LTTNG_BUFFER_PER_PID
:
5137 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5138 struct ust_app_channel
*ua_chan
;
5139 struct ust_app_session
*ua_sess
;
5140 struct lttng_ht_iter chan_iter
;
5142 ua_sess
= lookup_session_by_app(usess
, app
);
5144 /* Session not associated with this app. */
5148 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5149 ua_chan
, node
.node
) {
5150 ret
+= ua_chan
->streams
.count
;