2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <sys/types.h>
29 #include <urcu/compiler.h>
30 #include <lttng/ust-error.h>
33 #include <common/common.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
36 #include "buffer-registry.h"
38 #include "health-sessiond.h"
40 #include "ust-consumer.h"
45 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
47 /* Next available channel key. Access under next_channel_key_lock. */
48 static uint64_t _next_channel_key
;
49 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 /* Next available session ID. Access under next_session_id_lock. */
52 static uint64_t _next_session_id
;
53 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
56 * Return the incremented value of next_channel_key.
58 static uint64_t get_next_channel_key(void)
62 pthread_mutex_lock(&next_channel_key_lock
);
63 ret
= ++_next_channel_key
;
64 pthread_mutex_unlock(&next_channel_key_lock
);
69 * Return the atomically incremented value of next_session_id.
71 static uint64_t get_next_session_id(void)
75 pthread_mutex_lock(&next_session_id_lock
);
76 ret
= ++_next_session_id
;
77 pthread_mutex_unlock(&next_session_id_lock
);
81 static void copy_channel_attr_to_ustctl(
82 struct ustctl_consumer_channel_attr
*attr
,
83 struct lttng_ust_channel_attr
*uattr
)
85 /* Copy event attributes since the layout is different. */
86 attr
->subbuf_size
= uattr
->subbuf_size
;
87 attr
->num_subbuf
= uattr
->num_subbuf
;
88 attr
->overwrite
= uattr
->overwrite
;
89 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
90 attr
->read_timer_interval
= uattr
->read_timer_interval
;
91 attr
->output
= uattr
->output
;
95 * Match function for the hash table lookup.
97 * It matches an ust app event based on three attributes which are the event
98 * name, the filter bytecode and the loglevel.
100 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
102 struct ust_app_event
*event
;
103 const struct ust_app_ht_key
*key
;
108 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
111 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
114 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
118 /* Event loglevel. */
119 if (event
->attr
.loglevel
!= key
->loglevel
) {
120 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
121 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
123 * Match is accepted. This is because on event creation, the
124 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
125 * -1 are accepted for this loglevel type since 0 is the one set by
126 * the API when receiving an enable event.
133 /* One of the filters is NULL, fail. */
134 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
138 if (key
->filter
&& event
->filter
) {
139 /* Both filters exists, check length followed by the bytecode. */
140 if (event
->filter
->len
!= key
->filter
->len
||
141 memcmp(event
->filter
->data
, key
->filter
->data
,
142 event
->filter
->len
) != 0) {
147 /* One of the exclusions is NULL, fail. */
148 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
152 if (key
->exclusion
&& event
->exclusion
) {
153 /* Both exclusions exists, check count followed by the names. */
154 if (event
->exclusion
->count
!= key
->exclusion
->count
||
155 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
156 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
170 * Unique add of an ust app event in the given ht. This uses the custom
171 * ht_match_ust_app_event match function and the event name as hash.
173 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
174 struct ust_app_event
*event
)
176 struct cds_lfht_node
*node_ptr
;
177 struct ust_app_ht_key key
;
181 assert(ua_chan
->events
);
184 ht
= ua_chan
->events
;
185 key
.name
= event
->attr
.name
;
186 key
.filter
= event
->filter
;
187 key
.loglevel
= event
->attr
.loglevel
;
188 key
.exclusion
= event
->exclusion
;
190 node_ptr
= cds_lfht_add_unique(ht
->ht
,
191 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
192 ht_match_ust_app_event
, &key
, &event
->node
.node
);
193 assert(node_ptr
== &event
->node
.node
);
197 * Close the notify socket from the given RCU head object. This MUST be called
198 * through a call_rcu().
200 static void close_notify_sock_rcu(struct rcu_head
*head
)
203 struct ust_app_notify_sock_obj
*obj
=
204 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
206 /* Must have a valid fd here. */
207 assert(obj
->fd
>= 0);
209 ret
= close(obj
->fd
);
211 ERR("close notify sock %d RCU", obj
->fd
);
213 lttng_fd_put(LTTNG_FD_APPS
, 1);
219 * Return the session registry according to the buffer type of the given
222 * A registry per UID object MUST exists before calling this function or else
223 * it assert() if not found. RCU read side lock must be acquired.
225 static struct ust_registry_session
*get_session_registry(
226 struct ust_app_session
*ua_sess
)
228 struct ust_registry_session
*registry
= NULL
;
232 switch (ua_sess
->buffer_type
) {
233 case LTTNG_BUFFER_PER_PID
:
235 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
239 registry
= reg_pid
->registry
->reg
.ust
;
242 case LTTNG_BUFFER_PER_UID
:
244 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
245 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
249 registry
= reg_uid
->registry
->reg
.ust
;
261 * Delete ust context safely. RCU read lock must be held before calling
265 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
272 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
273 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
274 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
275 sock
, ua_ctx
->obj
->handle
, ret
);
283 * Delete ust app event safely. RCU read lock must be held before calling
287 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
293 free(ua_event
->filter
);
294 if (ua_event
->exclusion
!= NULL
)
295 free(ua_event
->exclusion
);
296 if (ua_event
->obj
!= NULL
) {
297 ret
= ustctl_release_object(sock
, ua_event
->obj
);
298 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
299 ERR("UST app sock %d release event obj failed with ret %d",
308 * Release ust data object of the given stream.
310 * Return 0 on success or else a negative value.
312 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 ret
= ustctl_release_object(sock
, stream
->obj
);
320 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
321 ERR("UST app sock %d release stream obj failed with ret %d",
324 lttng_fd_put(LTTNG_FD_APPS
, 2);
332 * Delete ust app stream safely. RCU read lock must be held before calling
336 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
340 (void) release_ust_app_stream(sock
, stream
);
345 * We need to execute ht_destroy outside of RCU read-side critical
346 * section and outside of call_rcu thread, so we postpone its execution
347 * using ht_cleanup_push. It is simpler than to change the semantic of
348 * the many callers of delete_ust_app_session().
351 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
353 struct ust_app_channel
*ua_chan
=
354 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
356 ht_cleanup_push(ua_chan
->ctx
);
357 ht_cleanup_push(ua_chan
->events
);
362 * Delete ust app channel safely. RCU read lock must be held before calling
366 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
370 struct lttng_ht_iter iter
;
371 struct ust_app_event
*ua_event
;
372 struct ust_app_ctx
*ua_ctx
;
373 struct ust_app_stream
*stream
, *stmp
;
374 struct ust_registry_session
*registry
;
378 DBG3("UST app deleting channel %s", ua_chan
->name
);
381 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
382 cds_list_del(&stream
->list
);
383 delete_ust_app_stream(sock
, stream
);
387 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
388 cds_list_del(&ua_ctx
->list
);
389 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
391 delete_ust_app_ctx(sock
, ua_ctx
);
395 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
397 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
399 delete_ust_app_event(sock
, ua_event
);
402 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
403 /* Wipe and free registry from session registry. */
404 registry
= get_session_registry(ua_chan
->session
);
406 ust_registry_channel_del_free(registry
, ua_chan
->key
);
410 if (ua_chan
->obj
!= NULL
) {
411 /* Remove channel from application UST object descriptor. */
412 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
413 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
415 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
416 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
417 ERR("UST app sock %d release channel obj failed with ret %d",
420 lttng_fd_put(LTTNG_FD_APPS
, 1);
423 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
427 * Push metadata to consumer socket.
429 * The socket lock MUST be acquired.
430 * The ust app session lock MUST be acquired.
432 * On success, return the len of metadata pushed or else a negative value.
434 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
435 struct consumer_socket
*socket
, int send_zero_data
)
438 char *metadata_str
= NULL
;
445 pthread_mutex_lock(®istry
->lock
);
448 * Means that no metadata was assigned to the session. This can happens if
449 * no start has been done previously.
451 if (!registry
->metadata_key
) {
452 pthread_mutex_unlock(®istry
->lock
);
457 * On a push metadata error either the consumer is dead or the metadata
458 * channel has been destroyed because its endpoint might have died (e.g:
459 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
460 * metadata again which is not valid anymore on the consumer side.
462 if (registry
->metadata_closed
) {
463 pthread_mutex_unlock(®istry
->lock
);
467 offset
= registry
->metadata_len_sent
;
468 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
470 DBG3("No metadata to push for metadata key %" PRIu64
,
471 registry
->metadata_key
);
473 if (send_zero_data
) {
474 DBG("No metadata to push");
480 /* Allocate only what we have to send. */
481 metadata_str
= zmalloc(len
);
483 PERROR("zmalloc ust app metadata string");
487 /* Copy what we haven't send out. */
488 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
489 registry
->metadata_len_sent
+= len
;
492 pthread_mutex_unlock(®istry
->lock
);
493 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
494 metadata_str
, len
, offset
);
497 * There is an acceptable race here between the registry metadata key
498 * assignment and the creation on the consumer. The session daemon can
499 * concurrently push metadata for this registry while being created on
500 * the consumer since the metadata key of the registry is assigned
501 * *before* it is setup to avoid the consumer to ask for metadata that
502 * could possibly be not found in the session daemon.
504 * The metadata will get pushed either by the session being stopped or
505 * the consumer requesting metadata if that race is triggered.
507 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
511 /* Update back the actual metadata len sent since it failed here. */
512 pthread_mutex_lock(®istry
->lock
);
513 registry
->metadata_len_sent
-= len
;
514 pthread_mutex_unlock(®istry
->lock
);
526 * On error, flag the registry that the metadata is closed. We were unable
527 * to push anything and this means that either the consumer is not
528 * responding or the metadata cache has been destroyed on the consumer.
530 registry
->metadata_closed
= 1;
532 pthread_mutex_unlock(®istry
->lock
);
539 * For a given application and session, push metadata to consumer.
540 * Either sock or consumer is required : if sock is NULL, the default
541 * socket to send the metadata is retrieved from consumer, if sock
542 * is not NULL we use it to send the metadata.
543 * RCU read-side lock must be held while calling this function,
544 * therefore ensuring existance of registry.
546 * Return 0 on success else a negative error.
548 static int push_metadata(struct ust_registry_session
*registry
,
549 struct consumer_output
*consumer
)
553 struct consumer_socket
*socket
;
558 pthread_mutex_lock(®istry
->lock
);
560 if (registry
->metadata_closed
) {
561 pthread_mutex_unlock(®istry
->lock
);
565 /* Get consumer socket to use to push the metadata.*/
566 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
568 pthread_mutex_unlock(®istry
->lock
);
575 * TODO: Currently, we hold the socket lock around sampling of the next
576 * metadata segment to ensure we send metadata over the consumer socket in
577 * the correct order. This makes the registry lock nest inside the socket
580 * Please note that this is a temporary measure: we should move this lock
581 * back into ust_consumer_push_metadata() when the consumer gets the
582 * ability to reorder the metadata it receives.
584 pthread_mutex_lock(socket
->lock
);
585 ret
= ust_app_push_metadata(registry
, socket
, 0);
586 pthread_mutex_unlock(socket
->lock
);
600 * Send to the consumer a close metadata command for the given session. Once
601 * done, the metadata channel is deleted and the session metadata pointer is
602 * nullified. The session lock MUST be acquired here unless the application is
603 * in the destroy path.
605 * Return 0 on success else a negative value.
607 static int close_metadata(struct ust_registry_session
*registry
,
608 struct consumer_output
*consumer
)
611 struct consumer_socket
*socket
;
618 pthread_mutex_lock(®istry
->lock
);
620 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
625 /* Get consumer socket to use to push the metadata.*/
626 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
633 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
640 * Metadata closed. Even on error this means that the consumer is not
641 * responding or not found so either way a second close should NOT be emit
644 registry
->metadata_closed
= 1;
646 pthread_mutex_unlock(®istry
->lock
);
652 * We need to execute ht_destroy outside of RCU read-side critical
653 * section and outside of call_rcu thread, so we postpone its execution
654 * using ht_cleanup_push. It is simpler than to change the semantic of
655 * the many callers of delete_ust_app_session().
658 void delete_ust_app_session_rcu(struct rcu_head
*head
)
660 struct ust_app_session
*ua_sess
=
661 caa_container_of(head
, struct ust_app_session
, rcu_head
);
663 ht_cleanup_push(ua_sess
->channels
);
668 * Delete ust app session safely. RCU read lock must be held before calling
672 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
676 struct lttng_ht_iter iter
;
677 struct ust_app_channel
*ua_chan
;
678 struct ust_registry_session
*registry
;
682 pthread_mutex_lock(&ua_sess
->lock
);
684 registry
= get_session_registry(ua_sess
);
686 /* Push metadata for application before freeing the application. */
687 (void) push_metadata(registry
, ua_sess
->consumer
);
690 * Don't ask to close metadata for global per UID buffers. Close
691 * metadata only on destroy trace session in this case. Also, the
692 * previous push metadata could have flag the metadata registry to
693 * close so don't send a close command if closed.
695 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
696 /* And ask to close it for this session registry. */
697 (void) close_metadata(registry
, ua_sess
->consumer
);
701 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
703 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
705 delete_ust_app_channel(sock
, ua_chan
, app
);
708 /* In case of per PID, the registry is kept in the session. */
709 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
710 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
712 buffer_reg_pid_remove(reg_pid
);
713 buffer_reg_pid_destroy(reg_pid
);
717 if (ua_sess
->handle
!= -1) {
718 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
719 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
720 ERR("UST app sock %d release session handle failed with ret %d",
724 pthread_mutex_unlock(&ua_sess
->lock
);
726 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
730 * Delete a traceable application structure from the global list. Never call
731 * this function outside of a call_rcu call.
733 * RCU read side lock should _NOT_ be held when calling this function.
736 void delete_ust_app(struct ust_app
*app
)
739 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
741 /* Delete ust app sessions info */
746 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
748 /* Free every object in the session and the session. */
750 delete_ust_app_session(sock
, ua_sess
, app
);
754 ht_cleanup_push(app
->sessions
);
755 ht_cleanup_push(app
->ust_objd
);
758 * Wait until we have deleted the application from the sock hash table
759 * before closing this socket, otherwise an application could re-use the
760 * socket ID and race with the teardown, using the same hash table entry.
762 * It's OK to leave the close in call_rcu. We want it to stay unique for
763 * all RCU readers that could run concurrently with unregister app,
764 * therefore we _need_ to only close that socket after a grace period. So
765 * it should stay in this RCU callback.
767 * This close() is a very important step of the synchronization model so
768 * every modification to this function must be carefully reviewed.
774 lttng_fd_put(LTTNG_FD_APPS
, 1);
776 DBG2("UST app pid %d deleted", app
->pid
);
781 * URCU intermediate call to delete an UST app.
784 void delete_ust_app_rcu(struct rcu_head
*head
)
786 struct lttng_ht_node_ulong
*node
=
787 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
788 struct ust_app
*app
=
789 caa_container_of(node
, struct ust_app
, pid_n
);
791 DBG3("Call RCU deleting app PID %d", app
->pid
);
796 * Delete the session from the application ht and delete the data structure by
797 * freeing every object inside and releasing them.
799 static void destroy_app_session(struct ust_app
*app
,
800 struct ust_app_session
*ua_sess
)
803 struct lttng_ht_iter iter
;
808 iter
.iter
.node
= &ua_sess
->node
.node
;
809 ret
= lttng_ht_del(app
->sessions
, &iter
);
811 /* Already scheduled for teardown. */
815 /* Once deleted, free the data structure. */
816 delete_ust_app_session(app
->sock
, ua_sess
, app
);
823 * Alloc new UST app session.
826 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
828 struct ust_app_session
*ua_sess
;
830 /* Init most of the default value by allocating and zeroing */
831 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
832 if (ua_sess
== NULL
) {
837 ua_sess
->handle
= -1;
838 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
839 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
840 pthread_mutex_init(&ua_sess
->lock
, NULL
);
849 * Alloc new UST app channel.
852 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
853 struct ust_app_session
*ua_sess
,
854 struct lttng_ust_channel_attr
*attr
)
856 struct ust_app_channel
*ua_chan
;
858 /* Init most of the default value by allocating and zeroing */
859 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
860 if (ua_chan
== NULL
) {
865 /* Setup channel name */
866 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
867 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
869 ua_chan
->enabled
= 1;
870 ua_chan
->handle
= -1;
871 ua_chan
->session
= ua_sess
;
872 ua_chan
->key
= get_next_channel_key();
873 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
874 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
875 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
877 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
878 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
880 /* Copy attributes */
882 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
883 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
884 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
885 ua_chan
->attr
.overwrite
= attr
->overwrite
;
886 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
887 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
888 ua_chan
->attr
.output
= attr
->output
;
890 /* By default, the channel is a per cpu channel. */
891 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
893 DBG3("UST app channel %s allocated", ua_chan
->name
);
902 * Allocate and initialize a UST app stream.
904 * Return newly allocated stream pointer or NULL on error.
906 struct ust_app_stream
*ust_app_alloc_stream(void)
908 struct ust_app_stream
*stream
= NULL
;
910 stream
= zmalloc(sizeof(*stream
));
911 if (stream
== NULL
) {
912 PERROR("zmalloc ust app stream");
916 /* Zero could be a valid value for a handle so flag it to -1. */
924 * Alloc new UST app event.
927 struct ust_app_event
*alloc_ust_app_event(char *name
,
928 struct lttng_ust_event
*attr
)
930 struct ust_app_event
*ua_event
;
932 /* Init most of the default value by allocating and zeroing */
933 ua_event
= zmalloc(sizeof(struct ust_app_event
));
934 if (ua_event
== NULL
) {
939 ua_event
->enabled
= 1;
940 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
941 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
942 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
944 /* Copy attributes */
946 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
949 DBG3("UST app event %s allocated", ua_event
->name
);
958 * Alloc new UST app context.
961 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
963 struct ust_app_ctx
*ua_ctx
;
965 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
966 if (ua_ctx
== NULL
) {
970 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
973 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
976 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
983 * Allocate a filter and copy the given original filter.
985 * Return allocated filter or NULL on error.
987 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
988 struct lttng_ust_filter_bytecode
*orig_f
)
990 struct lttng_ust_filter_bytecode
*filter
= NULL
;
992 /* Copy filter bytecode */
993 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
995 PERROR("zmalloc alloc ust app filter");
999 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1006 * Find an ust_app using the sock and return it. RCU read side lock must be
1007 * held before calling this helper function.
1009 struct ust_app
*ust_app_find_by_sock(int sock
)
1011 struct lttng_ht_node_ulong
*node
;
1012 struct lttng_ht_iter iter
;
1014 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1015 node
= lttng_ht_iter_get_node_ulong(&iter
);
1017 DBG2("UST app find by sock %d not found", sock
);
1021 return caa_container_of(node
, struct ust_app
, sock_n
);
1028 * Find an ust_app using the notify sock and return it. RCU read side lock must
1029 * be held before calling this helper function.
1031 static struct ust_app
*find_app_by_notify_sock(int sock
)
1033 struct lttng_ht_node_ulong
*node
;
1034 struct lttng_ht_iter iter
;
1036 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1038 node
= lttng_ht_iter_get_node_ulong(&iter
);
1040 DBG2("UST app find by notify sock %d not found", sock
);
1044 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1051 * Lookup for an ust app event based on event name, filter bytecode and the
1054 * Return an ust_app_event object or NULL on error.
1056 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1057 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1058 const struct lttng_event_exclusion
*exclusion
)
1060 struct lttng_ht_iter iter
;
1061 struct lttng_ht_node_str
*node
;
1062 struct ust_app_event
*event
= NULL
;
1063 struct ust_app_ht_key key
;
1068 /* Setup key for event lookup. */
1070 key
.filter
= filter
;
1071 key
.loglevel
= loglevel
;
1072 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1073 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1075 /* Lookup using the event name as hash and a custom match fct. */
1076 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1077 ht_match_ust_app_event
, &key
, &iter
.iter
);
1078 node
= lttng_ht_iter_get_node_str(&iter
);
1083 event
= caa_container_of(node
, struct ust_app_event
, node
);
1090 * Create the channel context on the tracer.
1092 * Called with UST app session lock held.
1095 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1096 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1100 health_code_update();
1102 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1103 ua_chan
->obj
, &ua_ctx
->obj
);
1105 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1106 ERR("UST app create channel context failed for app (pid: %d) "
1107 "with ret %d", app
->pid
, ret
);
1110 * This is normal behavior, an application can die during the
1111 * creation process. Don't report an error so the execution can
1112 * continue normally.
1115 DBG3("UST app disable event failed. Application is dead.");
1120 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1122 DBG2("UST app context handle %d created successfully for channel %s",
1123 ua_ctx
->handle
, ua_chan
->name
);
1126 health_code_update();
1131 * Set the filter on the tracer.
1134 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1135 struct ust_app
*app
)
1139 health_code_update();
1141 if (!ua_event
->filter
) {
1146 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1149 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1150 ERR("UST app event %s filter failed for app (pid: %d) "
1151 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1154 * This is normal behavior, an application can die during the
1155 * creation process. Don't report an error so the execution can
1156 * continue normally.
1159 DBG3("UST app filter event failed. Application is dead.");
1164 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1167 health_code_update();
1172 * Set event exclusions on the tracer.
1175 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1176 struct ust_app
*app
)
1180 health_code_update();
1182 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1187 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1190 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1191 ERR("UST app event %s exclusions failed for app (pid: %d) "
1192 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1195 * This is normal behavior, an application can die during the
1196 * creation process. Don't report an error so the execution can
1197 * continue normally.
1200 DBG3("UST app event exclusion failed. Application is dead.");
1205 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1208 health_code_update();
1213 * Disable the specified event on to UST tracer for the UST session.
1215 static int disable_ust_event(struct ust_app
*app
,
1216 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1220 health_code_update();
1222 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1224 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1225 ERR("UST app event %s disable failed for app (pid: %d) "
1226 "and session handle %d with ret %d",
1227 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1230 * This is normal behavior, an application can die during the
1231 * creation process. Don't report an error so the execution can
1232 * continue normally.
1235 DBG3("UST app disable event failed. Application is dead.");
1240 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1241 ua_event
->attr
.name
, app
->pid
);
1244 health_code_update();
1249 * Disable the specified channel on to UST tracer for the UST session.
1251 static int disable_ust_channel(struct ust_app
*app
,
1252 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1256 health_code_update();
1258 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1260 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1261 ERR("UST app channel %s disable failed for app (pid: %d) "
1262 "and session handle %d with ret %d",
1263 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1266 * This is normal behavior, an application can die during the
1267 * creation process. Don't report an error so the execution can
1268 * continue normally.
1271 DBG3("UST app disable channel failed. Application is dead.");
1276 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1277 ua_chan
->name
, app
->pid
);
1280 health_code_update();
1285 * Enable the specified channel on to UST tracer for the UST session.
1287 static int enable_ust_channel(struct ust_app
*app
,
1288 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1292 health_code_update();
1294 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1296 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1297 ERR("UST app channel %s enable failed for app (pid: %d) "
1298 "and session handle %d with ret %d",
1299 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1302 * This is normal behavior, an application can die during the
1303 * creation process. Don't report an error so the execution can
1304 * continue normally.
1307 DBG3("UST app enable channel failed. Application is dead.");
1312 ua_chan
->enabled
= 1;
1314 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1315 ua_chan
->name
, app
->pid
);
1318 health_code_update();
1323 * Enable the specified event on to UST tracer for the UST session.
1325 static int enable_ust_event(struct ust_app
*app
,
1326 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1330 health_code_update();
1332 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1334 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1335 ERR("UST app event %s enable failed for app (pid: %d) "
1336 "and session handle %d with ret %d",
1337 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1340 * This is normal behavior, an application can die during the
1341 * creation process. Don't report an error so the execution can
1342 * continue normally.
1345 DBG3("UST app enable event failed. Application is dead.");
1350 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1351 ua_event
->attr
.name
, app
->pid
);
1354 health_code_update();
1359 * Send channel and stream buffer to application.
1361 * Return 0 on success. On error, a negative value is returned.
1363 static int send_channel_pid_to_ust(struct ust_app
*app
,
1364 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1367 struct ust_app_stream
*stream
, *stmp
;
1373 health_code_update();
1375 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1378 /* Send channel to the application. */
1379 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1384 health_code_update();
1386 /* Send all streams to application. */
1387 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1388 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1392 /* We don't need the stream anymore once sent to the tracer. */
1393 cds_list_del(&stream
->list
);
1394 delete_ust_app_stream(-1, stream
);
1396 /* Flag the channel that it is sent to the application. */
1397 ua_chan
->is_sent
= 1;
1400 health_code_update();
1405 * Create the specified event onto the UST tracer for a UST session.
1407 * Should be called with session mutex held.
1410 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1411 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1415 health_code_update();
1417 /* Create UST event on tracer */
1418 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1421 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1422 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1423 ua_event
->attr
.name
, app
->pid
, ret
);
1426 * This is normal behavior, an application can die during the
1427 * creation process. Don't report an error so the execution can
1428 * continue normally.
1431 DBG3("UST app create event failed. Application is dead.");
1436 ua_event
->handle
= ua_event
->obj
->handle
;
1438 DBG2("UST app event %s created successfully for pid:%d",
1439 ua_event
->attr
.name
, app
->pid
);
1441 health_code_update();
1443 /* Set filter if one is present. */
1444 if (ua_event
->filter
) {
1445 ret
= set_ust_event_filter(ua_event
, app
);
1451 /* Set exclusions for the event */
1452 if (ua_event
->exclusion
) {
1453 ret
= set_ust_event_exclusion(ua_event
, app
);
1459 /* If event not enabled, disable it on the tracer */
1460 if (ua_event
->enabled
) {
1462 * We now need to explicitly enable the event, since it
1463 * is now disabled at creation.
1465 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1468 * If we hit an EPERM, something is wrong with our enable call. If
1469 * we get an EEXIST, there is a problem on the tracer side since we
1473 case -LTTNG_UST_ERR_PERM
:
1474 /* Code flow problem */
1476 case -LTTNG_UST_ERR_EXIST
:
1477 /* It's OK for our use case. */
1488 health_code_update();
1493 * Copy data between an UST app event and a LTT event.
1495 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1496 struct ltt_ust_event
*uevent
)
1498 size_t exclusion_alloc_size
;
1500 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1501 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1503 ua_event
->enabled
= uevent
->enabled
;
1505 /* Copy event attributes */
1506 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1508 /* Copy filter bytecode */
1509 if (uevent
->filter
) {
1510 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1511 /* Filter might be NULL here in case of ENONEM. */
1514 /* Copy exclusion data */
1515 if (uevent
->exclusion
) {
1516 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1517 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1518 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1519 if (ua_event
->exclusion
== NULL
) {
1522 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1523 exclusion_alloc_size
);
1529 * Copy data between an UST app channel and a LTT channel.
1531 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1532 struct ltt_ust_channel
*uchan
)
1534 struct lttng_ht_iter iter
;
1535 struct ltt_ust_event
*uevent
;
1536 struct ltt_ust_context
*uctx
;
1537 struct ust_app_event
*ua_event
;
1538 struct ust_app_ctx
*ua_ctx
;
1540 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1542 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1543 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1545 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1546 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1548 /* Copy event attributes since the layout is different. */
1549 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1550 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1551 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1552 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1553 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1554 ua_chan
->attr
.output
= uchan
->attr
.output
;
1556 * Note that the attribute channel type is not set since the channel on the
1557 * tracing registry side does not have this information.
1560 ua_chan
->enabled
= uchan
->enabled
;
1561 ua_chan
->tracing_channel_id
= uchan
->id
;
1563 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1564 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1565 if (ua_ctx
== NULL
) {
1568 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1569 (unsigned long) ua_ctx
->ctx
.ctx
);
1570 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1571 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1574 /* Copy all events from ltt ust channel to ust app channel */
1575 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1576 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1577 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1578 if (ua_event
== NULL
) {
1579 DBG2("UST event %s not found on shadow copy channel",
1581 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1582 if (ua_event
== NULL
) {
1585 shadow_copy_event(ua_event
, uevent
);
1586 add_unique_ust_app_event(ua_chan
, ua_event
);
1590 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1594 * Copy data between a UST app session and a regular LTT session.
1596 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1597 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1599 struct lttng_ht_node_str
*ua_chan_node
;
1600 struct lttng_ht_iter iter
;
1601 struct ltt_ust_channel
*uchan
;
1602 struct ust_app_channel
*ua_chan
;
1604 struct tm
*timeinfo
;
1608 /* Get date and time for unique app path */
1610 timeinfo
= localtime(&rawtime
);
1611 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1613 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1615 ua_sess
->tracing_id
= usess
->id
;
1616 ua_sess
->id
= get_next_session_id();
1617 ua_sess
->uid
= app
->uid
;
1618 ua_sess
->gid
= app
->gid
;
1619 ua_sess
->euid
= usess
->uid
;
1620 ua_sess
->egid
= usess
->gid
;
1621 ua_sess
->buffer_type
= usess
->buffer_type
;
1622 ua_sess
->bits_per_long
= app
->bits_per_long
;
1623 /* There is only one consumer object per session possible. */
1624 ua_sess
->consumer
= usess
->consumer
;
1625 ua_sess
->output_traces
= usess
->output_traces
;
1626 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1627 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1628 &usess
->metadata_attr
);
1630 switch (ua_sess
->buffer_type
) {
1631 case LTTNG_BUFFER_PER_PID
:
1632 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1633 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1636 case LTTNG_BUFFER_PER_UID
:
1637 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1638 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1645 PERROR("asprintf UST shadow copy session");
1650 /* Iterate over all channels in global domain. */
1651 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1653 struct lttng_ht_iter uiter
;
1655 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1656 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1657 if (ua_chan_node
!= NULL
) {
1658 /* Session exist. Contiuing. */
1662 DBG2("Channel %s not found on shadow session copy, creating it",
1664 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1665 if (ua_chan
== NULL
) {
1666 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1669 shadow_copy_channel(ua_chan
, uchan
);
1671 * The concept of metadata channel does not exist on the tracing
1672 * registry side of the session daemon so this can only be a per CPU
1673 * channel and not metadata.
1675 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1677 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1685 * Lookup sesison wrapper.
1688 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1689 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1691 /* Get right UST app session from app */
1692 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1696 * Return ust app session from the app session hashtable using the UST session
1699 static struct ust_app_session
*lookup_session_by_app(
1700 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1702 struct lttng_ht_iter iter
;
1703 struct lttng_ht_node_u64
*node
;
1705 __lookup_session_by_app(usess
, app
, &iter
);
1706 node
= lttng_ht_iter_get_node_u64(&iter
);
1711 return caa_container_of(node
, struct ust_app_session
, node
);
1718 * Setup buffer registry per PID for the given session and application. If none
1719 * is found, a new one is created, added to the global registry and
1720 * initialized. If regp is valid, it's set with the newly created object.
1722 * Return 0 on success or else a negative value.
1724 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1725 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1728 struct buffer_reg_pid
*reg_pid
;
1735 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1738 * This is the create channel path meaning that if there is NO
1739 * registry available, we have to create one for this session.
1741 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1749 /* Initialize registry. */
1750 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1751 app
->bits_per_long
, app
->uint8_t_alignment
,
1752 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1753 app
->uint64_t_alignment
, app
->long_alignment
,
1754 app
->byte_order
, app
->version
.major
,
1755 app
->version
.minor
);
1758 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1759 * destroy the buffer registry, because it is always expected
1760 * that if the buffer registry can be found, its ust registry is
1763 buffer_reg_pid_destroy(reg_pid
);
1767 buffer_reg_pid_add(reg_pid
);
1769 DBG3("UST app buffer registry per PID created successfully");
1781 * Setup buffer registry per UID for the given session and application. If none
1782 * is found, a new one is created, added to the global registry and
1783 * initialized. If regp is valid, it's set with the newly created object.
1785 * Return 0 on success or else a negative value.
1787 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1788 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1791 struct buffer_reg_uid
*reg_uid
;
1798 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1801 * This is the create channel path meaning that if there is NO
1802 * registry available, we have to create one for this session.
1804 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1805 LTTNG_DOMAIN_UST
, ®_uid
);
1813 /* Initialize registry. */
1814 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1815 app
->bits_per_long
, app
->uint8_t_alignment
,
1816 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1817 app
->uint64_t_alignment
, app
->long_alignment
,
1818 app
->byte_order
, app
->version
.major
,
1819 app
->version
.minor
);
1822 * reg_uid->registry->reg.ust is NULL upon error, so we need to
1823 * destroy the buffer registry, because it is always expected
1824 * that if the buffer registry can be found, its ust registry is
1827 buffer_reg_uid_destroy(reg_uid
, NULL
);
1830 /* Add node to teardown list of the session. */
1831 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1833 buffer_reg_uid_add(reg_uid
);
1835 DBG3("UST app buffer registry per UID created successfully");
1846 * Create a session on the tracer side for the given app.
1848 * On success, ua_sess_ptr is populated with the session pointer or else left
1849 * untouched. If the session was created, is_created is set to 1. On error,
1850 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1853 * Returns 0 on success or else a negative code which is either -ENOMEM or
1854 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1856 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1857 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1860 int ret
, created
= 0;
1861 struct ust_app_session
*ua_sess
;
1865 assert(ua_sess_ptr
);
1867 health_code_update();
1869 ua_sess
= lookup_session_by_app(usess
, app
);
1870 if (ua_sess
== NULL
) {
1871 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1872 app
->pid
, usess
->id
);
1873 ua_sess
= alloc_ust_app_session(app
);
1874 if (ua_sess
== NULL
) {
1875 /* Only malloc can failed so something is really wrong */
1879 shadow_copy_session(ua_sess
, usess
, app
);
1883 switch (usess
->buffer_type
) {
1884 case LTTNG_BUFFER_PER_PID
:
1885 /* Init local registry. */
1886 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1888 delete_ust_app_session(-1, ua_sess
, app
);
1892 case LTTNG_BUFFER_PER_UID
:
1893 /* Look for a global registry. If none exists, create one. */
1894 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1896 delete_ust_app_session(-1, ua_sess
, app
);
1906 health_code_update();
1908 if (ua_sess
->handle
== -1) {
1909 ret
= ustctl_create_session(app
->sock
);
1911 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1912 ERR("Creating session for app pid %d with ret %d",
1915 DBG("UST app creating session failed. Application is dead");
1917 * This is normal behavior, an application can die during the
1918 * creation process. Don't report an error so the execution can
1919 * continue normally. This will get flagged ENOTCONN and the
1920 * caller will handle it.
1924 delete_ust_app_session(-1, ua_sess
, app
);
1925 if (ret
!= -ENOMEM
) {
1927 * Tracer is probably gone or got an internal error so let's
1928 * behave like it will soon unregister or not usable.
1935 ua_sess
->handle
= ret
;
1937 /* Add ust app session to app's HT */
1938 lttng_ht_node_init_u64(&ua_sess
->node
,
1939 ua_sess
->tracing_id
);
1940 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1942 DBG2("UST app session created successfully with handle %d", ret
);
1945 *ua_sess_ptr
= ua_sess
;
1947 *is_created
= created
;
1950 /* Everything went well. */
1954 health_code_update();
1959 * Match function for a hash table lookup of ust_app_ctx.
1961 * It matches an ust app context based on the context type and, in the case
1962 * of perf counters, their name.
1964 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
1966 struct ust_app_ctx
*ctx
;
1967 const struct lttng_ust_context
*key
;
1972 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
1976 if (ctx
->ctx
.ctx
!= key
->ctx
) {
1980 /* Check the name in the case of perf thread counters. */
1981 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
1982 if (strncmp(key
->u
.perf_counter
.name
,
1983 ctx
->ctx
.u
.perf_counter
.name
,
1984 sizeof(key
->u
.perf_counter
.name
))) {
1997 * Lookup for an ust app context from an lttng_ust_context.
1999 * Must be called while holding RCU read side lock.
2000 * Return an ust_app_ctx object or NULL on error.
2003 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2004 struct lttng_ust_context
*uctx
)
2006 struct lttng_ht_iter iter
;
2007 struct lttng_ht_node_ulong
*node
;
2008 struct ust_app_ctx
*app_ctx
= NULL
;
2013 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2014 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2015 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2016 node
= lttng_ht_iter_get_node_ulong(&iter
);
2021 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2028 * Create a context for the channel on the tracer.
2030 * Called with UST app session lock held and a RCU read side lock.
2033 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2034 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2035 struct ust_app
*app
)
2038 struct ust_app_ctx
*ua_ctx
;
2040 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2042 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2048 ua_ctx
= alloc_ust_app_ctx(uctx
);
2049 if (ua_ctx
== NULL
) {
2055 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2056 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2057 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2059 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2069 * Enable on the tracer side a ust app event for the session and channel.
2071 * Called with UST app session lock held.
2074 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2075 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2079 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2084 ua_event
->enabled
= 1;
2091 * Disable on the tracer side a ust app event for the session and channel.
2093 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2094 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2098 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2103 ua_event
->enabled
= 0;
2110 * Lookup ust app channel for session and disable it on the tracer side.
2113 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2114 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2118 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2123 ua_chan
->enabled
= 0;
2130 * Lookup ust app channel for session and enable it on the tracer side. This
2131 * MUST be called with a RCU read side lock acquired.
2133 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2134 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2137 struct lttng_ht_iter iter
;
2138 struct lttng_ht_node_str
*ua_chan_node
;
2139 struct ust_app_channel
*ua_chan
;
2141 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2142 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2143 if (ua_chan_node
== NULL
) {
2144 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2145 uchan
->name
, ua_sess
->tracing_id
);
2149 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2151 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2161 * Ask the consumer to create a channel and get it if successful.
2163 * Return 0 on success or else a negative value.
2165 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2166 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2167 int bitness
, struct ust_registry_session
*registry
)
2170 unsigned int nb_fd
= 0;
2171 struct consumer_socket
*socket
;
2179 health_code_update();
2181 /* Get the right consumer socket for the application. */
2182 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2188 health_code_update();
2190 /* Need one fd for the channel. */
2191 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2193 ERR("Exhausted number of available FD upon create channel");
2198 * Ask consumer to create channel. The consumer will return the number of
2199 * stream we have to expect.
2201 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2208 * Compute the number of fd needed before receiving them. It must be 2 per
2209 * stream (2 being the default value here).
2211 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2213 /* Reserve the amount of file descriptor we need. */
2214 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2216 ERR("Exhausted number of available FD upon create channel");
2217 goto error_fd_get_stream
;
2220 health_code_update();
2223 * Now get the channel from the consumer. This call wil populate the stream
2224 * list of that channel and set the ust objects.
2226 if (usess
->consumer
->enabled
) {
2227 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2237 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2238 error_fd_get_stream
:
2240 * Initiate a destroy channel on the consumer since we had an error
2241 * handling it on our side. The return value is of no importance since we
2242 * already have a ret value set by the previous error that we need to
2245 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2247 lttng_fd_put(LTTNG_FD_APPS
, 1);
2249 health_code_update();
2255 * Duplicate the ust data object of the ust app stream and save it in the
2256 * buffer registry stream.
2258 * Return 0 on success or else a negative value.
2260 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2261 struct ust_app_stream
*stream
)
2268 /* Reserve the amount of file descriptor we need. */
2269 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2271 ERR("Exhausted number of available FD upon duplicate stream");
2275 /* Duplicate object for stream once the original is in the registry. */
2276 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2277 reg_stream
->obj
.ust
);
2279 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2280 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2281 lttng_fd_put(LTTNG_FD_APPS
, 2);
2284 stream
->handle
= stream
->obj
->handle
;
2291 * Duplicate the ust data object of the ust app. channel and save it in the
2292 * buffer registry channel.
2294 * Return 0 on success or else a negative value.
2296 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2297 struct ust_app_channel
*ua_chan
)
2304 /* Need two fds for the channel. */
2305 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2307 ERR("Exhausted number of available FD upon duplicate channel");
2311 /* Duplicate object for stream once the original is in the registry. */
2312 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2314 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2315 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2318 ua_chan
->handle
= ua_chan
->obj
->handle
;
2323 lttng_fd_put(LTTNG_FD_APPS
, 1);
2329 * For a given channel buffer registry, setup all streams of the given ust
2330 * application channel.
2332 * Return 0 on success or else a negative value.
2334 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2335 struct ust_app_channel
*ua_chan
)
2338 struct ust_app_stream
*stream
, *stmp
;
2343 DBG2("UST app setup buffer registry stream");
2345 /* Send all streams to application. */
2346 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2347 struct buffer_reg_stream
*reg_stream
;
2349 ret
= buffer_reg_stream_create(®_stream
);
2355 * Keep original pointer and nullify it in the stream so the delete
2356 * stream call does not release the object.
2358 reg_stream
->obj
.ust
= stream
->obj
;
2360 buffer_reg_stream_add(reg_stream
, reg_chan
);
2362 /* We don't need the streams anymore. */
2363 cds_list_del(&stream
->list
);
2364 delete_ust_app_stream(-1, stream
);
2372 * Create a buffer registry channel for the given session registry and
2373 * application channel object. If regp pointer is valid, it's set with the
2374 * created object. Important, the created object is NOT added to the session
2375 * registry hash table.
2377 * Return 0 on success else a negative value.
2379 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2380 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2383 struct buffer_reg_channel
*reg_chan
= NULL
;
2388 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2390 /* Create buffer registry channel. */
2391 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2396 reg_chan
->consumer_key
= ua_chan
->key
;
2397 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2399 /* Create and add a channel registry to session. */
2400 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2401 ua_chan
->tracing_channel_id
);
2405 buffer_reg_channel_add(reg_sess
, reg_chan
);
2414 /* Safe because the registry channel object was not added to any HT. */
2415 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2421 * Setup buffer registry channel for the given session registry and application
2422 * channel object. If regp pointer is valid, it's set with the created object.
2424 * Return 0 on success else a negative value.
2426 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2427 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2434 assert(ua_chan
->obj
);
2436 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2438 /* Setup all streams for the registry. */
2439 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2444 reg_chan
->obj
.ust
= ua_chan
->obj
;
2445 ua_chan
->obj
= NULL
;
2450 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2451 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2456 * Send buffer registry channel to the application.
2458 * Return 0 on success else a negative value.
2460 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2461 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2462 struct ust_app_channel
*ua_chan
)
2465 struct buffer_reg_stream
*reg_stream
;
2472 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2474 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2479 /* Send channel to the application. */
2480 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2485 health_code_update();
2487 /* Send all streams to application. */
2488 pthread_mutex_lock(®_chan
->stream_list_lock
);
2489 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2490 struct ust_app_stream stream
;
2492 ret
= duplicate_stream_object(reg_stream
, &stream
);
2494 goto error_stream_unlock
;
2497 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2499 (void) release_ust_app_stream(-1, &stream
);
2500 goto error_stream_unlock
;
2504 * The return value is not important here. This function will output an
2507 (void) release_ust_app_stream(-1, &stream
);
2509 ua_chan
->is_sent
= 1;
2511 error_stream_unlock
:
2512 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2518 * Create and send to the application the created buffers with per UID buffers.
2520 * Return 0 on success else a negative value.
2522 static int create_channel_per_uid(struct ust_app
*app
,
2523 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2524 struct ust_app_channel
*ua_chan
)
2527 struct buffer_reg_uid
*reg_uid
;
2528 struct buffer_reg_channel
*reg_chan
;
2535 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2537 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2539 * The session creation handles the creation of this global registry
2540 * object. If none can be find, there is a code flow problem or a
2545 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2548 /* Create the buffer registry channel object. */
2549 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2551 ERR("Error creating the UST channel \"%s\" registry instance",
2558 * Create the buffers on the consumer side. This call populates the
2559 * ust app channel object with all streams and data object.
2561 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2562 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2564 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2568 * Let's remove the previously created buffer registry channel so
2569 * it's not visible anymore in the session registry.
2571 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2572 ua_chan
->tracing_channel_id
);
2573 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2574 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2579 * Setup the streams and add it to the session registry.
2581 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2583 ERR("Error setting up UST channel \"%s\"",
2590 /* Send buffers to the application. */
2591 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2594 * Don't report error to the console, since it may be
2595 * caused by application concurrently exiting.
2605 * Create and send to the application the created buffers with per PID buffers.
2607 * Return 0 on success else a negative value.
2609 static int create_channel_per_pid(struct ust_app
*app
,
2610 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2611 struct ust_app_channel
*ua_chan
)
2614 struct ust_registry_session
*registry
;
2621 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2625 registry
= get_session_registry(ua_sess
);
2628 /* Create and add a new channel registry to session. */
2629 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2631 ERR("Error creating the UST channel \"%s\" registry instance",
2636 /* Create and get channel on the consumer side. */
2637 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2638 app
->bits_per_long
, registry
);
2640 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2645 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2648 * Don't report error to the console, since it may be
2649 * caused by application concurrently exiting.
2660 * From an already allocated ust app channel, create the channel buffers if
2661 * need and send it to the application. This MUST be called with a RCU read
2662 * side lock acquired.
2664 * Return 0 on success or else a negative value.
2666 static int do_create_channel(struct ust_app
*app
,
2667 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2668 struct ust_app_channel
*ua_chan
)
2677 /* Handle buffer type before sending the channel to the application. */
2678 switch (usess
->buffer_type
) {
2679 case LTTNG_BUFFER_PER_UID
:
2681 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2687 case LTTNG_BUFFER_PER_PID
:
2689 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2701 /* Initialize ust objd object using the received handle and add it. */
2702 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2703 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2705 /* If channel is not enabled, disable it on the tracer */
2706 if (!ua_chan
->enabled
) {
2707 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2718 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2719 * newly created channel if not NULL.
2721 * Called with UST app session lock and RCU read-side lock held.
2723 * Return 0 on success or else a negative value.
2725 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2726 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2727 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2728 struct ust_app_channel
**ua_chanp
)
2731 struct lttng_ht_iter iter
;
2732 struct lttng_ht_node_str
*ua_chan_node
;
2733 struct ust_app_channel
*ua_chan
;
2735 /* Lookup channel in the ust app session */
2736 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2737 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2738 if (ua_chan_node
!= NULL
) {
2739 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2743 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2744 if (ua_chan
== NULL
) {
2745 /* Only malloc can fail here */
2749 shadow_copy_channel(ua_chan
, uchan
);
2751 /* Set channel type. */
2752 ua_chan
->attr
.type
= type
;
2754 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2759 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2762 /* Only add the channel if successful on the tracer side. */
2763 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2767 *ua_chanp
= ua_chan
;
2770 /* Everything went well. */
2774 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2780 * Create UST app event and create it on the tracer side.
2782 * Called with ust app session mutex held.
2785 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2786 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2787 struct ust_app
*app
)
2790 struct ust_app_event
*ua_event
;
2792 /* Get event node */
2793 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2794 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2795 if (ua_event
!= NULL
) {
2800 /* Does not exist so create one */
2801 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2802 if (ua_event
== NULL
) {
2803 /* Only malloc can failed so something is really wrong */
2807 shadow_copy_event(ua_event
, uevent
);
2809 /* Create it on the tracer side */
2810 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2812 /* Not found previously means that it does not exist on the tracer */
2813 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2817 add_unique_ust_app_event(ua_chan
, ua_event
);
2819 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2826 /* Valid. Calling here is already in a read side lock */
2827 delete_ust_app_event(-1, ua_event
);
2832 * Create UST metadata and open it on the tracer side.
2834 * Called with UST app session lock held and RCU read side lock.
2836 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2837 struct ust_app
*app
, struct consumer_output
*consumer
)
2840 struct ust_app_channel
*metadata
;
2841 struct consumer_socket
*socket
;
2842 struct ust_registry_session
*registry
;
2848 registry
= get_session_registry(ua_sess
);
2851 pthread_mutex_lock(®istry
->lock
);
2853 /* Metadata already exists for this registry or it was closed previously */
2854 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2859 /* Allocate UST metadata */
2860 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2862 /* malloc() failed */
2867 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2869 /* Need one fd for the channel. */
2870 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2872 ERR("Exhausted number of available FD upon create metadata");
2876 /* Get the right consumer socket for the application. */
2877 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2880 goto error_consumer
;
2884 * Keep metadata key so we can identify it on the consumer side. Assign it
2885 * to the registry *before* we ask the consumer so we avoid the race of the
2886 * consumer requesting the metadata and the ask_channel call on our side
2887 * did not returned yet.
2889 registry
->metadata_key
= metadata
->key
;
2892 * Ask the metadata channel creation to the consumer. The metadata object
2893 * will be created by the consumer and kept their. However, the stream is
2894 * never added or monitored until we do a first push metadata to the
2897 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2900 /* Nullify the metadata key so we don't try to close it later on. */
2901 registry
->metadata_key
= 0;
2902 goto error_consumer
;
2906 * The setup command will make the metadata stream be sent to the relayd,
2907 * if applicable, and the thread managing the metadatas. This is important
2908 * because after this point, if an error occurs, the only way the stream
2909 * can be deleted is to be monitored in the consumer.
2911 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2913 /* Nullify the metadata key so we don't try to close it later on. */
2914 registry
->metadata_key
= 0;
2915 goto error_consumer
;
2918 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2919 metadata
->key
, app
->pid
);
2922 lttng_fd_put(LTTNG_FD_APPS
, 1);
2923 delete_ust_app_channel(-1, metadata
, app
);
2925 pthread_mutex_unlock(®istry
->lock
);
2930 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2931 * acquired before calling this function.
2933 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2935 struct ust_app
*app
= NULL
;
2936 struct lttng_ht_node_ulong
*node
;
2937 struct lttng_ht_iter iter
;
2939 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2940 node
= lttng_ht_iter_get_node_ulong(&iter
);
2942 DBG2("UST app no found with pid %d", pid
);
2946 DBG2("Found UST app by pid %d", pid
);
2948 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2955 * Allocate and init an UST app object using the registration information and
2956 * the command socket. This is called when the command socket connects to the
2959 * The object is returned on success or else NULL.
2961 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2963 struct ust_app
*lta
= NULL
;
2968 DBG3("UST app creating application for socket %d", sock
);
2970 if ((msg
->bits_per_long
== 64 &&
2971 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2972 || (msg
->bits_per_long
== 32 &&
2973 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2974 ERR("Registration failed: application \"%s\" (pid: %d) has "
2975 "%d-bit long, but no consumerd for this size is available.\n",
2976 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2980 lta
= zmalloc(sizeof(struct ust_app
));
2986 lta
->ppid
= msg
->ppid
;
2987 lta
->uid
= msg
->uid
;
2988 lta
->gid
= msg
->gid
;
2990 lta
->bits_per_long
= msg
->bits_per_long
;
2991 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2992 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2993 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2994 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2995 lta
->long_alignment
= msg
->long_alignment
;
2996 lta
->byte_order
= msg
->byte_order
;
2998 lta
->v_major
= msg
->major
;
2999 lta
->v_minor
= msg
->minor
;
3000 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3001 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3002 lta
->notify_sock
= -1;
3004 /* Copy name and make sure it's NULL terminated. */
3005 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3006 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3009 * Before this can be called, when receiving the registration information,
3010 * the application compatibility is checked. So, at this point, the
3011 * application can work with this session daemon.
3013 lta
->compatible
= 1;
3015 lta
->pid
= msg
->pid
;
3016 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3018 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3020 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3027 * For a given application object, add it to every hash table.
3029 void ust_app_add(struct ust_app
*app
)
3032 assert(app
->notify_sock
>= 0);
3037 * On a re-registration, we want to kick out the previous registration of
3040 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3043 * The socket _should_ be unique until _we_ call close. So, a add_unique
3044 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3045 * already in the table.
3047 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3049 /* Add application to the notify socket hash table. */
3050 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3051 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3053 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3054 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3055 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3062 * Set the application version into the object.
3064 * Return 0 on success else a negative value either an errno code or a
3065 * LTTng-UST error code.
3067 int ust_app_version(struct ust_app
*app
)
3073 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3075 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3076 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3078 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3086 * Unregister app by removing it from the global traceable app list and freeing
3089 * The socket is already closed at this point so no close to sock.
3091 void ust_app_unregister(int sock
)
3093 struct ust_app
*lta
;
3094 struct lttng_ht_node_ulong
*node
;
3095 struct lttng_ht_iter ust_app_sock_iter
;
3096 struct lttng_ht_iter iter
;
3097 struct ust_app_session
*ua_sess
;
3102 /* Get the node reference for a call_rcu */
3103 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3104 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3107 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3108 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3111 * For per-PID buffers, perform "push metadata" and flush all
3112 * application streams before removing app from hash tables,
3113 * ensuring proper behavior of data_pending check.
3114 * Remove sessions so they are not visible during deletion.
3116 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3118 struct ust_registry_session
*registry
;
3120 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3122 /* The session was already removed so scheduled for teardown. */
3126 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3127 (void) ust_app_flush_app_session(lta
, ua_sess
);
3131 * Add session to list for teardown. This is safe since at this point we
3132 * are the only one using this list.
3134 pthread_mutex_lock(&ua_sess
->lock
);
3137 * Normally, this is done in the delete session process which is
3138 * executed in the call rcu below. However, upon registration we can't
3139 * afford to wait for the grace period before pushing data or else the
3140 * data pending feature can race between the unregistration and stop
3141 * command where the data pending command is sent *before* the grace
3144 * The close metadata below nullifies the metadata pointer in the
3145 * session so the delete session will NOT push/close a second time.
3147 registry
= get_session_registry(ua_sess
);
3149 /* Push metadata for application before freeing the application. */
3150 (void) push_metadata(registry
, ua_sess
->consumer
);
3153 * Don't ask to close metadata for global per UID buffers. Close
3154 * metadata only on destroy trace session in this case. Also, the
3155 * previous push metadata could have flag the metadata registry to
3156 * close so don't send a close command if closed.
3158 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3159 /* And ask to close it for this session registry. */
3160 (void) close_metadata(registry
, ua_sess
->consumer
);
3163 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3165 pthread_mutex_unlock(&ua_sess
->lock
);
3168 /* Remove application from PID hash table */
3169 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3173 * Remove application from notify hash table. The thread handling the
3174 * notify socket could have deleted the node so ignore on error because
3175 * either way it's valid. The close of that socket is handled by the other
3178 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3179 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3182 * Ignore return value since the node might have been removed before by an
3183 * add replace during app registration because the PID can be reassigned by
3186 iter
.iter
.node
= <a
->pid_n
.node
;
3187 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3189 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3194 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3201 * Fill events array with all events name of all registered apps.
3203 int ust_app_list_events(struct lttng_event
**events
)
3206 size_t nbmem
, count
= 0;
3207 struct lttng_ht_iter iter
;
3208 struct ust_app
*app
;
3209 struct lttng_event
*tmp_event
;
3211 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3212 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3213 if (tmp_event
== NULL
) {
3214 PERROR("zmalloc ust app events");
3221 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3222 struct lttng_ust_tracepoint_iter uiter
;
3224 health_code_update();
3226 if (!app
->compatible
) {
3228 * TODO: In time, we should notice the caller of this error by
3229 * telling him that this is a version error.
3233 handle
= ustctl_tracepoint_list(app
->sock
);
3235 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3236 ERR("UST app list events getting handle failed for app pid %d",
3242 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3243 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3244 /* Handle ustctl error. */
3246 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3247 ERR("UST app tp list get failed for app %d with ret %d",
3250 DBG3("UST app tp list get failed. Application is dead");
3252 * This is normal behavior, an application can die during the
3253 * creation process. Don't report an error so the execution can
3254 * continue normally. Continue normal execution.
3262 health_code_update();
3263 if (count
>= nbmem
) {
3264 /* In case the realloc fails, we free the memory */
3265 struct lttng_event
*new_tmp_event
;
3268 new_nbmem
= nbmem
<< 1;
3269 DBG2("Reallocating event list from %zu to %zu entries",
3271 new_tmp_event
= realloc(tmp_event
,
3272 new_nbmem
* sizeof(struct lttng_event
));
3273 if (new_tmp_event
== NULL
) {
3274 PERROR("realloc ust app events");
3279 /* Zero the new memory */
3280 memset(new_tmp_event
+ nbmem
, 0,
3281 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3283 tmp_event
= new_tmp_event
;
3285 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3286 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3287 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3288 tmp_event
[count
].pid
= app
->pid
;
3289 tmp_event
[count
].enabled
= -1;
3295 *events
= tmp_event
;
3297 DBG2("UST app list events done (%zu events)", count
);
3302 health_code_update();
3307 * Fill events array with all events name of all registered apps.
3309 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3312 size_t nbmem
, count
= 0;
3313 struct lttng_ht_iter iter
;
3314 struct ust_app
*app
;
3315 struct lttng_event_field
*tmp_event
;
3317 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3318 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3319 if (tmp_event
== NULL
) {
3320 PERROR("zmalloc ust app event fields");
3327 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3328 struct lttng_ust_field_iter uiter
;
3330 health_code_update();
3332 if (!app
->compatible
) {
3334 * TODO: In time, we should notice the caller of this error by
3335 * telling him that this is a version error.
3339 handle
= ustctl_tracepoint_field_list(app
->sock
);
3341 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3342 ERR("UST app list field getting handle failed for app pid %d",
3348 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3349 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3350 /* Handle ustctl error. */
3352 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3353 ERR("UST app tp list field failed for app %d with ret %d",
3356 DBG3("UST app tp list field failed. Application is dead");
3358 * This is normal behavior, an application can die during the
3359 * creation process. Don't report an error so the execution can
3360 * continue normally. Reset list and count for next app.
3368 health_code_update();
3369 if (count
>= nbmem
) {
3370 /* In case the realloc fails, we free the memory */
3371 struct lttng_event_field
*new_tmp_event
;
3374 new_nbmem
= nbmem
<< 1;
3375 DBG2("Reallocating event field list from %zu to %zu entries",
3377 new_tmp_event
= realloc(tmp_event
,
3378 new_nbmem
* sizeof(struct lttng_event_field
));
3379 if (new_tmp_event
== NULL
) {
3380 PERROR("realloc ust app event fields");
3385 /* Zero the new memory */
3386 memset(new_tmp_event
+ nbmem
, 0,
3387 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3389 tmp_event
= new_tmp_event
;
3392 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3393 /* Mapping between these enums matches 1 to 1. */
3394 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3395 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3397 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3398 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3399 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3400 tmp_event
[count
].event
.pid
= app
->pid
;
3401 tmp_event
[count
].event
.enabled
= -1;
3407 *fields
= tmp_event
;
3409 DBG2("UST app list event fields done (%zu events)", count
);
3414 health_code_update();
3419 * Free and clean all traceable apps of the global list.
3421 * Should _NOT_ be called with RCU read-side lock held.
3423 void ust_app_clean_list(void)
3426 struct ust_app
*app
;
3427 struct lttng_ht_iter iter
;
3429 DBG2("UST app cleaning registered apps hash table");
3434 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3435 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3437 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3441 /* Cleanup socket hash table */
3442 if (ust_app_ht_by_sock
) {
3443 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3445 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3450 /* Cleanup notify socket hash table */
3451 if (ust_app_ht_by_notify_sock
) {
3452 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3453 notify_sock_n
.node
) {
3454 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3460 /* Destroy is done only when the ht is empty */
3462 ht_cleanup_push(ust_app_ht
);
3464 if (ust_app_ht_by_sock
) {
3465 ht_cleanup_push(ust_app_ht_by_sock
);
3467 if (ust_app_ht_by_notify_sock
) {
3468 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3473 * Init UST app hash table.
3475 int ust_app_ht_alloc(void)
3477 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3481 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3482 if (!ust_app_ht_by_sock
) {
3485 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3486 if (!ust_app_ht_by_notify_sock
) {
3493 * For a specific UST session, disable the channel for all registered apps.
3495 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3496 struct ltt_ust_channel
*uchan
)
3499 struct lttng_ht_iter iter
;
3500 struct lttng_ht_node_str
*ua_chan_node
;
3501 struct ust_app
*app
;
3502 struct ust_app_session
*ua_sess
;
3503 struct ust_app_channel
*ua_chan
;
3505 if (usess
== NULL
|| uchan
== NULL
) {
3506 ERR("Disabling UST global channel with NULL values");
3511 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3512 uchan
->name
, usess
->id
);
3516 /* For every registered applications */
3517 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3518 struct lttng_ht_iter uiter
;
3519 if (!app
->compatible
) {
3521 * TODO: In time, we should notice the caller of this error by
3522 * telling him that this is a version error.
3526 ua_sess
= lookup_session_by_app(usess
, app
);
3527 if (ua_sess
== NULL
) {
3532 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3533 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3534 /* If the session if found for the app, the channel must be there */
3535 assert(ua_chan_node
);
3537 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3538 /* The channel must not be already disabled */
3539 assert(ua_chan
->enabled
== 1);
3541 /* Disable channel onto application */
3542 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3544 /* XXX: We might want to report this error at some point... */
3556 * For a specific UST session, enable the channel for all registered apps.
3558 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3559 struct ltt_ust_channel
*uchan
)
3562 struct lttng_ht_iter iter
;
3563 struct ust_app
*app
;
3564 struct ust_app_session
*ua_sess
;
3566 if (usess
== NULL
|| uchan
== NULL
) {
3567 ERR("Adding UST global channel to NULL values");
3572 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3573 uchan
->name
, usess
->id
);
3577 /* For every registered applications */
3578 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3579 if (!app
->compatible
) {
3581 * TODO: In time, we should notice the caller of this error by
3582 * telling him that this is a version error.
3586 ua_sess
= lookup_session_by_app(usess
, app
);
3587 if (ua_sess
== NULL
) {
3591 /* Enable channel onto application */
3592 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3594 /* XXX: We might want to report this error at some point... */
3606 * Disable an event in a channel and for a specific session.
3608 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3609 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3612 struct lttng_ht_iter iter
, uiter
;
3613 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3614 struct ust_app
*app
;
3615 struct ust_app_session
*ua_sess
;
3616 struct ust_app_channel
*ua_chan
;
3617 struct ust_app_event
*ua_event
;
3619 DBG("UST app disabling event %s for all apps in channel "
3620 "%s for session id %" PRIu64
,
3621 uevent
->attr
.name
, uchan
->name
, usess
->id
);
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
);
3635 if (ua_sess
== NULL
) {
3640 /* Lookup channel in the ust app session */
3641 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3642 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3643 if (ua_chan_node
== NULL
) {
3644 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3645 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3648 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3650 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3651 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3652 if (ua_event_node
== NULL
) {
3653 DBG2("Event %s not found in channel %s for app pid %d."
3654 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3657 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3659 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3661 /* XXX: Report error someday... */
3672 * For a specific UST session, create the channel for all registered apps.
3674 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3675 struct ltt_ust_channel
*uchan
)
3677 int ret
= 0, created
;
3678 struct lttng_ht_iter iter
;
3679 struct ust_app
*app
;
3680 struct ust_app_session
*ua_sess
= NULL
;
3682 /* Very wrong code flow */
3686 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3687 uchan
->name
, usess
->id
);
3691 /* For every registered applications */
3692 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3693 if (!app
->compatible
) {
3695 * TODO: In time, we should notice the caller of this error by
3696 * telling him that this is a version error.
3701 * Create session on the tracer side and add it to app session HT. Note
3702 * that if session exist, it will simply return a pointer to the ust
3705 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3710 * The application's socket is not valid. Either a bad socket
3711 * or a timeout on it. We can't inform the caller that for a
3712 * specific app, the session failed so lets continue here.
3717 goto error_rcu_unlock
;
3722 pthread_mutex_lock(&ua_sess
->lock
);
3723 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3724 sizeof(uchan
->name
))) {
3725 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3728 /* Create channel onto application. We don't need the chan ref. */
3729 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3730 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3732 pthread_mutex_unlock(&ua_sess
->lock
);
3734 if (ret
== -ENOMEM
) {
3735 /* No more memory is a fatal error. Stop right now. */
3736 goto error_rcu_unlock
;
3738 /* Cleanup the created session if it's the case. */
3740 destroy_app_session(app
, ua_sess
);
3751 * Enable event for a specific session and channel on the tracer.
3753 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3754 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3757 struct lttng_ht_iter iter
, uiter
;
3758 struct lttng_ht_node_str
*ua_chan_node
;
3759 struct ust_app
*app
;
3760 struct ust_app_session
*ua_sess
;
3761 struct ust_app_channel
*ua_chan
;
3762 struct ust_app_event
*ua_event
;
3764 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3765 uevent
->attr
.name
, usess
->id
);
3768 * NOTE: At this point, this function is called only if the session and
3769 * channel passed are already created for all apps. and enabled on the
3775 /* For all registered applications */
3776 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3777 if (!app
->compatible
) {
3779 * TODO: In time, we should notice the caller of this error by
3780 * telling him that this is a version error.
3784 ua_sess
= lookup_session_by_app(usess
, app
);
3786 /* The application has problem or is probably dead. */
3790 pthread_mutex_lock(&ua_sess
->lock
);
3792 /* Lookup channel in the ust app session */
3793 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3794 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3795 /* If the channel is not found, there is a code flow error */
3796 assert(ua_chan_node
);
3798 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3800 /* Get event node */
3801 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3802 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3803 if (ua_event
== NULL
) {
3804 DBG3("UST app enable event %s not found for app PID %d."
3805 "Skipping app", uevent
->attr
.name
, app
->pid
);
3809 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3811 pthread_mutex_unlock(&ua_sess
->lock
);
3815 pthread_mutex_unlock(&ua_sess
->lock
);
3824 * For a specific existing UST session and UST channel, creates the event for
3825 * all registered apps.
3827 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3828 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3831 struct lttng_ht_iter iter
, uiter
;
3832 struct lttng_ht_node_str
*ua_chan_node
;
3833 struct ust_app
*app
;
3834 struct ust_app_session
*ua_sess
;
3835 struct ust_app_channel
*ua_chan
;
3837 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3838 uevent
->attr
.name
, usess
->id
);
3842 /* For all registered applications */
3843 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3844 if (!app
->compatible
) {
3846 * TODO: In time, we should notice the caller of this error by
3847 * telling him that this is a version error.
3851 ua_sess
= lookup_session_by_app(usess
, app
);
3853 /* The application has problem or is probably dead. */
3857 pthread_mutex_lock(&ua_sess
->lock
);
3858 /* Lookup channel in the ust app session */
3859 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3860 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3861 /* If the channel is not found, there is a code flow error */
3862 assert(ua_chan_node
);
3864 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3866 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3867 pthread_mutex_unlock(&ua_sess
->lock
);
3869 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3870 /* Possible value at this point: -ENOMEM. If so, we stop! */
3873 DBG2("UST app event %s already exist on app PID %d",
3874 uevent
->attr
.name
, app
->pid
);
3885 * Start tracing for a specific UST session and app.
3888 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3891 struct ust_app_session
*ua_sess
;
3893 DBG("Starting tracing for ust app pid %d", app
->pid
);
3897 if (!app
->compatible
) {
3901 ua_sess
= lookup_session_by_app(usess
, app
);
3902 if (ua_sess
== NULL
) {
3903 /* The session is in teardown process. Ignore and continue. */
3907 pthread_mutex_lock(&ua_sess
->lock
);
3909 /* Upon restart, we skip the setup, already done */
3910 if (ua_sess
->started
) {
3914 /* Create directories if consumer is LOCAL and has a path defined. */
3915 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3916 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3917 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3918 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3920 if (ret
!= -EEXIST
) {
3921 ERR("Trace directory creation error");
3928 * Create the metadata for the application. This returns gracefully if a
3929 * metadata was already set for the session.
3931 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3936 health_code_update();
3939 /* This start the UST tracing */
3940 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3942 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3943 ERR("Error starting tracing for app pid: %d (ret: %d)",
3946 DBG("UST app start session failed. Application is dead.");
3948 * This is normal behavior, an application can die during the
3949 * creation process. Don't report an error so the execution can
3950 * continue normally.
3952 pthread_mutex_unlock(&ua_sess
->lock
);
3958 /* Indicate that the session has been started once */
3959 ua_sess
->started
= 1;
3961 pthread_mutex_unlock(&ua_sess
->lock
);
3963 health_code_update();
3965 /* Quiescent wait after starting trace */
3966 ret
= ustctl_wait_quiescent(app
->sock
);
3967 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3968 ERR("UST app wait quiescent failed for app pid %d ret %d",
3974 health_code_update();
3978 pthread_mutex_unlock(&ua_sess
->lock
);
3980 health_code_update();
3985 * Stop tracing for a specific UST session and app.
3988 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3991 struct ust_app_session
*ua_sess
;
3992 struct ust_registry_session
*registry
;
3994 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3998 if (!app
->compatible
) {
3999 goto end_no_session
;
4002 ua_sess
= lookup_session_by_app(usess
, app
);
4003 if (ua_sess
== NULL
) {
4004 goto end_no_session
;
4007 pthread_mutex_lock(&ua_sess
->lock
);
4010 * If started = 0, it means that stop trace has been called for a session
4011 * that was never started. It's possible since we can have a fail start
4012 * from either the application manager thread or the command thread. Simply
4013 * indicate that this is a stop error.
4015 if (!ua_sess
->started
) {
4016 goto error_rcu_unlock
;
4019 health_code_update();
4021 /* This inhibits UST tracing */
4022 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4024 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4025 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4028 DBG("UST app stop session failed. Application is dead.");
4030 * This is normal behavior, an application can die during the
4031 * creation process. Don't report an error so the execution can
4032 * continue normally.
4036 goto error_rcu_unlock
;
4039 health_code_update();
4041 /* Quiescent wait after stopping trace */
4042 ret
= ustctl_wait_quiescent(app
->sock
);
4043 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4044 ERR("UST app wait quiescent failed for app pid %d ret %d",
4048 health_code_update();
4050 registry
= get_session_registry(ua_sess
);
4053 /* Push metadata for application before freeing the application. */
4054 (void) push_metadata(registry
, ua_sess
->consumer
);
4057 pthread_mutex_unlock(&ua_sess
->lock
);
4060 health_code_update();
4064 pthread_mutex_unlock(&ua_sess
->lock
);
4066 health_code_update();
4071 int ust_app_flush_app_session(struct ust_app
*app
,
4072 struct ust_app_session
*ua_sess
)
4074 int ret
, retval
= 0;
4075 struct lttng_ht_iter iter
;
4076 struct ust_app_channel
*ua_chan
;
4077 struct consumer_socket
*socket
;
4079 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4083 if (!app
->compatible
) {
4084 goto end_not_compatible
;
4087 pthread_mutex_lock(&ua_sess
->lock
);
4089 health_code_update();
4091 /* Flushing buffers */
4092 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4095 /* Flush buffers and push metadata. */
4096 switch (ua_sess
->buffer_type
) {
4097 case LTTNG_BUFFER_PER_PID
:
4098 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4100 health_code_update();
4101 assert(ua_chan
->is_sent
);
4102 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4104 ERR("Error flushing consumer channel");
4110 case LTTNG_BUFFER_PER_UID
:
4116 health_code_update();
4118 pthread_mutex_unlock(&ua_sess
->lock
);
4122 health_code_update();
4127 * Flush buffers for all applications for a specific UST session.
4128 * Called with UST session lock held.
4131 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4136 DBG("Flushing session buffers for all ust apps");
4140 /* Flush buffers and push metadata. */
4141 switch (usess
->buffer_type
) {
4142 case LTTNG_BUFFER_PER_UID
:
4144 struct buffer_reg_uid
*reg
;
4145 struct lttng_ht_iter iter
;
4147 /* Flush all per UID buffers associated to that session. */
4148 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4149 struct ust_registry_session
*ust_session_reg
;
4150 struct buffer_reg_channel
*reg_chan
;
4151 struct consumer_socket
*socket
;
4153 /* Get consumer socket to use to push the metadata.*/
4154 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4157 /* Ignore request if no consumer is found for the session. */
4161 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4162 reg_chan
, node
.node
) {
4164 * The following call will print error values so the return
4165 * code is of little importance because whatever happens, we
4166 * have to try them all.
4168 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4171 ust_session_reg
= reg
->registry
->reg
.ust
;
4172 /* Push metadata. */
4173 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4178 case LTTNG_BUFFER_PER_PID
:
4180 struct ust_app_session
*ua_sess
;
4181 struct lttng_ht_iter iter
;
4182 struct ust_app
*app
;
4184 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4185 ua_sess
= lookup_session_by_app(usess
, app
);
4186 if (ua_sess
== NULL
) {
4189 (void) ust_app_flush_app_session(app
, ua_sess
);
4200 health_code_update();
4205 * Destroy a specific UST session in apps.
4207 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4210 struct ust_app_session
*ua_sess
;
4211 struct lttng_ht_iter iter
;
4212 struct lttng_ht_node_u64
*node
;
4214 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4218 if (!app
->compatible
) {
4222 __lookup_session_by_app(usess
, app
, &iter
);
4223 node
= lttng_ht_iter_get_node_u64(&iter
);
4225 /* Session is being or is deleted. */
4228 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4230 health_code_update();
4231 destroy_app_session(app
, ua_sess
);
4233 health_code_update();
4235 /* Quiescent wait after stopping trace */
4236 ret
= ustctl_wait_quiescent(app
->sock
);
4237 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4238 ERR("UST app wait quiescent failed for app pid %d ret %d",
4243 health_code_update();
4248 * Start tracing for the UST session.
4250 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4253 struct lttng_ht_iter iter
;
4254 struct ust_app
*app
;
4256 DBG("Starting all UST traces");
4260 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4261 ret
= ust_app_start_trace(usess
, app
);
4263 /* Continue to next apps even on error */
4274 * Start tracing for the UST session.
4275 * Called with UST session lock held.
4277 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4280 struct lttng_ht_iter iter
;
4281 struct ust_app
*app
;
4283 DBG("Stopping all UST traces");
4287 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4288 ret
= ust_app_stop_trace(usess
, app
);
4290 /* Continue to next apps even on error */
4295 (void) ust_app_flush_session(usess
);
4303 * Destroy app UST session.
4305 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4308 struct lttng_ht_iter iter
;
4309 struct ust_app
*app
;
4311 DBG("Destroy all UST traces");
4315 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4316 ret
= destroy_trace(usess
, app
);
4318 /* Continue to next apps even on error */
4329 * Add channels/events from UST global domain to registered apps at sock.
4331 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4334 struct lttng_ht_iter iter
, uiter
;
4335 struct ust_app
*app
;
4336 struct ust_app_session
*ua_sess
= NULL
;
4337 struct ust_app_channel
*ua_chan
;
4338 struct ust_app_event
*ua_event
;
4339 struct ust_app_ctx
*ua_ctx
;
4344 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4349 app
= ust_app_find_by_sock(sock
);
4352 * Application can be unregistered before so this is possible hence
4353 * simply stopping the update.
4355 DBG3("UST app update failed to find app sock %d", sock
);
4359 if (!app
->compatible
) {
4363 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4365 /* Tracer is probably gone or ENOMEM. */
4370 pthread_mutex_lock(&ua_sess
->lock
);
4373 * We can iterate safely here over all UST app session since the create ust
4374 * app session above made a shadow copy of the UST global domain from the
4377 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4379 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4382 * Stop everything. On error, the application failed, no more
4383 * file descriptor are available or ENOMEM so stopping here is
4384 * the only thing we can do for now.
4390 * Add context using the list so they are enabled in the same order the
4393 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4394 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4401 /* For each events */
4402 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4404 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4411 pthread_mutex_unlock(&ua_sess
->lock
);
4413 if (usess
->active
) {
4414 ret
= ust_app_start_trace(usess
, app
);
4419 DBG2("UST trace started for app pid %d", app
->pid
);
4422 /* Everything went well at this point. */
4427 pthread_mutex_unlock(&ua_sess
->lock
);
4430 destroy_app_session(app
, ua_sess
);
4437 * Add context to a specific channel for global UST domain.
4439 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4440 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4443 struct lttng_ht_node_str
*ua_chan_node
;
4444 struct lttng_ht_iter iter
, uiter
;
4445 struct ust_app_channel
*ua_chan
= NULL
;
4446 struct ust_app_session
*ua_sess
;
4447 struct ust_app
*app
;
4451 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4452 if (!app
->compatible
) {
4454 * TODO: In time, we should notice the caller of this error by
4455 * telling him that this is a version error.
4459 ua_sess
= lookup_session_by_app(usess
, app
);
4460 if (ua_sess
== NULL
) {
4464 pthread_mutex_lock(&ua_sess
->lock
);
4465 /* Lookup channel in the ust app session */
4466 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4467 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4468 if (ua_chan_node
== NULL
) {
4471 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4473 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4478 pthread_mutex_unlock(&ua_sess
->lock
);
4486 * Enable event for a channel from a UST session for a specific PID.
4488 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4489 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4492 struct lttng_ht_iter iter
;
4493 struct lttng_ht_node_str
*ua_chan_node
;
4494 struct ust_app
*app
;
4495 struct ust_app_session
*ua_sess
;
4496 struct ust_app_channel
*ua_chan
;
4497 struct ust_app_event
*ua_event
;
4499 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4503 app
= ust_app_find_by_pid(pid
);
4505 ERR("UST app enable event per PID %d not found", pid
);
4510 if (!app
->compatible
) {
4515 ua_sess
= lookup_session_by_app(usess
, app
);
4517 /* The application has problem or is probably dead. */
4522 pthread_mutex_lock(&ua_sess
->lock
);
4523 /* Lookup channel in the ust app session */
4524 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4525 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4526 /* If the channel is not found, there is a code flow error */
4527 assert(ua_chan_node
);
4529 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4531 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4532 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4533 if (ua_event
== NULL
) {
4534 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4539 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4546 pthread_mutex_unlock(&ua_sess
->lock
);
4553 * Calibrate registered applications.
4555 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4558 struct lttng_ht_iter iter
;
4559 struct ust_app
*app
;
4563 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4564 if (!app
->compatible
) {
4566 * TODO: In time, we should notice the caller of this error by
4567 * telling him that this is a version error.
4572 health_code_update();
4574 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4578 /* Means that it's not implemented on the tracer side. */
4582 DBG2("Calibrate app PID %d returned with error %d",
4589 DBG("UST app global domain calibration finished");
4593 health_code_update();
4599 * Receive registration and populate the given msg structure.
4601 * On success return 0 else a negative value returned by the ustctl call.
4603 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4606 uint32_t pid
, ppid
, uid
, gid
;
4610 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4611 &pid
, &ppid
, &uid
, &gid
,
4612 &msg
->bits_per_long
,
4613 &msg
->uint8_t_alignment
,
4614 &msg
->uint16_t_alignment
,
4615 &msg
->uint32_t_alignment
,
4616 &msg
->uint64_t_alignment
,
4617 &msg
->long_alignment
,
4624 case LTTNG_UST_ERR_EXITING
:
4625 DBG3("UST app recv reg message failed. Application died");
4627 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4628 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4629 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4630 LTTNG_UST_ABI_MINOR_VERSION
);
4633 ERR("UST app recv reg message failed with ret %d", ret
);
4638 msg
->pid
= (pid_t
) pid
;
4639 msg
->ppid
= (pid_t
) ppid
;
4640 msg
->uid
= (uid_t
) uid
;
4641 msg
->gid
= (gid_t
) gid
;
4648 * Return a ust app channel object using the application object and the channel
4649 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4650 * lock MUST be acquired before calling this function.
4652 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4655 struct lttng_ht_node_ulong
*node
;
4656 struct lttng_ht_iter iter
;
4657 struct ust_app_channel
*ua_chan
= NULL
;
4661 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4662 node
= lttng_ht_iter_get_node_ulong(&iter
);
4664 DBG2("UST app channel find by objd %d not found", objd
);
4668 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4675 * Reply to a register channel notification from an application on the notify
4676 * socket. The channel metadata is also created.
4678 * The session UST registry lock is acquired in this function.
4680 * On success 0 is returned else a negative value.
4682 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4683 size_t nr_fields
, struct ustctl_field
*fields
)
4685 int ret
, ret_code
= 0;
4686 uint32_t chan_id
, reg_count
;
4687 uint64_t chan_reg_key
;
4688 enum ustctl_channel_header type
;
4689 struct ust_app
*app
;
4690 struct ust_app_channel
*ua_chan
;
4691 struct ust_app_session
*ua_sess
;
4692 struct ust_registry_session
*registry
;
4693 struct ust_registry_channel
*chan_reg
;
4697 /* Lookup application. If not found, there is a code flow error. */
4698 app
= find_app_by_notify_sock(sock
);
4700 DBG("Application socket %d is being teardown. Abort event notify",
4704 goto error_rcu_unlock
;
4707 /* Lookup channel by UST object descriptor. */
4708 ua_chan
= find_channel_by_objd(app
, cobjd
);
4710 DBG("Application channel is being teardown. Abort event notify");
4713 goto error_rcu_unlock
;
4716 assert(ua_chan
->session
);
4717 ua_sess
= ua_chan
->session
;
4719 /* Get right session registry depending on the session buffer type. */
4720 registry
= get_session_registry(ua_sess
);
4723 /* Depending on the buffer type, a different channel key is used. */
4724 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4725 chan_reg_key
= ua_chan
->tracing_channel_id
;
4727 chan_reg_key
= ua_chan
->key
;
4730 pthread_mutex_lock(®istry
->lock
);
4732 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4735 if (!chan_reg
->register_done
) {
4736 reg_count
= ust_registry_get_event_count(chan_reg
);
4737 if (reg_count
< 31) {
4738 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4740 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4743 chan_reg
->nr_ctx_fields
= nr_fields
;
4744 chan_reg
->ctx_fields
= fields
;
4745 chan_reg
->header_type
= type
;
4747 /* Get current already assigned values. */
4748 type
= chan_reg
->header_type
;
4750 /* Set to NULL so the error path does not do a double free. */
4753 /* Channel id is set during the object creation. */
4754 chan_id
= chan_reg
->chan_id
;
4756 /* Append to metadata */
4757 if (!chan_reg
->metadata_dumped
) {
4758 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4760 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4766 DBG3("UST app replying to register channel key %" PRIu64
4767 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4770 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4772 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4773 ERR("UST app reply channel failed with ret %d", ret
);
4775 DBG3("UST app reply channel failed. Application died");
4780 /* This channel registry registration is completed. */
4781 chan_reg
->register_done
= 1;
4784 pthread_mutex_unlock(®istry
->lock
);
4794 * Add event to the UST channel registry. When the event is added to the
4795 * registry, the metadata is also created. Once done, this replies to the
4796 * application with the appropriate error code.
4798 * The session UST registry lock is acquired in the function.
4800 * On success 0 is returned else a negative value.
4802 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4803 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4804 char *model_emf_uri
)
4807 uint32_t event_id
= 0;
4808 uint64_t chan_reg_key
;
4809 struct ust_app
*app
;
4810 struct ust_app_channel
*ua_chan
;
4811 struct ust_app_session
*ua_sess
;
4812 struct ust_registry_session
*registry
;
4816 /* Lookup application. If not found, there is a code flow error. */
4817 app
= find_app_by_notify_sock(sock
);
4819 DBG("Application socket %d is being teardown. Abort event notify",
4824 free(model_emf_uri
);
4825 goto error_rcu_unlock
;
4828 /* Lookup channel by UST object descriptor. */
4829 ua_chan
= find_channel_by_objd(app
, cobjd
);
4831 DBG("Application channel is being teardown. Abort event notify");
4835 free(model_emf_uri
);
4836 goto error_rcu_unlock
;
4839 assert(ua_chan
->session
);
4840 ua_sess
= ua_chan
->session
;
4842 registry
= get_session_registry(ua_sess
);
4845 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4846 chan_reg_key
= ua_chan
->tracing_channel_id
;
4848 chan_reg_key
= ua_chan
->key
;
4851 pthread_mutex_lock(®istry
->lock
);
4854 * From this point on, this call acquires the ownership of the sig, fields
4855 * and model_emf_uri meaning any free are done inside it if needed. These
4856 * three variables MUST NOT be read/write after this.
4858 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4859 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4860 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4864 * The return value is returned to ustctl so in case of an error, the
4865 * application can be notified. In case of an error, it's important not to
4866 * return a negative error or else the application will get closed.
4868 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4870 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4871 ERR("UST app reply event failed with ret %d", ret
);
4873 DBG3("UST app reply event failed. Application died");
4876 * No need to wipe the create event since the application socket will
4877 * get close on error hence cleaning up everything by itself.
4882 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4886 pthread_mutex_unlock(®istry
->lock
);
4893 * Handle application notification through the given notify socket.
4895 * Return 0 on success or else a negative value.
4897 int ust_app_recv_notify(int sock
)
4900 enum ustctl_notify_cmd cmd
;
4902 DBG3("UST app receiving notify from sock %d", sock
);
4904 ret
= ustctl_recv_notify(sock
, &cmd
);
4906 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4907 ERR("UST app recv notify failed with ret %d", ret
);
4909 DBG3("UST app recv notify failed. Application died");
4915 case USTCTL_NOTIFY_CMD_EVENT
:
4917 int sobjd
, cobjd
, loglevel
;
4918 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4920 struct ustctl_field
*fields
;
4922 DBG2("UST app ustctl register event received");
4924 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4925 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4927 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4928 ERR("UST app recv event failed with ret %d", ret
);
4930 DBG3("UST app recv event failed. Application died");
4936 * Add event to the UST registry coming from the notify socket. This
4937 * call will free if needed the sig, fields and model_emf_uri. This
4938 * code path loses the ownsership of these variables and transfer them
4939 * to the this function.
4941 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4942 fields
, loglevel
, model_emf_uri
);
4949 case USTCTL_NOTIFY_CMD_CHANNEL
:
4953 struct ustctl_field
*fields
;
4955 DBG2("UST app ustctl register channel received");
4957 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4960 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4961 ERR("UST app recv channel failed with ret %d", ret
);
4963 DBG3("UST app recv channel failed. Application died");
4969 * The fields ownership are transfered to this function call meaning
4970 * that if needed it will be freed. After this, it's invalid to access
4971 * fields or clean it up.
4973 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4982 /* Should NEVER happen. */
4991 * Once the notify socket hangs up, this is called. First, it tries to find the
4992 * corresponding application. On failure, the call_rcu to close the socket is
4993 * executed. If an application is found, it tries to delete it from the notify
4994 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4996 * Note that an object needs to be allocated here so on ENOMEM failure, the
4997 * call RCU is not done but the rest of the cleanup is.
4999 void ust_app_notify_sock_unregister(int sock
)
5002 struct lttng_ht_iter iter
;
5003 struct ust_app
*app
;
5004 struct ust_app_notify_sock_obj
*obj
;
5010 obj
= zmalloc(sizeof(*obj
));
5013 * An ENOMEM is kind of uncool. If this strikes we continue the
5014 * procedure but the call_rcu will not be called. In this case, we
5015 * accept the fd leak rather than possibly creating an unsynchronized
5016 * state between threads.
5018 * TODO: The notify object should be created once the notify socket is
5019 * registered and stored independantely from the ust app object. The
5020 * tricky part is to synchronize the teardown of the application and
5021 * this notify object. Let's keep that in mind so we can avoid this
5022 * kind of shenanigans with ENOMEM in the teardown path.
5029 DBG("UST app notify socket unregister %d", sock
);
5032 * Lookup application by notify socket. If this fails, this means that the
5033 * hash table delete has already been done by the application
5034 * unregistration process so we can safely close the notify socket in a
5037 app
= find_app_by_notify_sock(sock
);
5042 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5045 * Whatever happens here either we fail or succeed, in both cases we have
5046 * to close the socket after a grace period to continue to the call RCU
5047 * here. If the deletion is successful, the application is not visible
5048 * anymore by other threads and is it fails it means that it was already
5049 * deleted from the hash table so either way we just have to close the
5052 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5058 * Close socket after a grace period to avoid for the socket to be reused
5059 * before the application object is freed creating potential race between
5060 * threads trying to add unique in the global hash table.
5063 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5068 * Destroy a ust app data structure and free its memory.
5070 void ust_app_destroy(struct ust_app
*app
)
5076 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5080 * Take a snapshot for a given UST session. The snapshot is sent to the given
5083 * Return 0 on success or else a negative value.
5085 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5086 struct snapshot_output
*output
, int wait
, uint64_t max_stream_size
)
5089 unsigned int snapshot_done
= 0;
5090 struct lttng_ht_iter iter
;
5091 struct ust_app
*app
;
5092 char pathname
[PATH_MAX
];
5099 switch (usess
->buffer_type
) {
5100 case LTTNG_BUFFER_PER_UID
:
5102 struct buffer_reg_uid
*reg
;
5104 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5105 struct buffer_reg_channel
*reg_chan
;
5106 struct consumer_socket
*socket
;
5108 /* Get consumer socket to use to push the metadata.*/
5109 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5116 memset(pathname
, 0, sizeof(pathname
));
5117 ret
= snprintf(pathname
, sizeof(pathname
),
5118 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5119 reg
->uid
, reg
->bits_per_long
);
5121 PERROR("snprintf snapshot path");
5125 /* Add the UST default trace dir to path. */
5126 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5127 reg_chan
, node
.node
) {
5128 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5129 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5135 ret
= consumer_snapshot_channel(socket
,
5136 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5137 usess
->uid
, usess
->gid
, pathname
, wait
, max_stream_size
);
5145 case LTTNG_BUFFER_PER_PID
:
5147 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5148 struct consumer_socket
*socket
;
5149 struct lttng_ht_iter chan_iter
;
5150 struct ust_app_channel
*ua_chan
;
5151 struct ust_app_session
*ua_sess
;
5152 struct ust_registry_session
*registry
;
5154 ua_sess
= lookup_session_by_app(usess
, app
);
5156 /* Session not associated with this app. */
5160 /* Get the right consumer socket for the application. */
5161 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5168 /* Add the UST default trace dir to path. */
5169 memset(pathname
, 0, sizeof(pathname
));
5170 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5173 PERROR("snprintf snapshot path");
5177 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5178 ua_chan
, node
.node
) {
5179 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5180 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5187 registry
= get_session_registry(ua_sess
);
5189 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5190 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5204 if (!snapshot_done
) {
5206 * If no snapshot was made and we are not in the error path, this means
5207 * that there are no buffers thus no (prior) application to snapshot
5208 * data from so we have simply NO data.
5219 * Return the number of streams for a UST session.
5221 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5223 unsigned int ret
= 0;
5224 struct ust_app
*app
;
5225 struct lttng_ht_iter iter
;
5229 switch (usess
->buffer_type
) {
5230 case LTTNG_BUFFER_PER_UID
:
5232 struct buffer_reg_uid
*reg
;
5234 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5235 struct buffer_reg_channel
*reg_chan
;
5238 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5239 reg_chan
, node
.node
) {
5240 ret
+= reg_chan
->stream_count
;
5246 case LTTNG_BUFFER_PER_PID
:
5249 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5250 struct ust_app_channel
*ua_chan
;
5251 struct ust_app_session
*ua_sess
;
5252 struct lttng_ht_iter chan_iter
;
5254 ua_sess
= lookup_session_by_app(usess
, app
);
5256 /* Session not associated with this app. */
5260 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5261 ua_chan
, node
.node
) {
5262 ret
+= ua_chan
->streams
.count
;