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 pthread_mutex_init(&ua_sess
->lock
, NULL
);
837 * Alloc new UST app channel.
840 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
841 struct ust_app_session
*ua_sess
,
842 struct lttng_ust_channel_attr
*attr
)
844 struct ust_app_channel
*ua_chan
;
846 /* Init most of the default value by allocating and zeroing */
847 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
848 if (ua_chan
== NULL
) {
853 /* Setup channel name */
854 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
855 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
857 ua_chan
->enabled
= 1;
858 ua_chan
->handle
= -1;
859 ua_chan
->session
= ua_sess
;
860 ua_chan
->key
= get_next_channel_key();
861 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
862 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
863 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
865 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
866 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
868 /* Copy attributes */
870 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
871 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
872 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
873 ua_chan
->attr
.overwrite
= attr
->overwrite
;
874 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
875 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
876 ua_chan
->attr
.output
= attr
->output
;
878 /* By default, the channel is a per cpu channel. */
879 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
881 DBG3("UST app channel %s allocated", ua_chan
->name
);
890 * Allocate and initialize a UST app stream.
892 * Return newly allocated stream pointer or NULL on error.
894 struct ust_app_stream
*ust_app_alloc_stream(void)
896 struct ust_app_stream
*stream
= NULL
;
898 stream
= zmalloc(sizeof(*stream
));
899 if (stream
== NULL
) {
900 PERROR("zmalloc ust app stream");
904 /* Zero could be a valid value for a handle so flag it to -1. */
912 * Alloc new UST app event.
915 struct ust_app_event
*alloc_ust_app_event(char *name
,
916 struct lttng_ust_event
*attr
)
918 struct ust_app_event
*ua_event
;
920 /* Init most of the default value by allocating and zeroing */
921 ua_event
= zmalloc(sizeof(struct ust_app_event
));
922 if (ua_event
== NULL
) {
927 ua_event
->enabled
= 1;
928 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
929 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
930 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
932 /* Copy attributes */
934 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
937 DBG3("UST app event %s allocated", ua_event
->name
);
946 * Alloc new UST app context.
949 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
951 struct ust_app_ctx
*ua_ctx
;
953 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
954 if (ua_ctx
== NULL
) {
958 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
961 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
964 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
971 * Allocate a filter and copy the given original filter.
973 * Return allocated filter or NULL on error.
975 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
976 struct lttng_ust_filter_bytecode
*orig_f
)
978 struct lttng_ust_filter_bytecode
*filter
= NULL
;
980 /* Copy filter bytecode */
981 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
983 PERROR("zmalloc alloc ust app filter");
987 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
994 * Find an ust_app using the sock and return it. RCU read side lock must be
995 * held before calling this helper function.
997 struct ust_app
*ust_app_find_by_sock(int sock
)
999 struct lttng_ht_node_ulong
*node
;
1000 struct lttng_ht_iter iter
;
1002 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1003 node
= lttng_ht_iter_get_node_ulong(&iter
);
1005 DBG2("UST app find by sock %d not found", sock
);
1009 return caa_container_of(node
, struct ust_app
, sock_n
);
1016 * Find an ust_app using the notify sock and return it. RCU read side lock must
1017 * be held before calling this helper function.
1019 static struct ust_app
*find_app_by_notify_sock(int sock
)
1021 struct lttng_ht_node_ulong
*node
;
1022 struct lttng_ht_iter iter
;
1024 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1026 node
= lttng_ht_iter_get_node_ulong(&iter
);
1028 DBG2("UST app find by notify sock %d not found", sock
);
1032 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1039 * Lookup for an ust app event based on event name, filter bytecode and the
1042 * Return an ust_app_event object or NULL on error.
1044 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1045 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1046 const struct lttng_event_exclusion
*exclusion
)
1048 struct lttng_ht_iter iter
;
1049 struct lttng_ht_node_str
*node
;
1050 struct ust_app_event
*event
= NULL
;
1051 struct ust_app_ht_key key
;
1056 /* Setup key for event lookup. */
1058 key
.filter
= filter
;
1059 key
.loglevel
= loglevel
;
1060 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1061 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1063 /* Lookup using the event name as hash and a custom match fct. */
1064 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1065 ht_match_ust_app_event
, &key
, &iter
.iter
);
1066 node
= lttng_ht_iter_get_node_str(&iter
);
1071 event
= caa_container_of(node
, struct ust_app_event
, node
);
1078 * Create the channel context on the tracer.
1080 * Called with UST app session lock held.
1083 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1084 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1088 health_code_update();
1090 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1091 ua_chan
->obj
, &ua_ctx
->obj
);
1093 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1094 ERR("UST app create channel context failed for app (pid: %d) "
1095 "with ret %d", app
->pid
, ret
);
1098 * This is normal behavior, an application can die during the
1099 * creation process. Don't report an error so the execution can
1100 * continue normally.
1103 DBG3("UST app disable event failed. Application is dead.");
1108 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1110 DBG2("UST app context handle %d created successfully for channel %s",
1111 ua_ctx
->handle
, ua_chan
->name
);
1114 health_code_update();
1119 * Set the filter on the tracer.
1122 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1123 struct ust_app
*app
)
1127 health_code_update();
1129 if (!ua_event
->filter
) {
1134 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1137 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1138 ERR("UST app event %s filter failed for app (pid: %d) "
1139 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1142 * This is normal behavior, an application can die during the
1143 * creation process. Don't report an error so the execution can
1144 * continue normally.
1147 DBG3("UST app filter event failed. Application is dead.");
1152 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1155 health_code_update();
1160 * Set event exclusions on the tracer.
1163 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1164 struct ust_app
*app
)
1168 health_code_update();
1170 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1175 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1178 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1179 ERR("UST app event %s exclusions failed for app (pid: %d) "
1180 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1183 * This is normal behavior, an application can die during the
1184 * creation process. Don't report an error so the execution can
1185 * continue normally.
1188 DBG3("UST app event exclusion failed. Application is dead.");
1193 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1196 health_code_update();
1201 * Disable the specified event on to UST tracer for the UST session.
1203 static int disable_ust_event(struct ust_app
*app
,
1204 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1208 health_code_update();
1210 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1212 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1213 ERR("UST app event %s disable failed for app (pid: %d) "
1214 "and session handle %d with ret %d",
1215 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1218 * This is normal behavior, an application can die during the
1219 * creation process. Don't report an error so the execution can
1220 * continue normally.
1223 DBG3("UST app disable event failed. Application is dead.");
1228 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1229 ua_event
->attr
.name
, app
->pid
);
1232 health_code_update();
1237 * Disable the specified channel on to UST tracer for the UST session.
1239 static int disable_ust_channel(struct ust_app
*app
,
1240 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1244 health_code_update();
1246 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1248 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1249 ERR("UST app channel %s disable failed for app (pid: %d) "
1250 "and session handle %d with ret %d",
1251 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1254 * This is normal behavior, an application can die during the
1255 * creation process. Don't report an error so the execution can
1256 * continue normally.
1259 DBG3("UST app disable channel failed. Application is dead.");
1264 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1265 ua_chan
->name
, app
->pid
);
1268 health_code_update();
1273 * Enable the specified channel on to UST tracer for the UST session.
1275 static int enable_ust_channel(struct ust_app
*app
,
1276 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1280 health_code_update();
1282 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1284 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1285 ERR("UST app channel %s enable failed for app (pid: %d) "
1286 "and session handle %d with ret %d",
1287 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1290 * This is normal behavior, an application can die during the
1291 * creation process. Don't report an error so the execution can
1292 * continue normally.
1295 DBG3("UST app enable channel failed. Application is dead.");
1300 ua_chan
->enabled
= 1;
1302 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1303 ua_chan
->name
, app
->pid
);
1306 health_code_update();
1311 * Enable the specified event on to UST tracer for the UST session.
1313 static int enable_ust_event(struct ust_app
*app
,
1314 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1318 health_code_update();
1320 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1322 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1323 ERR("UST app event %s enable failed for app (pid: %d) "
1324 "and session handle %d with ret %d",
1325 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1328 * This is normal behavior, an application can die during the
1329 * creation process. Don't report an error so the execution can
1330 * continue normally.
1333 DBG3("UST app enable event failed. Application is dead.");
1338 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1339 ua_event
->attr
.name
, app
->pid
);
1342 health_code_update();
1347 * Send channel and stream buffer to application.
1349 * Return 0 on success. On error, a negative value is returned.
1351 static int send_channel_pid_to_ust(struct ust_app
*app
,
1352 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1355 struct ust_app_stream
*stream
, *stmp
;
1361 health_code_update();
1363 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1366 /* Send channel to the application. */
1367 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1372 health_code_update();
1374 /* Send all streams to application. */
1375 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1376 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1380 /* We don't need the stream anymore once sent to the tracer. */
1381 cds_list_del(&stream
->list
);
1382 delete_ust_app_stream(-1, stream
);
1384 /* Flag the channel that it is sent to the application. */
1385 ua_chan
->is_sent
= 1;
1388 health_code_update();
1393 * Create the specified event onto the UST tracer for a UST session.
1395 * Should be called with session mutex held.
1398 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1399 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1403 health_code_update();
1405 /* Create UST event on tracer */
1406 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1409 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1410 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1411 ua_event
->attr
.name
, app
->pid
, ret
);
1414 * This is normal behavior, an application can die during the
1415 * creation process. Don't report an error so the execution can
1416 * continue normally.
1419 DBG3("UST app create event failed. Application is dead.");
1424 ua_event
->handle
= ua_event
->obj
->handle
;
1426 DBG2("UST app event %s created successfully for pid:%d",
1427 ua_event
->attr
.name
, app
->pid
);
1429 health_code_update();
1431 /* Set filter if one is present. */
1432 if (ua_event
->filter
) {
1433 ret
= set_ust_event_filter(ua_event
, app
);
1439 /* Set exclusions for the event */
1440 if (ua_event
->exclusion
) {
1441 ret
= set_ust_event_exclusion(ua_event
, app
);
1447 /* If event not enabled, disable it on the tracer */
1448 if (ua_event
->enabled
== 0) {
1449 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1452 * If we hit an EPERM, something is wrong with our disable call. If
1453 * we get an EEXIST, there is a problem on the tracer side since we
1457 case -LTTNG_UST_ERR_PERM
:
1458 /* Code flow problem */
1460 case -LTTNG_UST_ERR_EXIST
:
1461 /* It's OK for our use case. */
1472 health_code_update();
1477 * Copy data between an UST app event and a LTT event.
1479 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1480 struct ltt_ust_event
*uevent
)
1482 size_t exclusion_alloc_size
;
1484 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1485 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1487 ua_event
->enabled
= uevent
->enabled
;
1489 /* Copy event attributes */
1490 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1492 /* Copy filter bytecode */
1493 if (uevent
->filter
) {
1494 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1495 /* Filter might be NULL here in case of ENONEM. */
1498 /* Copy exclusion data */
1499 if (uevent
->exclusion
) {
1500 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1501 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1502 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1503 if (ua_event
->exclusion
== NULL
) {
1506 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1507 exclusion_alloc_size
);
1513 * Copy data between an UST app channel and a LTT channel.
1515 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1516 struct ltt_ust_channel
*uchan
)
1518 struct lttng_ht_iter iter
;
1519 struct ltt_ust_event
*uevent
;
1520 struct ltt_ust_context
*uctx
;
1521 struct ust_app_event
*ua_event
;
1522 struct ust_app_ctx
*ua_ctx
;
1524 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1526 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1527 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1529 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1530 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1532 /* Copy event attributes since the layout is different. */
1533 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1534 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1535 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1536 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1537 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1538 ua_chan
->attr
.output
= uchan
->attr
.output
;
1540 * Note that the attribute channel type is not set since the channel on the
1541 * tracing registry side does not have this information.
1544 ua_chan
->enabled
= uchan
->enabled
;
1545 ua_chan
->tracing_channel_id
= uchan
->id
;
1547 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1548 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1549 if (ua_ctx
== NULL
) {
1552 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1553 (unsigned long) ua_ctx
->ctx
.ctx
);
1554 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1555 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1558 /* Copy all events from ltt ust channel to ust app channel */
1559 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1560 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1561 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1562 if (ua_event
== NULL
) {
1563 DBG2("UST event %s not found on shadow copy channel",
1565 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1566 if (ua_event
== NULL
) {
1569 shadow_copy_event(ua_event
, uevent
);
1570 add_unique_ust_app_event(ua_chan
, ua_event
);
1574 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1578 * Copy data between a UST app session and a regular LTT session.
1580 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1581 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1583 struct lttng_ht_node_str
*ua_chan_node
;
1584 struct lttng_ht_iter iter
;
1585 struct ltt_ust_channel
*uchan
;
1586 struct ust_app_channel
*ua_chan
;
1588 struct tm
*timeinfo
;
1592 /* Get date and time for unique app path */
1594 timeinfo
= localtime(&rawtime
);
1595 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1597 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1599 ua_sess
->tracing_id
= usess
->id
;
1600 ua_sess
->id
= get_next_session_id();
1601 ua_sess
->uid
= app
->uid
;
1602 ua_sess
->gid
= app
->gid
;
1603 ua_sess
->euid
= usess
->uid
;
1604 ua_sess
->egid
= usess
->gid
;
1605 ua_sess
->buffer_type
= usess
->buffer_type
;
1606 ua_sess
->bits_per_long
= app
->bits_per_long
;
1607 /* There is only one consumer object per session possible. */
1608 ua_sess
->consumer
= usess
->consumer
;
1609 ua_sess
->output_traces
= usess
->output_traces
;
1610 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1612 switch (ua_sess
->buffer_type
) {
1613 case LTTNG_BUFFER_PER_PID
:
1614 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1615 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1618 case LTTNG_BUFFER_PER_UID
:
1619 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1620 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1627 PERROR("asprintf UST shadow copy session");
1632 /* Iterate over all channels in global domain. */
1633 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1635 struct lttng_ht_iter uiter
;
1637 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1638 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1639 if (ua_chan_node
!= NULL
) {
1640 /* Session exist. Contiuing. */
1644 DBG2("Channel %s not found on shadow session copy, creating it",
1646 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1647 if (ua_chan
== NULL
) {
1648 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1651 shadow_copy_channel(ua_chan
, uchan
);
1653 * The concept of metadata channel does not exist on the tracing
1654 * registry side of the session daemon so this can only be a per CPU
1655 * channel and not metadata.
1657 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1659 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1667 * Lookup sesison wrapper.
1670 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1671 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1673 /* Get right UST app session from app */
1674 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1678 * Return ust app session from the app session hashtable using the UST session
1681 static struct ust_app_session
*lookup_session_by_app(
1682 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1684 struct lttng_ht_iter iter
;
1685 struct lttng_ht_node_u64
*node
;
1687 __lookup_session_by_app(usess
, app
, &iter
);
1688 node
= lttng_ht_iter_get_node_u64(&iter
);
1693 return caa_container_of(node
, struct ust_app_session
, node
);
1700 * Setup buffer registry per PID for the given session and application. If none
1701 * is found, a new one is created, added to the global registry and
1702 * initialized. If regp is valid, it's set with the newly created object.
1704 * Return 0 on success or else a negative value.
1706 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1707 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1710 struct buffer_reg_pid
*reg_pid
;
1717 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1720 * This is the create channel path meaning that if there is NO
1721 * registry available, we have to create one for this session.
1723 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1727 buffer_reg_pid_add(reg_pid
);
1732 /* Initialize registry. */
1733 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1734 app
->bits_per_long
, app
->uint8_t_alignment
,
1735 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1736 app
->uint64_t_alignment
, app
->long_alignment
,
1737 app
->byte_order
, app
->version
.major
,
1738 app
->version
.minor
);
1743 DBG3("UST app buffer registry per PID created successfully");
1755 * Setup buffer registry per UID for the given session and application. If none
1756 * is found, a new one is created, added to the global registry and
1757 * initialized. If regp is valid, it's set with the newly created object.
1759 * Return 0 on success or else a negative value.
1761 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1762 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1765 struct buffer_reg_uid
*reg_uid
;
1772 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1775 * This is the create channel path meaning that if there is NO
1776 * registry available, we have to create one for this session.
1778 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1779 LTTNG_DOMAIN_UST
, ®_uid
);
1783 buffer_reg_uid_add(reg_uid
);
1788 /* Initialize registry. */
1789 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1790 app
->bits_per_long
, app
->uint8_t_alignment
,
1791 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1792 app
->uint64_t_alignment
, app
->long_alignment
,
1793 app
->byte_order
, app
->version
.major
,
1794 app
->version
.minor
);
1798 /* Add node to teardown list of the session. */
1799 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1801 DBG3("UST app buffer registry per UID created successfully");
1813 * Create a session on the tracer side for the given app.
1815 * On success, ua_sess_ptr is populated with the session pointer or else left
1816 * untouched. If the session was created, is_created is set to 1. On error,
1817 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1820 * Returns 0 on success or else a negative code which is either -ENOMEM or
1821 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1823 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1824 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1827 int ret
, created
= 0;
1828 struct ust_app_session
*ua_sess
;
1832 assert(ua_sess_ptr
);
1834 health_code_update();
1836 ua_sess
= lookup_session_by_app(usess
, app
);
1837 if (ua_sess
== NULL
) {
1838 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1839 app
->pid
, usess
->id
);
1840 ua_sess
= alloc_ust_app_session(app
);
1841 if (ua_sess
== NULL
) {
1842 /* Only malloc can failed so something is really wrong */
1846 shadow_copy_session(ua_sess
, usess
, app
);
1850 switch (usess
->buffer_type
) {
1851 case LTTNG_BUFFER_PER_PID
:
1852 /* Init local registry. */
1853 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1858 case LTTNG_BUFFER_PER_UID
:
1859 /* Look for a global registry. If none exists, create one. */
1860 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1871 health_code_update();
1873 if (ua_sess
->handle
== -1) {
1874 ret
= ustctl_create_session(app
->sock
);
1876 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1877 ERR("Creating session for app pid %d with ret %d",
1880 DBG("UST app creating session failed. Application is dead");
1882 * This is normal behavior, an application can die during the
1883 * creation process. Don't report an error so the execution can
1884 * continue normally. This will get flagged ENOTCONN and the
1885 * caller will handle it.
1889 delete_ust_app_session(-1, ua_sess
, app
);
1890 if (ret
!= -ENOMEM
) {
1892 * Tracer is probably gone or got an internal error so let's
1893 * behave like it will soon unregister or not usable.
1900 ua_sess
->handle
= ret
;
1902 /* Add ust app session to app's HT */
1903 lttng_ht_node_init_u64(&ua_sess
->node
,
1904 ua_sess
->tracing_id
);
1905 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1907 DBG2("UST app session created successfully with handle %d", ret
);
1910 *ua_sess_ptr
= ua_sess
;
1912 *is_created
= created
;
1915 /* Everything went well. */
1919 health_code_update();
1924 * Create a context for the channel on the tracer.
1926 * Called with UST app session lock held and a RCU read side lock.
1929 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1930 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1931 struct ust_app
*app
)
1934 struct lttng_ht_iter iter
;
1935 struct lttng_ht_node_ulong
*node
;
1936 struct ust_app_ctx
*ua_ctx
;
1938 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1940 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1941 node
= lttng_ht_iter_get_node_ulong(&iter
);
1947 ua_ctx
= alloc_ust_app_ctx(uctx
);
1948 if (ua_ctx
== NULL
) {
1954 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1955 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1956 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1958 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1968 * Enable on the tracer side a ust app event for the session and channel.
1970 * Called with UST app session lock held.
1973 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1974 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1978 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1983 ua_event
->enabled
= 1;
1990 * Disable on the tracer side a ust app event for the session and channel.
1992 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1993 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1997 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2002 ua_event
->enabled
= 0;
2009 * Lookup ust app channel for session and disable it on the tracer side.
2012 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2013 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2017 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2022 ua_chan
->enabled
= 0;
2029 * Lookup ust app channel for session and enable it on the tracer side. This
2030 * MUST be called with a RCU read side lock acquired.
2032 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2033 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2036 struct lttng_ht_iter iter
;
2037 struct lttng_ht_node_str
*ua_chan_node
;
2038 struct ust_app_channel
*ua_chan
;
2040 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2041 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2042 if (ua_chan_node
== NULL
) {
2043 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2044 uchan
->name
, ua_sess
->tracing_id
);
2048 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2050 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2060 * Ask the consumer to create a channel and get it if successful.
2062 * Return 0 on success or else a negative value.
2064 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2065 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2066 int bitness
, struct ust_registry_session
*registry
)
2069 unsigned int nb_fd
= 0;
2070 struct consumer_socket
*socket
;
2078 health_code_update();
2080 /* Get the right consumer socket for the application. */
2081 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2087 health_code_update();
2089 /* Need one fd for the channel. */
2090 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2092 ERR("Exhausted number of available FD upon create channel");
2097 * Ask consumer to create channel. The consumer will return the number of
2098 * stream we have to expect.
2100 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2107 * Compute the number of fd needed before receiving them. It must be 2 per
2108 * stream (2 being the default value here).
2110 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2112 /* Reserve the amount of file descriptor we need. */
2113 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2115 ERR("Exhausted number of available FD upon create channel");
2116 goto error_fd_get_stream
;
2119 health_code_update();
2122 * Now get the channel from the consumer. This call wil populate the stream
2123 * list of that channel and set the ust objects.
2125 if (usess
->consumer
->enabled
) {
2126 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2136 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2137 error_fd_get_stream
:
2139 * Initiate a destroy channel on the consumer since we had an error
2140 * handling it on our side. The return value is of no importance since we
2141 * already have a ret value set by the previous error that we need to
2144 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2146 lttng_fd_put(LTTNG_FD_APPS
, 1);
2148 health_code_update();
2154 * Duplicate the ust data object of the ust app stream and save it in the
2155 * buffer registry stream.
2157 * Return 0 on success or else a negative value.
2159 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2160 struct ust_app_stream
*stream
)
2167 /* Reserve the amount of file descriptor we need. */
2168 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2170 ERR("Exhausted number of available FD upon duplicate stream");
2174 /* Duplicate object for stream once the original is in the registry. */
2175 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2176 reg_stream
->obj
.ust
);
2178 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2179 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2180 lttng_fd_put(LTTNG_FD_APPS
, 2);
2183 stream
->handle
= stream
->obj
->handle
;
2190 * Duplicate the ust data object of the ust app. channel and save it in the
2191 * buffer registry channel.
2193 * Return 0 on success or else a negative value.
2195 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2196 struct ust_app_channel
*ua_chan
)
2203 /* Need two fds for the channel. */
2204 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2206 ERR("Exhausted number of available FD upon duplicate channel");
2210 /* Duplicate object for stream once the original is in the registry. */
2211 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2213 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2214 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2217 ua_chan
->handle
= ua_chan
->obj
->handle
;
2222 lttng_fd_put(LTTNG_FD_APPS
, 1);
2228 * For a given channel buffer registry, setup all streams of the given ust
2229 * application channel.
2231 * Return 0 on success or else a negative value.
2233 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2234 struct ust_app_channel
*ua_chan
)
2237 struct ust_app_stream
*stream
, *stmp
;
2242 DBG2("UST app setup buffer registry stream");
2244 /* Send all streams to application. */
2245 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2246 struct buffer_reg_stream
*reg_stream
;
2248 ret
= buffer_reg_stream_create(®_stream
);
2254 * Keep original pointer and nullify it in the stream so the delete
2255 * stream call does not release the object.
2257 reg_stream
->obj
.ust
= stream
->obj
;
2259 buffer_reg_stream_add(reg_stream
, reg_chan
);
2261 /* We don't need the streams anymore. */
2262 cds_list_del(&stream
->list
);
2263 delete_ust_app_stream(-1, stream
);
2271 * Create a buffer registry channel for the given session registry and
2272 * application channel object. If regp pointer is valid, it's set with the
2273 * created object. Important, the created object is NOT added to the session
2274 * registry hash table.
2276 * Return 0 on success else a negative value.
2278 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2279 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2282 struct buffer_reg_channel
*reg_chan
= NULL
;
2287 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2289 /* Create buffer registry channel. */
2290 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2295 reg_chan
->consumer_key
= ua_chan
->key
;
2296 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2298 /* Create and add a channel registry to session. */
2299 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2300 ua_chan
->tracing_channel_id
);
2304 buffer_reg_channel_add(reg_sess
, reg_chan
);
2313 /* Safe because the registry channel object was not added to any HT. */
2314 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2320 * Setup buffer registry channel for the given session registry and application
2321 * channel object. If regp pointer is valid, it's set with the created object.
2323 * Return 0 on success else a negative value.
2325 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2326 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2333 assert(ua_chan
->obj
);
2335 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2337 /* Setup all streams for the registry. */
2338 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2343 reg_chan
->obj
.ust
= ua_chan
->obj
;
2344 ua_chan
->obj
= NULL
;
2349 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2350 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2355 * Send buffer registry channel to the application.
2357 * Return 0 on success else a negative value.
2359 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2360 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2361 struct ust_app_channel
*ua_chan
)
2364 struct buffer_reg_stream
*reg_stream
;
2371 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2373 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2378 /* Send channel to the application. */
2379 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2384 health_code_update();
2386 /* Send all streams to application. */
2387 pthread_mutex_lock(®_chan
->stream_list_lock
);
2388 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2389 struct ust_app_stream stream
;
2391 ret
= duplicate_stream_object(reg_stream
, &stream
);
2393 goto error_stream_unlock
;
2396 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2398 (void) release_ust_app_stream(-1, &stream
);
2399 goto error_stream_unlock
;
2403 * The return value is not important here. This function will output an
2406 (void) release_ust_app_stream(-1, &stream
);
2408 ua_chan
->is_sent
= 1;
2410 error_stream_unlock
:
2411 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2417 * Create and send to the application the created buffers with per UID buffers.
2419 * Return 0 on success else a negative value.
2421 static int create_channel_per_uid(struct ust_app
*app
,
2422 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2423 struct ust_app_channel
*ua_chan
)
2426 struct buffer_reg_uid
*reg_uid
;
2427 struct buffer_reg_channel
*reg_chan
;
2434 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2436 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2438 * The session creation handles the creation of this global registry
2439 * object. If none can be find, there is a code flow problem or a
2444 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2447 /* Create the buffer registry channel object. */
2448 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2455 * Create the buffers on the consumer side. This call populates the
2456 * ust app channel object with all streams and data object.
2458 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2459 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2462 * Let's remove the previously created buffer registry channel so
2463 * it's not visible anymore in the session registry.
2465 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2466 ua_chan
->tracing_channel_id
);
2467 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2468 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2473 * Setup the streams and add it to the session registry.
2475 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2482 /* Send buffers to the application. */
2483 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2493 * Create and send to the application the created buffers with per PID buffers.
2495 * Return 0 on success else a negative value.
2497 static int create_channel_per_pid(struct ust_app
*app
,
2498 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2499 struct ust_app_channel
*ua_chan
)
2502 struct ust_registry_session
*registry
;
2509 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2513 registry
= get_session_registry(ua_sess
);
2516 /* Create and add a new channel registry to session. */
2517 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2522 /* Create and get channel on the consumer side. */
2523 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2524 app
->bits_per_long
, registry
);
2529 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2540 * From an already allocated ust app channel, create the channel buffers if
2541 * need and send it to the application. This MUST be called with a RCU read
2542 * side lock acquired.
2544 * Return 0 on success or else a negative value.
2546 static int do_create_channel(struct ust_app
*app
,
2547 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2548 struct ust_app_channel
*ua_chan
)
2557 /* Handle buffer type before sending the channel to the application. */
2558 switch (usess
->buffer_type
) {
2559 case LTTNG_BUFFER_PER_UID
:
2561 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2567 case LTTNG_BUFFER_PER_PID
:
2569 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2581 /* Initialize ust objd object using the received handle and add it. */
2582 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2583 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2585 /* If channel is not enabled, disable it on the tracer */
2586 if (!ua_chan
->enabled
) {
2587 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2598 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2599 * newly created channel if not NULL.
2601 * Called with UST app session lock and RCU read-side lock held.
2603 * Return 0 on success or else a negative value.
2605 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2606 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2607 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2608 struct ust_app_channel
**ua_chanp
)
2611 struct lttng_ht_iter iter
;
2612 struct lttng_ht_node_str
*ua_chan_node
;
2613 struct ust_app_channel
*ua_chan
;
2615 /* Lookup channel in the ust app session */
2616 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2617 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2618 if (ua_chan_node
!= NULL
) {
2619 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2623 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2624 if (ua_chan
== NULL
) {
2625 /* Only malloc can fail here */
2629 shadow_copy_channel(ua_chan
, uchan
);
2631 /* Set channel type. */
2632 ua_chan
->attr
.type
= type
;
2634 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2639 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2642 /* Only add the channel if successful on the tracer side. */
2643 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2647 *ua_chanp
= ua_chan
;
2650 /* Everything went well. */
2654 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2660 * Create UST app event and create it on the tracer side.
2662 * Called with ust app session mutex held.
2665 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2666 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2667 struct ust_app
*app
)
2670 struct ust_app_event
*ua_event
;
2672 /* Get event node */
2673 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2674 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2675 if (ua_event
!= NULL
) {
2680 /* Does not exist so create one */
2681 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2682 if (ua_event
== NULL
) {
2683 /* Only malloc can failed so something is really wrong */
2687 shadow_copy_event(ua_event
, uevent
);
2689 /* Create it on the tracer side */
2690 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2692 /* Not found previously means that it does not exist on the tracer */
2693 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2697 add_unique_ust_app_event(ua_chan
, ua_event
);
2699 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2706 /* Valid. Calling here is already in a read side lock */
2707 delete_ust_app_event(-1, ua_event
);
2712 * Create UST metadata and open it on the tracer side.
2714 * Called with UST app session lock held and RCU read side lock.
2716 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2717 struct ust_app
*app
, struct consumer_output
*consumer
,
2718 struct ustctl_consumer_channel_attr
*attr
)
2721 struct ust_app_channel
*metadata
;
2722 struct consumer_socket
*socket
;
2723 struct ust_registry_session
*registry
;
2729 registry
= get_session_registry(ua_sess
);
2732 /* Metadata already exists for this registry or it was closed previously */
2733 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2738 /* Allocate UST metadata */
2739 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2741 /* malloc() failed */
2747 /* Set default attributes for metadata. */
2748 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2749 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2750 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2751 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2752 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2753 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2754 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2756 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2757 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2758 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2761 /* Need one fd for the channel. */
2762 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2764 ERR("Exhausted number of available FD upon create metadata");
2768 /* Get the right consumer socket for the application. */
2769 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2772 goto error_consumer
;
2776 * Keep metadata key so we can identify it on the consumer side. Assign it
2777 * to the registry *before* we ask the consumer so we avoid the race of the
2778 * consumer requesting the metadata and the ask_channel call on our side
2779 * did not returned yet.
2781 registry
->metadata_key
= metadata
->key
;
2784 * Ask the metadata channel creation to the consumer. The metadata object
2785 * will be created by the consumer and kept their. However, the stream is
2786 * never added or monitored until we do a first push metadata to the
2789 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2792 /* Nullify the metadata key so we don't try to close it later on. */
2793 registry
->metadata_key
= 0;
2794 goto error_consumer
;
2798 * The setup command will make the metadata stream be sent to the relayd,
2799 * if applicable, and the thread managing the metadatas. This is important
2800 * because after this point, if an error occurs, the only way the stream
2801 * can be deleted is to be monitored in the consumer.
2803 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2805 /* Nullify the metadata key so we don't try to close it later on. */
2806 registry
->metadata_key
= 0;
2807 goto error_consumer
;
2810 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2811 metadata
->key
, app
->pid
);
2814 lttng_fd_put(LTTNG_FD_APPS
, 1);
2815 delete_ust_app_channel(-1, metadata
, app
);
2821 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2822 * acquired before calling this function.
2824 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2826 struct ust_app
*app
= NULL
;
2827 struct lttng_ht_node_ulong
*node
;
2828 struct lttng_ht_iter iter
;
2830 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2831 node
= lttng_ht_iter_get_node_ulong(&iter
);
2833 DBG2("UST app no found with pid %d", pid
);
2837 DBG2("Found UST app by pid %d", pid
);
2839 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2846 * Allocate and init an UST app object using the registration information and
2847 * the command socket. This is called when the command socket connects to the
2850 * The object is returned on success or else NULL.
2852 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2854 struct ust_app
*lta
= NULL
;
2859 DBG3("UST app creating application for socket %d", sock
);
2861 if ((msg
->bits_per_long
== 64 &&
2862 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2863 || (msg
->bits_per_long
== 32 &&
2864 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2865 ERR("Registration failed: application \"%s\" (pid: %d) has "
2866 "%d-bit long, but no consumerd for this size is available.\n",
2867 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2871 lta
= zmalloc(sizeof(struct ust_app
));
2877 lta
->ppid
= msg
->ppid
;
2878 lta
->uid
= msg
->uid
;
2879 lta
->gid
= msg
->gid
;
2881 lta
->bits_per_long
= msg
->bits_per_long
;
2882 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2883 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2884 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2885 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2886 lta
->long_alignment
= msg
->long_alignment
;
2887 lta
->byte_order
= msg
->byte_order
;
2889 lta
->v_major
= msg
->major
;
2890 lta
->v_minor
= msg
->minor
;
2891 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2892 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2893 lta
->notify_sock
= -1;
2895 /* Copy name and make sure it's NULL terminated. */
2896 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2897 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2900 * Before this can be called, when receiving the registration information,
2901 * the application compatibility is checked. So, at this point, the
2902 * application can work with this session daemon.
2904 lta
->compatible
= 1;
2906 lta
->pid
= msg
->pid
;
2907 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2909 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2911 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2918 * For a given application object, add it to every hash table.
2920 void ust_app_add(struct ust_app
*app
)
2923 assert(app
->notify_sock
>= 0);
2928 * On a re-registration, we want to kick out the previous registration of
2931 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2934 * The socket _should_ be unique until _we_ call close. So, a add_unique
2935 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2936 * already in the table.
2938 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2940 /* Add application to the notify socket hash table. */
2941 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2942 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2944 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2945 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2946 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2953 * Set the application version into the object.
2955 * Return 0 on success else a negative value either an errno code or a
2956 * LTTng-UST error code.
2958 int ust_app_version(struct ust_app
*app
)
2964 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2966 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2967 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2969 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2977 * Unregister app by removing it from the global traceable app list and freeing
2980 * The socket is already closed at this point so no close to sock.
2982 void ust_app_unregister(int sock
)
2984 struct ust_app
*lta
;
2985 struct lttng_ht_node_ulong
*node
;
2986 struct lttng_ht_iter iter
;
2987 struct ust_app_session
*ua_sess
;
2992 /* Get the node reference for a call_rcu */
2993 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2994 node
= lttng_ht_iter_get_node_ulong(&iter
);
2997 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2998 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3000 /* Remove application from PID hash table */
3001 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3005 * Remove application from notify hash table. The thread handling the
3006 * notify socket could have deleted the node so ignore on error because
3007 * either way it's valid. The close of that socket is handled by the other
3010 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3011 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3014 * Ignore return value since the node might have been removed before by an
3015 * add replace during app registration because the PID can be reassigned by
3018 iter
.iter
.node
= <a
->pid_n
.node
;
3019 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3021 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3025 /* Remove sessions so they are not visible during deletion.*/
3026 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3028 struct ust_registry_session
*registry
;
3030 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3032 /* The session was already removed so scheduled for teardown. */
3037 * Add session to list for teardown. This is safe since at this point we
3038 * are the only one using this list.
3040 pthread_mutex_lock(&ua_sess
->lock
);
3043 * Normally, this is done in the delete session process which is
3044 * executed in the call rcu below. However, upon registration we can't
3045 * afford to wait for the grace period before pushing data or else the
3046 * data pending feature can race between the unregistration and stop
3047 * command where the data pending command is sent *before* the grace
3050 * The close metadata below nullifies the metadata pointer in the
3051 * session so the delete session will NOT push/close a second time.
3053 registry
= get_session_registry(ua_sess
);
3054 if (registry
&& !registry
->metadata_closed
) {
3055 /* Push metadata for application before freeing the application. */
3056 (void) push_metadata(registry
, ua_sess
->consumer
);
3059 * Don't ask to close metadata for global per UID buffers. Close
3060 * metadata only on destroy trace session in this case. Also, the
3061 * previous push metadata could have flag the metadata registry to
3062 * close so don't send a close command if closed.
3064 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3065 !registry
->metadata_closed
) {
3066 /* And ask to close it for this session registry. */
3067 (void) close_metadata(registry
, ua_sess
->consumer
);
3071 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3072 pthread_mutex_unlock(&ua_sess
->lock
);
3076 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3083 * Fill events array with all events name of all registered apps.
3085 int ust_app_list_events(struct lttng_event
**events
)
3088 size_t nbmem
, count
= 0;
3089 struct lttng_ht_iter iter
;
3090 struct ust_app
*app
;
3091 struct lttng_event
*tmp_event
;
3093 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3094 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3095 if (tmp_event
== NULL
) {
3096 PERROR("zmalloc ust app events");
3103 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3104 struct lttng_ust_tracepoint_iter uiter
;
3106 health_code_update();
3108 if (!app
->compatible
) {
3110 * TODO: In time, we should notice the caller of this error by
3111 * telling him that this is a version error.
3115 handle
= ustctl_tracepoint_list(app
->sock
);
3117 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3118 ERR("UST app list events getting handle failed for app pid %d",
3124 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3125 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3126 /* Handle ustctl error. */
3129 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3130 ERR("UST app tp list get failed for app %d with ret %d",
3133 DBG3("UST app tp list get failed. Application is dead");
3135 * This is normal behavior, an application can die during the
3136 * creation process. Don't report an error so the execution can
3137 * continue normally. Continue normal execution.
3144 health_code_update();
3145 if (count
>= nbmem
) {
3146 /* In case the realloc fails, we free the memory */
3149 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3152 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3154 PERROR("realloc ust app events");
3161 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3162 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3163 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3164 tmp_event
[count
].pid
= app
->pid
;
3165 tmp_event
[count
].enabled
= -1;
3171 *events
= tmp_event
;
3173 DBG2("UST app list events done (%zu events)", count
);
3178 health_code_update();
3183 * Fill events array with all events name of all registered apps.
3185 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3188 size_t nbmem
, count
= 0;
3189 struct lttng_ht_iter iter
;
3190 struct ust_app
*app
;
3191 struct lttng_event_field
*tmp_event
;
3193 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3194 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3195 if (tmp_event
== NULL
) {
3196 PERROR("zmalloc ust app event fields");
3203 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3204 struct lttng_ust_field_iter uiter
;
3206 health_code_update();
3208 if (!app
->compatible
) {
3210 * TODO: In time, we should notice the caller of this error by
3211 * telling him that this is a version error.
3215 handle
= ustctl_tracepoint_field_list(app
->sock
);
3217 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3218 ERR("UST app list field getting handle failed for app pid %d",
3224 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3225 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3226 /* Handle ustctl error. */
3229 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3230 ERR("UST app tp list field failed for app %d with ret %d",
3233 DBG3("UST app tp list field failed. Application is dead");
3235 * This is normal behavior, an application can die during the
3236 * creation process. Don't report an error so the execution can
3237 * continue normally.
3244 health_code_update();
3245 if (count
>= nbmem
) {
3246 /* In case the realloc fails, we free the memory */
3249 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3252 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3254 PERROR("realloc ust app event fields");
3262 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3263 /* Mapping between these enums matches 1 to 1. */
3264 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3265 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3267 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3268 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3269 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3270 tmp_event
[count
].event
.pid
= app
->pid
;
3271 tmp_event
[count
].event
.enabled
= -1;
3277 *fields
= tmp_event
;
3279 DBG2("UST app list event fields done (%zu events)", count
);
3284 health_code_update();
3289 * Free and clean all traceable apps of the global list.
3291 * Should _NOT_ be called with RCU read-side lock held.
3293 void ust_app_clean_list(void)
3296 struct ust_app
*app
;
3297 struct lttng_ht_iter iter
;
3299 DBG2("UST app cleaning registered apps hash table");
3303 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3304 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3306 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3309 /* Cleanup socket hash table */
3310 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3312 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3316 /* Cleanup notify socket hash table */
3317 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3318 notify_sock_n
.node
) {
3319 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3324 /* Destroy is done only when the ht is empty */
3325 ht_cleanup_push(ust_app_ht
);
3326 ht_cleanup_push(ust_app_ht_by_sock
);
3327 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3331 * Init UST app hash table.
3333 void ust_app_ht_alloc(void)
3335 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3336 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3337 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3341 * For a specific UST session, disable the channel for all registered apps.
3343 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3344 struct ltt_ust_channel
*uchan
)
3347 struct lttng_ht_iter iter
;
3348 struct lttng_ht_node_str
*ua_chan_node
;
3349 struct ust_app
*app
;
3350 struct ust_app_session
*ua_sess
;
3351 struct ust_app_channel
*ua_chan
;
3353 if (usess
== NULL
|| uchan
== NULL
) {
3354 ERR("Disabling UST global channel with NULL values");
3359 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3360 uchan
->name
, usess
->id
);
3364 /* For every registered applications */
3365 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3366 struct lttng_ht_iter uiter
;
3367 if (!app
->compatible
) {
3369 * TODO: In time, we should notice the caller of this error by
3370 * telling him that this is a version error.
3374 ua_sess
= lookup_session_by_app(usess
, app
);
3375 if (ua_sess
== NULL
) {
3380 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3381 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3382 /* If the session if found for the app, the channel must be there */
3383 assert(ua_chan_node
);
3385 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3386 /* The channel must not be already disabled */
3387 assert(ua_chan
->enabled
== 1);
3389 /* Disable channel onto application */
3390 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3392 /* XXX: We might want to report this error at some point... */
3404 * For a specific UST session, enable the channel for all registered apps.
3406 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3407 struct ltt_ust_channel
*uchan
)
3410 struct lttng_ht_iter iter
;
3411 struct ust_app
*app
;
3412 struct ust_app_session
*ua_sess
;
3414 if (usess
== NULL
|| uchan
== NULL
) {
3415 ERR("Adding UST global channel to NULL values");
3420 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3421 uchan
->name
, usess
->id
);
3425 /* For every registered applications */
3426 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3427 if (!app
->compatible
) {
3429 * TODO: In time, we should notice the caller of this error by
3430 * telling him that this is a version error.
3434 ua_sess
= lookup_session_by_app(usess
, app
);
3435 if (ua_sess
== NULL
) {
3439 /* Enable channel onto application */
3440 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3442 /* XXX: We might want to report this error at some point... */
3454 * Disable an event in a channel and for a specific session.
3456 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3457 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3460 struct lttng_ht_iter iter
, uiter
;
3461 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3462 struct ust_app
*app
;
3463 struct ust_app_session
*ua_sess
;
3464 struct ust_app_channel
*ua_chan
;
3465 struct ust_app_event
*ua_event
;
3467 DBG("UST app disabling event %s for all apps in channel "
3468 "%s for session id %" PRIu64
,
3469 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3473 /* For all registered applications */
3474 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3475 if (!app
->compatible
) {
3477 * TODO: In time, we should notice the caller of this error by
3478 * telling him that this is a version error.
3482 ua_sess
= lookup_session_by_app(usess
, app
);
3483 if (ua_sess
== NULL
) {
3488 /* Lookup channel in the ust app session */
3489 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3490 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3491 if (ua_chan_node
== NULL
) {
3492 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3493 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3496 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3498 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3499 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3500 if (ua_event_node
== NULL
) {
3501 DBG2("Event %s not found in channel %s for app pid %d."
3502 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3505 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3507 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3509 /* XXX: Report error someday... */
3520 * For a specific UST session, create the channel for all registered apps.
3522 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3523 struct ltt_ust_channel
*uchan
)
3525 int ret
= 0, created
;
3526 struct lttng_ht_iter iter
;
3527 struct ust_app
*app
;
3528 struct ust_app_session
*ua_sess
= NULL
;
3530 /* Very wrong code flow */
3534 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3535 uchan
->name
, usess
->id
);
3539 /* For every registered applications */
3540 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3541 if (!app
->compatible
) {
3543 * TODO: In time, we should notice the caller of this error by
3544 * telling him that this is a version error.
3549 * Create session on the tracer side and add it to app session HT. Note
3550 * that if session exist, it will simply return a pointer to the ust
3553 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3558 * The application's socket is not valid. Either a bad socket
3559 * or a timeout on it. We can't inform the caller that for a
3560 * specific app, the session failed so lets continue here.
3565 goto error_rcu_unlock
;
3570 pthread_mutex_lock(&ua_sess
->lock
);
3571 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3572 sizeof(uchan
->name
))) {
3573 struct ustctl_consumer_channel_attr attr
;
3574 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3575 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3578 /* Create channel onto application. We don't need the chan ref. */
3579 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3580 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3582 pthread_mutex_unlock(&ua_sess
->lock
);
3584 if (ret
== -ENOMEM
) {
3585 /* No more memory is a fatal error. Stop right now. */
3586 goto error_rcu_unlock
;
3588 /* Cleanup the created session if it's the case. */
3590 destroy_app_session(app
, ua_sess
);
3601 * Enable event for a specific session and channel on the tracer.
3603 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3604 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3607 struct lttng_ht_iter iter
, uiter
;
3608 struct lttng_ht_node_str
*ua_chan_node
;
3609 struct ust_app
*app
;
3610 struct ust_app_session
*ua_sess
;
3611 struct ust_app_channel
*ua_chan
;
3612 struct ust_app_event
*ua_event
;
3614 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3615 uevent
->attr
.name
, usess
->id
);
3618 * NOTE: At this point, this function is called only if the session and
3619 * channel passed are already created for all apps. and enabled on the
3625 /* For all registered applications */
3626 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3627 if (!app
->compatible
) {
3629 * TODO: In time, we should notice the caller of this error by
3630 * telling him that this is a version error.
3634 ua_sess
= lookup_session_by_app(usess
, app
);
3636 /* The application has problem or is probably dead. */
3640 pthread_mutex_lock(&ua_sess
->lock
);
3642 /* Lookup channel in the ust app session */
3643 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3644 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3645 /* If the channel is not found, there is a code flow error */
3646 assert(ua_chan_node
);
3648 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3650 /* Get event node */
3651 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3652 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3653 if (ua_event
== NULL
) {
3654 DBG3("UST app enable event %s not found for app PID %d."
3655 "Skipping app", uevent
->attr
.name
, app
->pid
);
3659 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3661 pthread_mutex_unlock(&ua_sess
->lock
);
3665 pthread_mutex_unlock(&ua_sess
->lock
);
3674 * For a specific existing UST session and UST channel, creates the event for
3675 * all registered apps.
3677 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3678 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3681 struct lttng_ht_iter iter
, uiter
;
3682 struct lttng_ht_node_str
*ua_chan_node
;
3683 struct ust_app
*app
;
3684 struct ust_app_session
*ua_sess
;
3685 struct ust_app_channel
*ua_chan
;
3687 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3688 uevent
->attr
.name
, usess
->id
);
3692 /* For all registered applications */
3693 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3694 if (!app
->compatible
) {
3696 * TODO: In time, we should notice the caller of this error by
3697 * telling him that this is a version error.
3701 ua_sess
= lookup_session_by_app(usess
, app
);
3703 /* The application has problem or is probably dead. */
3707 pthread_mutex_lock(&ua_sess
->lock
);
3708 /* Lookup channel in the ust app session */
3709 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3710 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3711 /* If the channel is not found, there is a code flow error */
3712 assert(ua_chan_node
);
3714 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3716 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3717 pthread_mutex_unlock(&ua_sess
->lock
);
3719 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3720 /* Possible value at this point: -ENOMEM. If so, we stop! */
3723 DBG2("UST app event %s already exist on app PID %d",
3724 uevent
->attr
.name
, app
->pid
);
3735 * Start tracing for a specific UST session and app.
3738 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3741 struct ust_app_session
*ua_sess
;
3743 DBG("Starting tracing for ust app pid %d", app
->pid
);
3747 if (!app
->compatible
) {
3751 ua_sess
= lookup_session_by_app(usess
, app
);
3752 if (ua_sess
== NULL
) {
3753 /* The session is in teardown process. Ignore and continue. */
3757 pthread_mutex_lock(&ua_sess
->lock
);
3759 /* Upon restart, we skip the setup, already done */
3760 if (ua_sess
->started
) {
3764 /* Create directories if consumer is LOCAL and has a path defined. */
3765 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3766 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3767 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3768 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3770 if (ret
!= -EEXIST
) {
3771 ERR("Trace directory creation error");
3778 * Create the metadata for the application. This returns gracefully if a
3779 * metadata was already set for the session.
3781 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3786 health_code_update();
3789 /* This start the UST tracing */
3790 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3792 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3793 ERR("Error starting tracing for app pid: %d (ret: %d)",
3796 DBG("UST app start session failed. Application is dead.");
3798 * This is normal behavior, an application can die during the
3799 * creation process. Don't report an error so the execution can
3800 * continue normally.
3802 pthread_mutex_unlock(&ua_sess
->lock
);
3808 /* Indicate that the session has been started once */
3809 ua_sess
->started
= 1;
3811 pthread_mutex_unlock(&ua_sess
->lock
);
3813 health_code_update();
3815 /* Quiescent wait after starting trace */
3816 ret
= ustctl_wait_quiescent(app
->sock
);
3817 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3818 ERR("UST app wait quiescent failed for app pid %d ret %d",
3824 health_code_update();
3828 pthread_mutex_unlock(&ua_sess
->lock
);
3830 health_code_update();
3835 * Stop tracing for a specific UST session and app.
3838 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3841 struct ust_app_session
*ua_sess
;
3842 struct ust_registry_session
*registry
;
3844 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3848 if (!app
->compatible
) {
3849 goto end_no_session
;
3852 ua_sess
= lookup_session_by_app(usess
, app
);
3853 if (ua_sess
== NULL
) {
3854 goto end_no_session
;
3857 pthread_mutex_lock(&ua_sess
->lock
);
3860 * If started = 0, it means that stop trace has been called for a session
3861 * that was never started. It's possible since we can have a fail start
3862 * from either the application manager thread or the command thread. Simply
3863 * indicate that this is a stop error.
3865 if (!ua_sess
->started
) {
3866 goto error_rcu_unlock
;
3869 health_code_update();
3871 /* This inhibits UST tracing */
3872 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3874 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3875 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3878 DBG("UST app stop session failed. Application is dead.");
3880 * This is normal behavior, an application can die during the
3881 * creation process. Don't report an error so the execution can
3882 * continue normally.
3886 goto error_rcu_unlock
;
3889 health_code_update();
3891 /* Quiescent wait after stopping trace */
3892 ret
= ustctl_wait_quiescent(app
->sock
);
3893 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3894 ERR("UST app wait quiescent failed for app pid %d ret %d",
3898 health_code_update();
3900 registry
= get_session_registry(ua_sess
);
3903 if (!registry
->metadata_closed
) {
3904 /* Push metadata for application before freeing the application. */
3905 (void) push_metadata(registry
, ua_sess
->consumer
);
3909 pthread_mutex_unlock(&ua_sess
->lock
);
3912 health_code_update();
3916 pthread_mutex_unlock(&ua_sess
->lock
);
3918 health_code_update();
3923 * Flush buffers for a specific UST session and app.
3926 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3929 struct lttng_ht_iter iter
;
3930 struct ust_app_session
*ua_sess
;
3931 struct ust_app_channel
*ua_chan
;
3933 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3937 if (!app
->compatible
) {
3938 goto end_no_session
;
3941 ua_sess
= lookup_session_by_app(usess
, app
);
3942 if (ua_sess
== NULL
) {
3943 goto end_no_session
;
3946 pthread_mutex_lock(&ua_sess
->lock
);
3948 health_code_update();
3950 /* Flushing buffers */
3951 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3953 health_code_update();
3954 assert(ua_chan
->is_sent
);
3955 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3957 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3958 ERR("UST app PID %d channel %s flush failed with ret %d",
3959 app
->pid
, ua_chan
->name
, ret
);
3961 DBG3("UST app failed to flush %s. Application is dead.",
3964 * This is normal behavior, an application can die during the
3965 * creation process. Don't report an error so the execution can
3966 * continue normally.
3969 /* Continuing flushing all buffers */
3974 health_code_update();
3976 pthread_mutex_unlock(&ua_sess
->lock
);
3979 health_code_update();
3984 * Destroy a specific UST session in apps.
3986 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3989 struct ust_app_session
*ua_sess
;
3990 struct lttng_ht_iter iter
;
3991 struct lttng_ht_node_u64
*node
;
3993 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3997 if (!app
->compatible
) {
4001 __lookup_session_by_app(usess
, app
, &iter
);
4002 node
= lttng_ht_iter_get_node_u64(&iter
);
4004 /* Session is being or is deleted. */
4007 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4009 health_code_update();
4010 destroy_app_session(app
, ua_sess
);
4012 health_code_update();
4014 /* Quiescent wait after stopping trace */
4015 ret
= ustctl_wait_quiescent(app
->sock
);
4016 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4017 ERR("UST app wait quiescent failed for app pid %d ret %d",
4022 health_code_update();
4027 * Start tracing for the UST session.
4029 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4032 struct lttng_ht_iter iter
;
4033 struct ust_app
*app
;
4035 DBG("Starting all UST traces");
4039 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4040 ret
= ust_app_start_trace(usess
, app
);
4042 /* Continue to next apps even on error */
4053 * Start tracing for the UST session.
4055 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4058 struct lttng_ht_iter iter
;
4059 struct ust_app
*app
;
4061 DBG("Stopping all UST traces");
4065 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4066 ret
= ust_app_stop_trace(usess
, app
);
4068 /* Continue to next apps even on error */
4073 /* Flush buffers and push metadata (for UID buffers). */
4074 switch (usess
->buffer_type
) {
4075 case LTTNG_BUFFER_PER_UID
:
4077 struct buffer_reg_uid
*reg
;
4079 /* Flush all per UID buffers associated to that session. */
4080 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4081 struct ust_registry_session
*ust_session_reg
;
4082 struct buffer_reg_channel
*reg_chan
;
4083 struct consumer_socket
*socket
;
4085 /* Get consumer socket to use to push the metadata.*/
4086 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4089 /* Ignore request if no consumer is found for the session. */
4093 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4094 reg_chan
, node
.node
) {
4096 * The following call will print error values so the return
4097 * code is of little importance because whatever happens, we
4098 * have to try them all.
4100 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4103 ust_session_reg
= reg
->registry
->reg
.ust
;
4104 if (!ust_session_reg
->metadata_closed
) {
4105 /* Push metadata. */
4106 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4112 case LTTNG_BUFFER_PER_PID
:
4113 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4114 ret
= ust_app_flush_trace(usess
, app
);
4116 /* Continue to next apps even on error */
4132 * Destroy app UST session.
4134 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4137 struct lttng_ht_iter iter
;
4138 struct ust_app
*app
;
4140 DBG("Destroy all UST traces");
4144 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4145 ret
= destroy_trace(usess
, app
);
4147 /* Continue to next apps even on error */
4158 * Add channels/events from UST global domain to registered apps at sock.
4160 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4163 struct lttng_ht_iter iter
, uiter
;
4164 struct ust_app
*app
;
4165 struct ust_app_session
*ua_sess
= NULL
;
4166 struct ust_app_channel
*ua_chan
;
4167 struct ust_app_event
*ua_event
;
4168 struct ust_app_ctx
*ua_ctx
;
4173 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4178 app
= ust_app_find_by_sock(sock
);
4181 * Application can be unregistered before so this is possible hence
4182 * simply stopping the update.
4184 DBG3("UST app update failed to find app sock %d", sock
);
4188 if (!app
->compatible
) {
4192 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4194 /* Tracer is probably gone or ENOMEM. */
4199 pthread_mutex_lock(&ua_sess
->lock
);
4202 * We can iterate safely here over all UST app session since the create ust
4203 * app session above made a shadow copy of the UST global domain from the
4206 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4209 * For a metadata channel, handle it differently.
4211 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4212 sizeof(ua_chan
->name
))) {
4213 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4218 /* Remove it from the hash table and continue!. */
4219 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4221 delete_ust_app_channel(-1, ua_chan
, app
);
4224 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4227 * Stop everything. On error, the application failed, no more
4228 * file descriptor are available or ENOMEM so stopping here is
4229 * the only thing we can do for now.
4236 * Add context using the list so they are enabled in the same order the
4239 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4240 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4247 /* For each events */
4248 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4250 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4257 pthread_mutex_unlock(&ua_sess
->lock
);
4259 if (usess
->start_trace
) {
4260 ret
= ust_app_start_trace(usess
, app
);
4265 DBG2("UST trace started for app pid %d", app
->pid
);
4268 /* Everything went well at this point. */
4273 pthread_mutex_unlock(&ua_sess
->lock
);
4276 destroy_app_session(app
, ua_sess
);
4283 * Add context to a specific channel for global UST domain.
4285 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4286 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4289 struct lttng_ht_node_str
*ua_chan_node
;
4290 struct lttng_ht_iter iter
, uiter
;
4291 struct ust_app_channel
*ua_chan
= NULL
;
4292 struct ust_app_session
*ua_sess
;
4293 struct ust_app
*app
;
4297 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4298 if (!app
->compatible
) {
4300 * TODO: In time, we should notice the caller of this error by
4301 * telling him that this is a version error.
4305 ua_sess
= lookup_session_by_app(usess
, app
);
4306 if (ua_sess
== NULL
) {
4310 pthread_mutex_lock(&ua_sess
->lock
);
4311 /* Lookup channel in the ust app session */
4312 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4313 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4314 if (ua_chan_node
== NULL
) {
4317 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4319 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4324 pthread_mutex_unlock(&ua_sess
->lock
);
4332 * Enable event for a channel from a UST session for a specific PID.
4334 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4335 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4338 struct lttng_ht_iter iter
;
4339 struct lttng_ht_node_str
*ua_chan_node
;
4340 struct ust_app
*app
;
4341 struct ust_app_session
*ua_sess
;
4342 struct ust_app_channel
*ua_chan
;
4343 struct ust_app_event
*ua_event
;
4345 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4349 app
= ust_app_find_by_pid(pid
);
4351 ERR("UST app enable event per PID %d not found", pid
);
4356 if (!app
->compatible
) {
4361 ua_sess
= lookup_session_by_app(usess
, app
);
4363 /* The application has problem or is probably dead. */
4368 pthread_mutex_lock(&ua_sess
->lock
);
4369 /* Lookup channel in the ust app session */
4370 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4371 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4372 /* If the channel is not found, there is a code flow error */
4373 assert(ua_chan_node
);
4375 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4377 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4378 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4379 if (ua_event
== NULL
) {
4380 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4385 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4392 pthread_mutex_unlock(&ua_sess
->lock
);
4399 * Calibrate registered applications.
4401 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4404 struct lttng_ht_iter iter
;
4405 struct ust_app
*app
;
4409 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4410 if (!app
->compatible
) {
4412 * TODO: In time, we should notice the caller of this error by
4413 * telling him that this is a version error.
4418 health_code_update();
4420 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4424 /* Means that it's not implemented on the tracer side. */
4428 DBG2("Calibrate app PID %d returned with error %d",
4435 DBG("UST app global domain calibration finished");
4439 health_code_update();
4445 * Receive registration and populate the given msg structure.
4447 * On success return 0 else a negative value returned by the ustctl call.
4449 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4452 uint32_t pid
, ppid
, uid
, gid
;
4456 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4457 &pid
, &ppid
, &uid
, &gid
,
4458 &msg
->bits_per_long
,
4459 &msg
->uint8_t_alignment
,
4460 &msg
->uint16_t_alignment
,
4461 &msg
->uint32_t_alignment
,
4462 &msg
->uint64_t_alignment
,
4463 &msg
->long_alignment
,
4470 case LTTNG_UST_ERR_EXITING
:
4471 DBG3("UST app recv reg message failed. Application died");
4473 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4474 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4475 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4476 LTTNG_UST_ABI_MINOR_VERSION
);
4479 ERR("UST app recv reg message failed with ret %d", ret
);
4484 msg
->pid
= (pid_t
) pid
;
4485 msg
->ppid
= (pid_t
) ppid
;
4486 msg
->uid
= (uid_t
) uid
;
4487 msg
->gid
= (gid_t
) gid
;
4494 * Return a ust app channel object using the application object and the channel
4495 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4496 * lock MUST be acquired before calling this function.
4498 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4501 struct lttng_ht_node_ulong
*node
;
4502 struct lttng_ht_iter iter
;
4503 struct ust_app_channel
*ua_chan
= NULL
;
4507 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4508 node
= lttng_ht_iter_get_node_ulong(&iter
);
4510 DBG2("UST app channel find by objd %d not found", objd
);
4514 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4521 * Reply to a register channel notification from an application on the notify
4522 * socket. The channel metadata is also created.
4524 * The session UST registry lock is acquired in this function.
4526 * On success 0 is returned else a negative value.
4528 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4529 size_t nr_fields
, struct ustctl_field
*fields
)
4531 int ret
, ret_code
= 0;
4532 uint32_t chan_id
, reg_count
;
4533 uint64_t chan_reg_key
;
4534 enum ustctl_channel_header type
;
4535 struct ust_app
*app
;
4536 struct ust_app_channel
*ua_chan
;
4537 struct ust_app_session
*ua_sess
;
4538 struct ust_registry_session
*registry
;
4539 struct ust_registry_channel
*chan_reg
;
4543 /* Lookup application. If not found, there is a code flow error. */
4544 app
= find_app_by_notify_sock(sock
);
4546 DBG("Application socket %d is being teardown. Abort event notify",
4550 goto error_rcu_unlock
;
4553 /* Lookup channel by UST object descriptor. */
4554 ua_chan
= find_channel_by_objd(app
, cobjd
);
4556 DBG("Application channel is being teardown. Abort event notify");
4559 goto error_rcu_unlock
;
4562 assert(ua_chan
->session
);
4563 ua_sess
= ua_chan
->session
;
4565 /* Get right session registry depending on the session buffer type. */
4566 registry
= get_session_registry(ua_sess
);
4569 /* Depending on the buffer type, a different channel key is used. */
4570 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4571 chan_reg_key
= ua_chan
->tracing_channel_id
;
4573 chan_reg_key
= ua_chan
->key
;
4576 pthread_mutex_lock(®istry
->lock
);
4578 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4581 if (!chan_reg
->register_done
) {
4582 reg_count
= ust_registry_get_event_count(chan_reg
);
4583 if (reg_count
< 31) {
4584 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4586 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4589 chan_reg
->nr_ctx_fields
= nr_fields
;
4590 chan_reg
->ctx_fields
= fields
;
4591 chan_reg
->header_type
= type
;
4593 /* Get current already assigned values. */
4594 type
= chan_reg
->header_type
;
4596 /* Set to NULL so the error path does not do a double free. */
4599 /* Channel id is set during the object creation. */
4600 chan_id
= chan_reg
->chan_id
;
4602 /* Append to metadata */
4603 if (!chan_reg
->metadata_dumped
) {
4604 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4606 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4612 DBG3("UST app replying to register channel key %" PRIu64
4613 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4616 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4618 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4619 ERR("UST app reply channel failed with ret %d", ret
);
4621 DBG3("UST app reply channel failed. Application died");
4626 /* This channel registry registration is completed. */
4627 chan_reg
->register_done
= 1;
4630 pthread_mutex_unlock(®istry
->lock
);
4640 * Add event to the UST channel registry. When the event is added to the
4641 * registry, the metadata is also created. Once done, this replies to the
4642 * application with the appropriate error code.
4644 * The session UST registry lock is acquired in the function.
4646 * On success 0 is returned else a negative value.
4648 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4649 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4650 char *model_emf_uri
)
4653 uint32_t event_id
= 0;
4654 uint64_t chan_reg_key
;
4655 struct ust_app
*app
;
4656 struct ust_app_channel
*ua_chan
;
4657 struct ust_app_session
*ua_sess
;
4658 struct ust_registry_session
*registry
;
4662 /* Lookup application. If not found, there is a code flow error. */
4663 app
= find_app_by_notify_sock(sock
);
4665 DBG("Application socket %d is being teardown. Abort event notify",
4670 free(model_emf_uri
);
4671 goto error_rcu_unlock
;
4674 /* Lookup channel by UST object descriptor. */
4675 ua_chan
= find_channel_by_objd(app
, cobjd
);
4677 DBG("Application channel is being teardown. Abort event notify");
4681 free(model_emf_uri
);
4682 goto error_rcu_unlock
;
4685 assert(ua_chan
->session
);
4686 ua_sess
= ua_chan
->session
;
4688 registry
= get_session_registry(ua_sess
);
4691 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4692 chan_reg_key
= ua_chan
->tracing_channel_id
;
4694 chan_reg_key
= ua_chan
->key
;
4697 pthread_mutex_lock(®istry
->lock
);
4700 * From this point on, this call acquires the ownership of the sig, fields
4701 * and model_emf_uri meaning any free are done inside it if needed. These
4702 * three variables MUST NOT be read/write after this.
4704 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4705 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4706 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4710 * The return value is returned to ustctl so in case of an error, the
4711 * application can be notified. In case of an error, it's important not to
4712 * return a negative error or else the application will get closed.
4714 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4716 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4717 ERR("UST app reply event failed with ret %d", ret
);
4719 DBG3("UST app reply event failed. Application died");
4722 * No need to wipe the create event since the application socket will
4723 * get close on error hence cleaning up everything by itself.
4728 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4732 pthread_mutex_unlock(®istry
->lock
);
4739 * Handle application notification through the given notify socket.
4741 * Return 0 on success or else a negative value.
4743 int ust_app_recv_notify(int sock
)
4746 enum ustctl_notify_cmd cmd
;
4748 DBG3("UST app receiving notify from sock %d", sock
);
4750 ret
= ustctl_recv_notify(sock
, &cmd
);
4752 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4753 ERR("UST app recv notify failed with ret %d", ret
);
4755 DBG3("UST app recv notify failed. Application died");
4761 case USTCTL_NOTIFY_CMD_EVENT
:
4763 int sobjd
, cobjd
, loglevel
;
4764 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4766 struct ustctl_field
*fields
;
4768 DBG2("UST app ustctl register event received");
4770 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4771 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4773 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4774 ERR("UST app recv event failed with ret %d", ret
);
4776 DBG3("UST app recv event failed. Application died");
4782 * Add event to the UST registry coming from the notify socket. This
4783 * call will free if needed the sig, fields and model_emf_uri. This
4784 * code path loses the ownsership of these variables and transfer them
4785 * to the this function.
4787 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4788 fields
, loglevel
, model_emf_uri
);
4795 case USTCTL_NOTIFY_CMD_CHANNEL
:
4799 struct ustctl_field
*fields
;
4801 DBG2("UST app ustctl register channel received");
4803 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4806 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4807 ERR("UST app recv channel failed with ret %d", ret
);
4809 DBG3("UST app recv channel failed. Application died");
4815 * The fields ownership are transfered to this function call meaning
4816 * that if needed it will be freed. After this, it's invalid to access
4817 * fields or clean it up.
4819 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4828 /* Should NEVER happen. */
4837 * Once the notify socket hangs up, this is called. First, it tries to find the
4838 * corresponding application. On failure, the call_rcu to close the socket is
4839 * executed. If an application is found, it tries to delete it from the notify
4840 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4842 * Note that an object needs to be allocated here so on ENOMEM failure, the
4843 * call RCU is not done but the rest of the cleanup is.
4845 void ust_app_notify_sock_unregister(int sock
)
4848 struct lttng_ht_iter iter
;
4849 struct ust_app
*app
;
4850 struct ust_app_notify_sock_obj
*obj
;
4856 obj
= zmalloc(sizeof(*obj
));
4859 * An ENOMEM is kind of uncool. If this strikes we continue the
4860 * procedure but the call_rcu will not be called. In this case, we
4861 * accept the fd leak rather than possibly creating an unsynchronized
4862 * state between threads.
4864 * TODO: The notify object should be created once the notify socket is
4865 * registered and stored independantely from the ust app object. The
4866 * tricky part is to synchronize the teardown of the application and
4867 * this notify object. Let's keep that in mind so we can avoid this
4868 * kind of shenanigans with ENOMEM in the teardown path.
4875 DBG("UST app notify socket unregister %d", sock
);
4878 * Lookup application by notify socket. If this fails, this means that the
4879 * hash table delete has already been done by the application
4880 * unregistration process so we can safely close the notify socket in a
4883 app
= find_app_by_notify_sock(sock
);
4888 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4891 * Whatever happens here either we fail or succeed, in both cases we have
4892 * to close the socket after a grace period to continue to the call RCU
4893 * here. If the deletion is successful, the application is not visible
4894 * anymore by other threads and is it fails it means that it was already
4895 * deleted from the hash table so either way we just have to close the
4898 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4904 * Close socket after a grace period to avoid for the socket to be reused
4905 * before the application object is freed creating potential race between
4906 * threads trying to add unique in the global hash table.
4909 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4914 * Destroy a ust app data structure and free its memory.
4916 void ust_app_destroy(struct ust_app
*app
)
4922 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4926 * Take a snapshot for a given UST session. The snapshot is sent to the given
4929 * Return 0 on success or else a negative value.
4931 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4932 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4935 struct lttng_ht_iter iter
;
4936 struct ust_app
*app
;
4937 char pathname
[PATH_MAX
];
4938 uint64_t max_stream_size
= 0;
4946 * Compute the maximum size of a single stream if a max size is asked by
4949 if (output
->max_size
> 0 && nb_streams
> 0) {
4950 max_stream_size
= output
->max_size
/ nb_streams
;
4953 switch (usess
->buffer_type
) {
4954 case LTTNG_BUFFER_PER_UID
:
4956 struct buffer_reg_uid
*reg
;
4958 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4959 struct buffer_reg_channel
*reg_chan
;
4960 struct consumer_socket
*socket
;
4962 /* Get consumer socket to use to push the metadata.*/
4963 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4970 memset(pathname
, 0, sizeof(pathname
));
4971 ret
= snprintf(pathname
, sizeof(pathname
),
4972 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
4973 reg
->uid
, reg
->bits_per_long
);
4975 PERROR("snprintf snapshot path");
4979 /* Add the UST default trace dir to path. */
4980 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4981 reg_chan
, node
.node
) {
4984 * Make sure the maximum stream size is not lower than the
4985 * subbuffer size or else it's an error since we won't be able to
4986 * snapshot anything.
4988 if (max_stream_size
&&
4989 reg_chan
->subbuf_size
> max_stream_size
) {
4991 DBG3("UST app snapshot record maximum stream size %" PRIu64
4992 " is smaller than subbuffer size of %zu",
4993 max_stream_size
, reg_chan
->subbuf_size
);
4996 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
4997 usess
->uid
, usess
->gid
, pathname
, wait
,
5003 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
5004 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5012 case LTTNG_BUFFER_PER_PID
:
5014 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5015 struct consumer_socket
*socket
;
5016 struct lttng_ht_iter chan_iter
;
5017 struct ust_app_channel
*ua_chan
;
5018 struct ust_app_session
*ua_sess
;
5019 struct ust_registry_session
*registry
;
5021 ua_sess
= lookup_session_by_app(usess
, app
);
5023 /* Session not associated with this app. */
5027 /* Get the right consumer socket for the application. */
5028 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5035 /* Add the UST default trace dir to path. */
5036 memset(pathname
, 0, sizeof(pathname
));
5037 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5040 PERROR("snprintf snapshot path");
5044 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5045 ua_chan
, node
.node
) {
5047 * Make sure the maximum stream size is not lower than the
5048 * subbuffer size or else it's an error since we won't be able to
5049 * snapshot anything.
5051 if (max_stream_size
&&
5052 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5054 DBG3("UST app snapshot record maximum stream size %" PRIu64
5055 " is smaller than subbuffer size of %" PRIu64
,
5056 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5060 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5061 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5068 registry
= get_session_registry(ua_sess
);
5070 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5071 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5090 * Return the number of streams for a UST session.
5092 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5094 unsigned int ret
= 0;
5095 struct ust_app
*app
;
5096 struct lttng_ht_iter iter
;
5100 switch (usess
->buffer_type
) {
5101 case LTTNG_BUFFER_PER_UID
:
5103 struct buffer_reg_uid
*reg
;
5105 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5106 struct buffer_reg_channel
*reg_chan
;
5108 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5109 reg_chan
, node
.node
) {
5110 ret
+= reg_chan
->stream_count
;
5115 case LTTNG_BUFFER_PER_PID
:
5118 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5119 struct ust_app_channel
*ua_chan
;
5120 struct ust_app_session
*ua_sess
;
5121 struct lttng_ht_iter chan_iter
;
5123 ua_sess
= lookup_session_by_app(usess
, app
);
5125 /* Session not associated with this app. */
5129 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5130 ua_chan
, node
.node
) {
5131 ret
+= ua_chan
->streams
.count
;