2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
39 #include "ust-consumer.h"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 3 elements of the key: name, filter and loglevel. */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
151 * Unique add of an ust app event in the given ht. This uses the custom
152 * ht_match_ust_app_event match function and the event name as hash.
154 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
155 struct ust_app_event
*event
)
157 struct cds_lfht_node
*node_ptr
;
158 struct ust_app_ht_key key
;
162 assert(ua_chan
->events
);
165 ht
= ua_chan
->events
;
166 key
.name
= event
->attr
.name
;
167 key
.filter
= event
->filter
;
168 key
.loglevel
= event
->attr
.loglevel
;
170 node_ptr
= cds_lfht_add_unique(ht
->ht
,
171 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
172 ht_match_ust_app_event
, &key
, &event
->node
.node
);
173 assert(node_ptr
== &event
->node
.node
);
177 * Close the notify socket from the given RCU head object. This MUST be called
178 * through a call_rcu().
180 static void close_notify_sock_rcu(struct rcu_head
*head
)
183 struct ust_app_notify_sock_obj
*obj
=
184 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
186 /* Must have a valid fd here. */
187 assert(obj
->fd
>= 0);
189 ret
= close(obj
->fd
);
191 ERR("close notify sock %d RCU", obj
->fd
);
193 lttng_fd_put(LTTNG_FD_APPS
, 1);
199 * Return the session registry according to the buffer type of the given
202 * A registry per UID object MUST exists before calling this function or else
203 * it assert() if not found. RCU read side lock must be acquired.
205 static struct ust_registry_session
*get_session_registry(
206 struct ust_app_session
*ua_sess
)
208 struct ust_registry_session
*registry
= NULL
;
212 switch (ua_sess
->buffer_type
) {
213 case LTTNG_BUFFER_PER_PID
:
215 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
219 registry
= reg_pid
->registry
->reg
.ust
;
222 case LTTNG_BUFFER_PER_UID
:
224 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
225 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
229 registry
= reg_uid
->registry
->reg
.ust
;
241 * Delete ust context safely. RCU read lock must be held before calling
245 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
252 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
253 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
254 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
255 sock
, ua_ctx
->obj
->handle
, ret
);
263 * Delete ust app event safely. RCU read lock must be held before calling
267 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
273 free(ua_event
->filter
);
275 if (ua_event
->obj
!= NULL
) {
276 ret
= ustctl_release_object(sock
, ua_event
->obj
);
277 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
278 ERR("UST app sock %d release event obj failed with ret %d",
287 * Release ust data object of the given stream.
289 * Return 0 on success or else a negative value.
291 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
298 ret
= ustctl_release_object(sock
, stream
->obj
);
299 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
300 ERR("UST app sock %d release stream obj failed with ret %d",
303 lttng_fd_put(LTTNG_FD_APPS
, 2);
311 * Delete ust app stream safely. RCU read lock must be held before calling
315 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 (void) release_ust_app_stream(sock
, stream
);
324 * We need to execute ht_destroy outside of RCU read-side critical
325 * section and outside of call_rcu thread, so we postpone its execution
326 * using ht_cleanup_push. It is simpler than to change the semantic of
327 * the many callers of delete_ust_app_session().
330 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
332 struct ust_app_channel
*ua_chan
=
333 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
335 ht_cleanup_push(ua_chan
->ctx
);
336 ht_cleanup_push(ua_chan
->events
);
341 * Delete ust app channel safely. RCU read lock must be held before calling
345 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
349 struct lttng_ht_iter iter
;
350 struct ust_app_event
*ua_event
;
351 struct ust_app_ctx
*ua_ctx
;
352 struct ust_app_stream
*stream
, *stmp
;
353 struct ust_registry_session
*registry
;
357 DBG3("UST app deleting channel %s", ua_chan
->name
);
360 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
361 cds_list_del(&stream
->list
);
362 delete_ust_app_stream(sock
, stream
);
366 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
367 cds_list_del(&ua_ctx
->list
);
368 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
370 delete_ust_app_ctx(sock
, ua_ctx
);
374 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
376 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
378 delete_ust_app_event(sock
, ua_event
);
381 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
382 /* Wipe and free registry from session registry. */
383 registry
= get_session_registry(ua_chan
->session
);
385 ust_registry_channel_del_free(registry
, ua_chan
->key
);
389 if (ua_chan
->obj
!= NULL
) {
390 /* Remove channel from application UST object descriptor. */
391 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
392 lttng_ht_del(app
->ust_objd
, &iter
);
393 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
394 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
395 ERR("UST app sock %d release channel obj failed with ret %d",
398 lttng_fd_put(LTTNG_FD_APPS
, 1);
401 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
405 * Push metadata to consumer socket.
407 * The socket lock MUST be acquired.
408 * The ust app session lock MUST be acquired.
410 * On success, return the len of metadata pushed or else a negative value.
412 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
413 struct consumer_socket
*socket
, int send_zero_data
)
416 char *metadata_str
= NULL
;
424 * On a push metadata error either the consumer is dead or the metadata
425 * channel has been destroyed because its endpoint might have died (e.g:
426 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
427 * metadata again which is not valid anymore on the consumer side.
429 * The ust app session mutex locked allows us to make this check without
432 if (registry
->metadata_closed
) {
436 pthread_mutex_lock(®istry
->lock
);
438 offset
= registry
->metadata_len_sent
;
439 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
441 DBG3("No metadata to push for metadata key %" PRIu64
,
442 registry
->metadata_key
);
444 if (send_zero_data
) {
445 DBG("No metadata to push");
451 /* Allocate only what we have to send. */
452 metadata_str
= zmalloc(len
);
454 PERROR("zmalloc ust app metadata string");
458 /* Copy what we haven't send out. */
459 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
460 registry
->metadata_len_sent
+= len
;
463 pthread_mutex_unlock(®istry
->lock
);
464 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
465 metadata_str
, len
, offset
);
468 * There is an acceptable race here between the registry metadata key
469 * assignment and the creation on the consumer. The session daemon can
470 * concurrently push metadata for this registry while being created on
471 * the consumer since the metadata key of the registry is assigned
472 * *before* it is setup to avoid the consumer to ask for metadata that
473 * could possibly be not found in the session daemon.
475 * The metadata will get pushed either by the session being stopped or
476 * the consumer requesting metadata if that race is triggered.
478 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
482 /* Update back the actual metadata len sent since it failed here. */
483 pthread_mutex_lock(®istry
->lock
);
484 registry
->metadata_len_sent
-= len
;
485 pthread_mutex_unlock(®istry
->lock
);
495 pthread_mutex_unlock(®istry
->lock
);
502 * For a given application and session, push metadata to consumer. The session
503 * lock MUST be acquired here before calling this.
504 * Either sock or consumer is required : if sock is NULL, the default
505 * socket to send the metadata is retrieved from consumer, if sock
506 * is not NULL we use it to send the metadata.
508 * Return 0 on success else a negative error.
510 static int push_metadata(struct ust_registry_session
*registry
,
511 struct consumer_output
*consumer
)
515 struct consumer_socket
*socket
;
523 * Means that no metadata was assigned to the session. This can happens if
524 * no start has been done previously.
526 if (!registry
->metadata_key
) {
531 /* Get consumer socket to use to push the metadata.*/
532 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
536 goto error_rcu_unlock
;
540 * TODO: Currently, we hold the socket lock around sampling of the next
541 * metadata segment to ensure we send metadata over the consumer socket in
542 * the correct order. This makes the registry lock nest inside the socket
545 * Please note that this is a temporary measure: we should move this lock
546 * back into ust_consumer_push_metadata() when the consumer gets the
547 * ability to reorder the metadata it receives.
549 pthread_mutex_lock(socket
->lock
);
550 ret
= ust_app_push_metadata(registry
, socket
, 0);
551 pthread_mutex_unlock(socket
->lock
);
554 goto error_rcu_unlock
;
562 * On error, flag the registry that the metadata is closed. We were unable
563 * to push anything and this means that either the consumer is not
564 * responding or the metadata cache has been destroyed on the consumer.
566 registry
->metadata_closed
= 1;
573 * Send to the consumer a close metadata command for the given session. Once
574 * done, the metadata channel is deleted and the session metadata pointer is
575 * nullified. The session lock MUST be acquired here unless the application is
576 * in the destroy path.
578 * Return 0 on success else a negative value.
580 static int close_metadata(struct ust_registry_session
*registry
,
581 struct consumer_output
*consumer
)
584 struct consumer_socket
*socket
;
591 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
596 /* Get consumer socket to use to push the metadata.*/
597 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
604 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
611 * Metadata closed. Even on error this means that the consumer is not
612 * responding or not found so either way a second close should NOT be emit
615 registry
->metadata_closed
= 1;
622 * We need to execute ht_destroy outside of RCU read-side critical
623 * section and outside of call_rcu thread, so we postpone its execution
624 * using ht_cleanup_push. It is simpler than to change the semantic of
625 * the many callers of delete_ust_app_session().
628 void delete_ust_app_session_rcu(struct rcu_head
*head
)
630 struct ust_app_session
*ua_sess
=
631 caa_container_of(head
, struct ust_app_session
, rcu_head
);
633 ht_cleanup_push(ua_sess
->channels
);
638 * Delete ust app session safely. RCU read lock must be held before calling
642 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
646 struct lttng_ht_iter iter
;
647 struct ust_app_channel
*ua_chan
;
648 struct ust_registry_session
*registry
;
652 pthread_mutex_lock(&ua_sess
->lock
);
654 registry
= get_session_registry(ua_sess
);
655 if (registry
&& !registry
->metadata_closed
) {
656 /* Push metadata for application before freeing the application. */
657 (void) push_metadata(registry
, ua_sess
->consumer
);
660 * Don't ask to close metadata for global per UID buffers. Close
661 * metadata only on destroy trace session in this case. Also, the
662 * previous push metadata could have flag the metadata registry to
663 * close so don't send a close command if closed.
665 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
666 !registry
->metadata_closed
) {
667 /* And ask to close it for this session registry. */
668 (void) close_metadata(registry
, ua_sess
->consumer
);
672 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
674 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
676 delete_ust_app_channel(sock
, ua_chan
, app
);
679 /* In case of per PID, the registry is kept in the session. */
680 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
681 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
683 buffer_reg_pid_remove(reg_pid
);
684 buffer_reg_pid_destroy(reg_pid
);
688 if (ua_sess
->handle
!= -1) {
689 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
690 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
691 ERR("UST app sock %d release session handle failed with ret %d",
695 pthread_mutex_unlock(&ua_sess
->lock
);
697 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
701 * Delete a traceable application structure from the global list. Never call
702 * this function outside of a call_rcu call.
704 * RCU read side lock should _NOT_ be held when calling this function.
707 void delete_ust_app(struct ust_app
*app
)
710 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
712 /* Delete ust app sessions info */
717 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
719 /* Free every object in the session and the session. */
721 delete_ust_app_session(sock
, ua_sess
, app
);
725 ht_cleanup_push(app
->sessions
);
726 ht_cleanup_push(app
->ust_objd
);
729 * Wait until we have deleted the application from the sock hash table
730 * before closing this socket, otherwise an application could re-use the
731 * socket ID and race with the teardown, using the same hash table entry.
733 * It's OK to leave the close in call_rcu. We want it to stay unique for
734 * all RCU readers that could run concurrently with unregister app,
735 * therefore we _need_ to only close that socket after a grace period. So
736 * it should stay in this RCU callback.
738 * This close() is a very important step of the synchronization model so
739 * every modification to this function must be carefully reviewed.
745 lttng_fd_put(LTTNG_FD_APPS
, 1);
747 DBG2("UST app pid %d deleted", app
->pid
);
752 * URCU intermediate call to delete an UST app.
755 void delete_ust_app_rcu(struct rcu_head
*head
)
757 struct lttng_ht_node_ulong
*node
=
758 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
759 struct ust_app
*app
=
760 caa_container_of(node
, struct ust_app
, pid_n
);
762 DBG3("Call RCU deleting app PID %d", app
->pid
);
767 * Delete the session from the application ht and delete the data structure by
768 * freeing every object inside and releasing them.
770 static void destroy_app_session(struct ust_app
*app
,
771 struct ust_app_session
*ua_sess
)
774 struct lttng_ht_iter iter
;
779 iter
.iter
.node
= &ua_sess
->node
.node
;
780 ret
= lttng_ht_del(app
->sessions
, &iter
);
782 /* Already scheduled for teardown. */
786 /* Once deleted, free the data structure. */
787 delete_ust_app_session(app
->sock
, ua_sess
, app
);
794 * Alloc new UST app session.
797 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
799 struct ust_app_session
*ua_sess
;
801 /* Init most of the default value by allocating and zeroing */
802 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
803 if (ua_sess
== NULL
) {
808 ua_sess
->handle
= -1;
809 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
810 pthread_mutex_init(&ua_sess
->lock
, NULL
);
819 * Alloc new UST app channel.
822 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
823 struct ust_app_session
*ua_sess
,
824 struct lttng_ust_channel_attr
*attr
)
826 struct ust_app_channel
*ua_chan
;
828 /* Init most of the default value by allocating and zeroing */
829 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
830 if (ua_chan
== NULL
) {
835 /* Setup channel name */
836 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
837 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
839 ua_chan
->enabled
= 1;
840 ua_chan
->handle
= -1;
841 ua_chan
->session
= ua_sess
;
842 ua_chan
->key
= get_next_channel_key();
843 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
844 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
845 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
847 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
848 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
850 /* Copy attributes */
852 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
853 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
854 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
855 ua_chan
->attr
.overwrite
= attr
->overwrite
;
856 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
857 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
858 ua_chan
->attr
.output
= attr
->output
;
860 /* By default, the channel is a per cpu channel. */
861 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
863 DBG3("UST app channel %s allocated", ua_chan
->name
);
872 * Allocate and initialize a UST app stream.
874 * Return newly allocated stream pointer or NULL on error.
876 struct ust_app_stream
*ust_app_alloc_stream(void)
878 struct ust_app_stream
*stream
= NULL
;
880 stream
= zmalloc(sizeof(*stream
));
881 if (stream
== NULL
) {
882 PERROR("zmalloc ust app stream");
886 /* Zero could be a valid value for a handle so flag it to -1. */
894 * Alloc new UST app event.
897 struct ust_app_event
*alloc_ust_app_event(char *name
,
898 struct lttng_ust_event
*attr
)
900 struct ust_app_event
*ua_event
;
902 /* Init most of the default value by allocating and zeroing */
903 ua_event
= zmalloc(sizeof(struct ust_app_event
));
904 if (ua_event
== NULL
) {
909 ua_event
->enabled
= 1;
910 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
911 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
912 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
914 /* Copy attributes */
916 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
919 DBG3("UST app event %s allocated", ua_event
->name
);
928 * Alloc new UST app context.
931 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
933 struct ust_app_ctx
*ua_ctx
;
935 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
936 if (ua_ctx
== NULL
) {
940 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
943 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
946 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
953 * Allocate a filter and copy the given original filter.
955 * Return allocated filter or NULL on error.
957 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
958 struct lttng_ust_filter_bytecode
*orig_f
)
960 struct lttng_ust_filter_bytecode
*filter
= NULL
;
962 /* Copy filter bytecode */
963 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
965 PERROR("zmalloc alloc ust app filter");
969 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
976 * Find an ust_app using the sock and return it. RCU read side lock must be
977 * held before calling this helper function.
980 struct ust_app
*find_app_by_sock(int sock
)
982 struct lttng_ht_node_ulong
*node
;
983 struct lttng_ht_iter iter
;
985 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
986 node
= lttng_ht_iter_get_node_ulong(&iter
);
988 DBG2("UST app find by sock %d not found", sock
);
992 return caa_container_of(node
, struct ust_app
, sock_n
);
999 * Find an ust_app using the notify sock and return it. RCU read side lock must
1000 * be held before calling this helper function.
1002 static struct ust_app
*find_app_by_notify_sock(int sock
)
1004 struct lttng_ht_node_ulong
*node
;
1005 struct lttng_ht_iter iter
;
1007 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1009 node
= lttng_ht_iter_get_node_ulong(&iter
);
1011 DBG2("UST app find by notify sock %d not found", sock
);
1015 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1022 * Lookup for an ust app event based on event name, filter bytecode and the
1025 * Return an ust_app_event object or NULL on error.
1027 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1028 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1030 struct lttng_ht_iter iter
;
1031 struct lttng_ht_node_str
*node
;
1032 struct ust_app_event
*event
= NULL
;
1033 struct ust_app_ht_key key
;
1038 /* Setup key for event lookup. */
1040 key
.filter
= filter
;
1041 key
.loglevel
= loglevel
;
1043 /* Lookup using the event name as hash and a custom match fct. */
1044 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1045 ht_match_ust_app_event
, &key
, &iter
.iter
);
1046 node
= lttng_ht_iter_get_node_str(&iter
);
1051 event
= caa_container_of(node
, struct ust_app_event
, node
);
1058 * Create the channel context on the tracer.
1060 * Called with UST app session lock held.
1063 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1064 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1068 health_code_update();
1070 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1071 ua_chan
->obj
, &ua_ctx
->obj
);
1073 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1074 ERR("UST app create channel context failed for app (pid: %d) "
1075 "with ret %d", app
->pid
, ret
);
1078 * This is normal behavior, an application can die during the
1079 * creation process. Don't report an error so the execution can
1080 * continue normally.
1083 DBG3("UST app disable event failed. Application is dead.");
1088 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1090 DBG2("UST app context handle %d created successfully for channel %s",
1091 ua_ctx
->handle
, ua_chan
->name
);
1094 health_code_update();
1099 * Set the filter on the tracer.
1102 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1103 struct ust_app
*app
)
1107 health_code_update();
1109 if (!ua_event
->filter
) {
1114 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1117 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1118 ERR("UST app event %s filter failed for app (pid: %d) "
1119 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1122 * This is normal behavior, an application can die during the
1123 * creation process. Don't report an error so the execution can
1124 * continue normally.
1127 DBG3("UST app filter event failed. Application is dead.");
1132 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1135 health_code_update();
1140 * Disable the specified event on to UST tracer for the UST session.
1142 static int disable_ust_event(struct ust_app
*app
,
1143 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1147 health_code_update();
1149 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1151 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1152 ERR("UST app event %s disable failed for app (pid: %d) "
1153 "and session handle %d with ret %d",
1154 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1157 * This is normal behavior, an application can die during the
1158 * creation process. Don't report an error so the execution can
1159 * continue normally.
1162 DBG3("UST app disable event failed. Application is dead.");
1167 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1168 ua_event
->attr
.name
, app
->pid
);
1171 health_code_update();
1176 * Disable the specified channel on to UST tracer for the UST session.
1178 static int disable_ust_channel(struct ust_app
*app
,
1179 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1183 health_code_update();
1185 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1187 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1188 ERR("UST app channel %s disable failed for app (pid: %d) "
1189 "and session handle %d with ret %d",
1190 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1193 * This is normal behavior, an application can die during the
1194 * creation process. Don't report an error so the execution can
1195 * continue normally.
1198 DBG3("UST app disable channel failed. Application is dead.");
1203 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1204 ua_chan
->name
, app
->pid
);
1207 health_code_update();
1212 * Enable the specified channel on to UST tracer for the UST session.
1214 static int enable_ust_channel(struct ust_app
*app
,
1215 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1219 health_code_update();
1221 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1223 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1224 ERR("UST app channel %s enable failed for app (pid: %d) "
1225 "and session handle %d with ret %d",
1226 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1229 * This is normal behavior, an application can die during the
1230 * creation process. Don't report an error so the execution can
1231 * continue normally.
1234 DBG3("UST app enable channel failed. Application is dead.");
1239 ua_chan
->enabled
= 1;
1241 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1242 ua_chan
->name
, app
->pid
);
1245 health_code_update();
1250 * Enable the specified event on to UST tracer for the UST session.
1252 static int enable_ust_event(struct ust_app
*app
,
1253 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1257 health_code_update();
1259 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1261 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1262 ERR("UST app event %s enable failed for app (pid: %d) "
1263 "and session handle %d with ret %d",
1264 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1267 * This is normal behavior, an application can die during the
1268 * creation process. Don't report an error so the execution can
1269 * continue normally.
1272 DBG3("UST app enable event failed. Application is dead.");
1277 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1278 ua_event
->attr
.name
, app
->pid
);
1281 health_code_update();
1286 * Send channel and stream buffer to application.
1288 * Return 0 on success. On error, a negative value is returned.
1290 static int send_channel_pid_to_ust(struct ust_app
*app
,
1291 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1294 struct ust_app_stream
*stream
, *stmp
;
1300 health_code_update();
1302 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1305 /* Send channel to the application. */
1306 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1311 health_code_update();
1313 /* Send all streams to application. */
1314 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1315 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1319 /* We don't need the stream anymore once sent to the tracer. */
1320 cds_list_del(&stream
->list
);
1321 delete_ust_app_stream(-1, stream
);
1323 /* Flag the channel that it is sent to the application. */
1324 ua_chan
->is_sent
= 1;
1327 health_code_update();
1332 * Create the specified event onto the UST tracer for a UST session.
1334 * Should be called with session mutex held.
1337 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1338 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1342 health_code_update();
1344 /* Create UST event on tracer */
1345 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1348 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1349 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1350 ua_event
->attr
.name
, app
->pid
, ret
);
1353 * This is normal behavior, an application can die during the
1354 * creation process. Don't report an error so the execution can
1355 * continue normally.
1358 DBG3("UST app create event failed. Application is dead.");
1363 ua_event
->handle
= ua_event
->obj
->handle
;
1365 DBG2("UST app event %s created successfully for pid:%d",
1366 ua_event
->attr
.name
, app
->pid
);
1368 health_code_update();
1370 /* Set filter if one is present. */
1371 if (ua_event
->filter
) {
1372 ret
= set_ust_event_filter(ua_event
, app
);
1378 /* If event not enabled, disable it on the tracer */
1379 if (ua_event
->enabled
== 0) {
1380 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1383 * If we hit an EPERM, something is wrong with our disable call. If
1384 * we get an EEXIST, there is a problem on the tracer side since we
1388 case -LTTNG_UST_ERR_PERM
:
1389 /* Code flow problem */
1391 case -LTTNG_UST_ERR_EXIST
:
1392 /* It's OK for our use case. */
1403 health_code_update();
1408 * Copy data between an UST app event and a LTT event.
1410 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1411 struct ltt_ust_event
*uevent
)
1413 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1414 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1416 ua_event
->enabled
= uevent
->enabled
;
1418 /* Copy event attributes */
1419 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1421 /* Copy filter bytecode */
1422 if (uevent
->filter
) {
1423 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1424 /* Filter might be NULL here in case of ENONEM. */
1429 * Copy data between an UST app channel and a LTT channel.
1431 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1432 struct ltt_ust_channel
*uchan
)
1434 struct lttng_ht_iter iter
;
1435 struct ltt_ust_event
*uevent
;
1436 struct ltt_ust_context
*uctx
;
1437 struct ust_app_event
*ua_event
;
1438 struct ust_app_ctx
*ua_ctx
;
1440 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1442 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1443 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1445 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1446 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1448 /* Copy event attributes since the layout is different. */
1449 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1450 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1451 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1452 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1453 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1454 ua_chan
->attr
.output
= uchan
->attr
.output
;
1456 * Note that the attribute channel type is not set since the channel on the
1457 * tracing registry side does not have this information.
1460 ua_chan
->enabled
= uchan
->enabled
;
1461 ua_chan
->tracing_channel_id
= uchan
->id
;
1463 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1464 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1465 if (ua_ctx
== NULL
) {
1468 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1469 (unsigned long) ua_ctx
->ctx
.ctx
);
1470 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1471 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1474 /* Copy all events from ltt ust channel to ust app channel */
1475 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1476 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1477 uevent
->filter
, uevent
->attr
.loglevel
);
1478 if (ua_event
== NULL
) {
1479 DBG2("UST event %s not found on shadow copy channel",
1481 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1482 if (ua_event
== NULL
) {
1485 shadow_copy_event(ua_event
, uevent
);
1486 add_unique_ust_app_event(ua_chan
, ua_event
);
1490 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1494 * Copy data between a UST app session and a regular LTT session.
1496 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1497 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1499 struct lttng_ht_node_str
*ua_chan_node
;
1500 struct lttng_ht_iter iter
;
1501 struct ltt_ust_channel
*uchan
;
1502 struct ust_app_channel
*ua_chan
;
1504 struct tm
*timeinfo
;
1508 /* Get date and time for unique app path */
1510 timeinfo
= localtime(&rawtime
);
1511 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1513 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1515 ua_sess
->tracing_id
= usess
->id
;
1516 ua_sess
->id
= get_next_session_id();
1517 ua_sess
->uid
= app
->uid
;
1518 ua_sess
->gid
= app
->gid
;
1519 ua_sess
->euid
= usess
->uid
;
1520 ua_sess
->egid
= usess
->gid
;
1521 ua_sess
->buffer_type
= usess
->buffer_type
;
1522 ua_sess
->bits_per_long
= app
->bits_per_long
;
1523 /* There is only one consumer object per session possible. */
1524 ua_sess
->consumer
= usess
->consumer
;
1526 switch (ua_sess
->buffer_type
) {
1527 case LTTNG_BUFFER_PER_PID
:
1528 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1529 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1532 case LTTNG_BUFFER_PER_UID
:
1533 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1534 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1541 PERROR("asprintf UST shadow copy session");
1546 /* Iterate over all channels in global domain. */
1547 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1549 struct lttng_ht_iter uiter
;
1551 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1552 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1553 if (ua_chan_node
!= NULL
) {
1554 /* Session exist. Contiuing. */
1558 DBG2("Channel %s not found on shadow session copy, creating it",
1560 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1561 if (ua_chan
== NULL
) {
1562 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1565 shadow_copy_channel(ua_chan
, uchan
);
1567 * The concept of metadata channel does not exist on the tracing
1568 * registry side of the session daemon so this can only be a per CPU
1569 * channel and not metadata.
1571 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1573 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1581 * Lookup sesison wrapper.
1584 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1585 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1587 /* Get right UST app session from app */
1588 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1592 * Return ust app session from the app session hashtable using the UST session
1595 static struct ust_app_session
*lookup_session_by_app(
1596 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1598 struct lttng_ht_iter iter
;
1599 struct lttng_ht_node_u64
*node
;
1601 __lookup_session_by_app(usess
, app
, &iter
);
1602 node
= lttng_ht_iter_get_node_u64(&iter
);
1607 return caa_container_of(node
, struct ust_app_session
, node
);
1614 * Setup buffer registry per PID for the given session and application. If none
1615 * is found, a new one is created, added to the global registry and
1616 * initialized. If regp is valid, it's set with the newly created object.
1618 * Return 0 on success or else a negative value.
1620 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1621 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1624 struct buffer_reg_pid
*reg_pid
;
1631 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1634 * This is the create channel path meaning that if there is NO
1635 * registry available, we have to create one for this session.
1637 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1641 buffer_reg_pid_add(reg_pid
);
1646 /* Initialize registry. */
1647 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1648 app
->bits_per_long
, app
->uint8_t_alignment
,
1649 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1650 app
->uint64_t_alignment
, app
->long_alignment
,
1651 app
->byte_order
, app
->version
.major
,
1652 app
->version
.minor
);
1657 DBG3("UST app buffer registry per PID created successfully");
1669 * Setup buffer registry per UID for the given session and application. If none
1670 * is found, a new one is created, added to the global registry and
1671 * initialized. If regp is valid, it's set with the newly created object.
1673 * Return 0 on success or else a negative value.
1675 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1676 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1679 struct buffer_reg_uid
*reg_uid
;
1686 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1689 * This is the create channel path meaning that if there is NO
1690 * registry available, we have to create one for this session.
1692 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1693 LTTNG_DOMAIN_UST
, ®_uid
);
1697 buffer_reg_uid_add(reg_uid
);
1702 /* Initialize registry. */
1703 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1704 app
->bits_per_long
, app
->uint8_t_alignment
,
1705 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1706 app
->uint64_t_alignment
, app
->long_alignment
,
1707 app
->byte_order
, app
->version
.major
,
1708 app
->version
.minor
);
1712 /* Add node to teardown list of the session. */
1713 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1715 DBG3("UST app buffer registry per UID created successfully");
1727 * Create a session on the tracer side for the given app.
1729 * On success, ua_sess_ptr is populated with the session pointer or else left
1730 * untouched. If the session was created, is_created is set to 1. On error,
1731 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1734 * Returns 0 on success or else a negative code which is either -ENOMEM or
1735 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1737 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1738 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1741 int ret
, created
= 0;
1742 struct ust_app_session
*ua_sess
;
1746 assert(ua_sess_ptr
);
1748 health_code_update();
1750 ua_sess
= lookup_session_by_app(usess
, app
);
1751 if (ua_sess
== NULL
) {
1752 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1753 app
->pid
, usess
->id
);
1754 ua_sess
= alloc_ust_app_session(app
);
1755 if (ua_sess
== NULL
) {
1756 /* Only malloc can failed so something is really wrong */
1760 shadow_copy_session(ua_sess
, usess
, app
);
1764 switch (usess
->buffer_type
) {
1765 case LTTNG_BUFFER_PER_PID
:
1766 /* Init local registry. */
1767 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1772 case LTTNG_BUFFER_PER_UID
:
1773 /* Look for a global registry. If none exists, create one. */
1774 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1785 health_code_update();
1787 if (ua_sess
->handle
== -1) {
1788 ret
= ustctl_create_session(app
->sock
);
1790 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1791 ERR("Creating session for app pid %d with ret %d",
1794 DBG("UST app creating session failed. Application is dead");
1796 * This is normal behavior, an application can die during the
1797 * creation process. Don't report an error so the execution can
1798 * continue normally. This will get flagged ENOTCONN and the
1799 * caller will handle it.
1803 delete_ust_app_session(-1, ua_sess
, app
);
1804 if (ret
!= -ENOMEM
) {
1806 * Tracer is probably gone or got an internal error so let's
1807 * behave like it will soon unregister or not usable.
1814 ua_sess
->handle
= ret
;
1816 /* Add ust app session to app's HT */
1817 lttng_ht_node_init_u64(&ua_sess
->node
,
1818 ua_sess
->tracing_id
);
1819 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1821 DBG2("UST app session created successfully with handle %d", ret
);
1824 *ua_sess_ptr
= ua_sess
;
1826 *is_created
= created
;
1829 /* Everything went well. */
1833 health_code_update();
1838 * Create a context for the channel on the tracer.
1840 * Called with UST app session lock held and a RCU read side lock.
1843 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1844 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1845 struct ust_app
*app
)
1848 struct lttng_ht_iter iter
;
1849 struct lttng_ht_node_ulong
*node
;
1850 struct ust_app_ctx
*ua_ctx
;
1852 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1854 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1855 node
= lttng_ht_iter_get_node_ulong(&iter
);
1861 ua_ctx
= alloc_ust_app_ctx(uctx
);
1862 if (ua_ctx
== NULL
) {
1868 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1869 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1870 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1872 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1882 * Enable on the tracer side a ust app event for the session and channel.
1884 * Called with UST app session lock held.
1887 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1888 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1892 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1897 ua_event
->enabled
= 1;
1904 * Disable on the tracer side a ust app event for the session and channel.
1906 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1907 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1911 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1916 ua_event
->enabled
= 0;
1923 * Lookup ust app channel for session and disable it on the tracer side.
1926 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1927 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1931 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1936 ua_chan
->enabled
= 0;
1943 * Lookup ust app channel for session and enable it on the tracer side. This
1944 * MUST be called with a RCU read side lock acquired.
1946 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1947 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1950 struct lttng_ht_iter iter
;
1951 struct lttng_ht_node_str
*ua_chan_node
;
1952 struct ust_app_channel
*ua_chan
;
1954 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1955 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1956 if (ua_chan_node
== NULL
) {
1957 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1958 uchan
->name
, ua_sess
->tracing_id
);
1962 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1964 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1974 * Ask the consumer to create a channel and get it if successful.
1976 * Return 0 on success or else a negative value.
1978 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1979 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1980 int bitness
, struct ust_registry_session
*registry
)
1983 unsigned int nb_fd
= 0;
1984 struct consumer_socket
*socket
;
1992 health_code_update();
1994 /* Get the right consumer socket for the application. */
1995 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2001 health_code_update();
2003 /* Need one fd for the channel. */
2004 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2006 ERR("Exhausted number of available FD upon create channel");
2011 * Ask consumer to create channel. The consumer will return the number of
2012 * stream we have to expect.
2014 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2021 * Compute the number of fd needed before receiving them. It must be 2 per
2022 * stream (2 being the default value here).
2024 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2026 /* Reserve the amount of file descriptor we need. */
2027 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2029 ERR("Exhausted number of available FD upon create channel");
2030 goto error_fd_get_stream
;
2033 health_code_update();
2036 * Now get the channel from the consumer. This call wil populate the stream
2037 * list of that channel and set the ust objects.
2039 if (usess
->consumer
->enabled
) {
2040 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2050 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2051 error_fd_get_stream
:
2053 * Initiate a destroy channel on the consumer since we had an error
2054 * handling it on our side. The return value is of no importance since we
2055 * already have a ret value set by the previous error that we need to
2058 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2060 lttng_fd_put(LTTNG_FD_APPS
, 1);
2062 health_code_update();
2068 * Duplicate the ust data object of the ust app stream and save it in the
2069 * buffer registry stream.
2071 * Return 0 on success or else a negative value.
2073 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2074 struct ust_app_stream
*stream
)
2081 /* Reserve the amount of file descriptor we need. */
2082 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2084 ERR("Exhausted number of available FD upon duplicate stream");
2088 /* Duplicate object for stream once the original is in the registry. */
2089 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2090 reg_stream
->obj
.ust
);
2092 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2093 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2094 lttng_fd_put(LTTNG_FD_APPS
, 2);
2097 stream
->handle
= stream
->obj
->handle
;
2104 * Duplicate the ust data object of the ust app. channel and save it in the
2105 * buffer registry channel.
2107 * Return 0 on success or else a negative value.
2109 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2110 struct ust_app_channel
*ua_chan
)
2117 /* Need two fds for the channel. */
2118 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2120 ERR("Exhausted number of available FD upon duplicate channel");
2124 /* Duplicate object for stream once the original is in the registry. */
2125 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2127 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2128 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2131 ua_chan
->handle
= ua_chan
->obj
->handle
;
2136 lttng_fd_put(LTTNG_FD_APPS
, 1);
2142 * For a given channel buffer registry, setup all streams of the given ust
2143 * application channel.
2145 * Return 0 on success or else a negative value.
2147 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2148 struct ust_app_channel
*ua_chan
)
2151 struct ust_app_stream
*stream
, *stmp
;
2156 DBG2("UST app setup buffer registry stream");
2158 /* Send all streams to application. */
2159 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2160 struct buffer_reg_stream
*reg_stream
;
2162 ret
= buffer_reg_stream_create(®_stream
);
2168 * Keep original pointer and nullify it in the stream so the delete
2169 * stream call does not release the object.
2171 reg_stream
->obj
.ust
= stream
->obj
;
2173 buffer_reg_stream_add(reg_stream
, reg_chan
);
2175 /* We don't need the streams anymore. */
2176 cds_list_del(&stream
->list
);
2177 delete_ust_app_stream(-1, stream
);
2185 * Create a buffer registry channel for the given session registry and
2186 * application channel object. If regp pointer is valid, it's set with the
2187 * created object. Important, the created object is NOT added to the session
2188 * registry hash table.
2190 * Return 0 on success else a negative value.
2192 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2193 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2196 struct buffer_reg_channel
*reg_chan
= NULL
;
2201 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2203 /* Create buffer registry channel. */
2204 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2209 reg_chan
->consumer_key
= ua_chan
->key
;
2211 /* Create and add a channel registry to session. */
2212 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2213 ua_chan
->tracing_channel_id
);
2217 buffer_reg_channel_add(reg_sess
, reg_chan
);
2226 /* Safe because the registry channel object was not added to any HT. */
2227 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2233 * Setup buffer registry channel for the given session registry and application
2234 * channel object. If regp pointer is valid, it's set with the created object.
2236 * Return 0 on success else a negative value.
2238 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2239 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2246 assert(ua_chan
->obj
);
2248 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2250 /* Setup all streams for the registry. */
2251 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2256 reg_chan
->obj
.ust
= ua_chan
->obj
;
2257 ua_chan
->obj
= NULL
;
2262 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2263 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2268 * Send buffer registry channel to the application.
2270 * Return 0 on success else a negative value.
2272 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2273 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2274 struct ust_app_channel
*ua_chan
)
2277 struct buffer_reg_stream
*reg_stream
;
2284 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2286 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2291 /* Send channel to the application. */
2292 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2297 health_code_update();
2299 /* Send all streams to application. */
2300 pthread_mutex_lock(®_chan
->stream_list_lock
);
2301 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2302 struct ust_app_stream stream
;
2304 ret
= duplicate_stream_object(reg_stream
, &stream
);
2306 goto error_stream_unlock
;
2309 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2311 (void) release_ust_app_stream(-1, &stream
);
2312 goto error_stream_unlock
;
2316 * The return value is not important here. This function will output an
2319 (void) release_ust_app_stream(-1, &stream
);
2321 ua_chan
->is_sent
= 1;
2323 error_stream_unlock
:
2324 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2330 * Create and send to the application the created buffers with per UID buffers.
2332 * Return 0 on success else a negative value.
2334 static int create_channel_per_uid(struct ust_app
*app
,
2335 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2336 struct ust_app_channel
*ua_chan
)
2339 struct buffer_reg_uid
*reg_uid
;
2340 struct buffer_reg_channel
*reg_chan
;
2347 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2349 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2351 * The session creation handles the creation of this global registry
2352 * object. If none can be find, there is a code flow problem or a
2357 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2360 /* Create the buffer registry channel object. */
2361 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2368 * Create the buffers on the consumer side. This call populates the
2369 * ust app channel object with all streams and data object.
2371 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2372 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2375 * Let's remove the previously created buffer registry channel so
2376 * it's not visible anymore in the session registry.
2378 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2379 ua_chan
->tracing_channel_id
);
2380 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2381 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2386 * Setup the streams and add it to the session registry.
2388 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2395 /* Send buffers to the application. */
2396 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2406 * Create and send to the application the created buffers with per PID buffers.
2408 * Return 0 on success else a negative value.
2410 static int create_channel_per_pid(struct ust_app
*app
,
2411 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2412 struct ust_app_channel
*ua_chan
)
2415 struct ust_registry_session
*registry
;
2422 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2426 registry
= get_session_registry(ua_sess
);
2429 /* Create and add a new channel registry to session. */
2430 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2435 /* Create and get channel on the consumer side. */
2436 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2437 app
->bits_per_long
, registry
);
2442 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2453 * From an already allocated ust app channel, create the channel buffers if
2454 * need and send it to the application. This MUST be called with a RCU read
2455 * side lock acquired.
2457 * Return 0 on success or else a negative value.
2459 static int do_create_channel(struct ust_app
*app
,
2460 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2461 struct ust_app_channel
*ua_chan
)
2470 /* Handle buffer type before sending the channel to the application. */
2471 switch (usess
->buffer_type
) {
2472 case LTTNG_BUFFER_PER_UID
:
2474 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2480 case LTTNG_BUFFER_PER_PID
:
2482 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2494 /* Initialize ust objd object using the received handle and add it. */
2495 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2496 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2498 /* If channel is not enabled, disable it on the tracer */
2499 if (!ua_chan
->enabled
) {
2500 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2511 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2512 * newly created channel if not NULL.
2514 * Called with UST app session lock and RCU read-side lock held.
2516 * Return 0 on success or else a negative value.
2518 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2519 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2520 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2521 struct ust_app_channel
**ua_chanp
)
2524 struct lttng_ht_iter iter
;
2525 struct lttng_ht_node_str
*ua_chan_node
;
2526 struct ust_app_channel
*ua_chan
;
2528 /* Lookup channel in the ust app session */
2529 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2530 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2531 if (ua_chan_node
!= NULL
) {
2532 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2536 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2537 if (ua_chan
== NULL
) {
2538 /* Only malloc can fail here */
2542 shadow_copy_channel(ua_chan
, uchan
);
2544 /* Set channel type. */
2545 ua_chan
->attr
.type
= type
;
2547 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2552 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2555 /* Only add the channel if successful on the tracer side. */
2556 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2560 *ua_chanp
= ua_chan
;
2563 /* Everything went well. */
2567 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2573 * Create UST app event and create it on the tracer side.
2575 * Called with ust app session mutex held.
2578 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2579 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2580 struct ust_app
*app
)
2583 struct ust_app_event
*ua_event
;
2585 /* Get event node */
2586 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2587 uevent
->filter
, uevent
->attr
.loglevel
);
2588 if (ua_event
!= NULL
) {
2593 /* Does not exist so create one */
2594 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2595 if (ua_event
== NULL
) {
2596 /* Only malloc can failed so something is really wrong */
2600 shadow_copy_event(ua_event
, uevent
);
2602 /* Create it on the tracer side */
2603 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2605 /* Not found previously means that it does not exist on the tracer */
2606 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2610 add_unique_ust_app_event(ua_chan
, ua_event
);
2612 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2619 /* Valid. Calling here is already in a read side lock */
2620 delete_ust_app_event(-1, ua_event
);
2625 * Create UST metadata and open it on the tracer side.
2627 * Called with UST app session lock held and RCU read side lock.
2629 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2630 struct ust_app
*app
, struct consumer_output
*consumer
,
2631 struct ustctl_consumer_channel_attr
*attr
)
2634 struct ust_app_channel
*metadata
;
2635 struct consumer_socket
*socket
;
2636 struct ust_registry_session
*registry
;
2642 registry
= get_session_registry(ua_sess
);
2645 /* Metadata already exists for this registry or it was closed previously */
2646 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2651 /* Allocate UST metadata */
2652 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2654 /* malloc() failed */
2660 /* Set default attributes for metadata. */
2661 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2662 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2663 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2664 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2665 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2666 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2667 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2669 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2670 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2671 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2674 /* Need one fd for the channel. */
2675 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2677 ERR("Exhausted number of available FD upon create metadata");
2681 /* Get the right consumer socket for the application. */
2682 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2685 goto error_consumer
;
2689 * Keep metadata key so we can identify it on the consumer side. Assign it
2690 * to the registry *before* we ask the consumer so we avoid the race of the
2691 * consumer requesting the metadata and the ask_channel call on our side
2692 * did not returned yet.
2694 registry
->metadata_key
= metadata
->key
;
2697 * Ask the metadata channel creation to the consumer. The metadata object
2698 * will be created by the consumer and kept their. However, the stream is
2699 * never added or monitored until we do a first push metadata to the
2702 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2705 /* Nullify the metadata key so we don't try to close it later on. */
2706 registry
->metadata_key
= 0;
2707 goto error_consumer
;
2711 * The setup command will make the metadata stream be sent to the relayd,
2712 * if applicable, and the thread managing the metadatas. This is important
2713 * because after this point, if an error occurs, the only way the stream
2714 * can be deleted is to be monitored in the consumer.
2716 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2718 /* Nullify the metadata key so we don't try to close it later on. */
2719 registry
->metadata_key
= 0;
2720 goto error_consumer
;
2723 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2724 metadata
->key
, app
->pid
);
2727 lttng_fd_put(LTTNG_FD_APPS
, 1);
2728 delete_ust_app_channel(-1, metadata
, app
);
2734 * Return pointer to traceable apps list.
2736 struct lttng_ht
*ust_app_get_ht(void)
2742 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2743 * acquired before calling this function.
2745 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2747 struct ust_app
*app
= NULL
;
2748 struct lttng_ht_node_ulong
*node
;
2749 struct lttng_ht_iter iter
;
2751 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2752 node
= lttng_ht_iter_get_node_ulong(&iter
);
2754 DBG2("UST app no found with pid %d", pid
);
2758 DBG2("Found UST app by pid %d", pid
);
2760 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2767 * Allocate and init an UST app object using the registration information and
2768 * the command socket. This is called when the command socket connects to the
2771 * The object is returned on success or else NULL.
2773 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2775 struct ust_app
*lta
= NULL
;
2780 DBG3("UST app creating application for socket %d", sock
);
2782 if ((msg
->bits_per_long
== 64 &&
2783 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2784 || (msg
->bits_per_long
== 32 &&
2785 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2786 ERR("Registration failed: application \"%s\" (pid: %d) has "
2787 "%d-bit long, but no consumerd for this size is available.\n",
2788 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2792 lta
= zmalloc(sizeof(struct ust_app
));
2798 lta
->ppid
= msg
->ppid
;
2799 lta
->uid
= msg
->uid
;
2800 lta
->gid
= msg
->gid
;
2802 lta
->bits_per_long
= msg
->bits_per_long
;
2803 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2804 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2805 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2806 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2807 lta
->long_alignment
= msg
->long_alignment
;
2808 lta
->byte_order
= msg
->byte_order
;
2810 lta
->v_major
= msg
->major
;
2811 lta
->v_minor
= msg
->minor
;
2812 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2813 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2814 lta
->notify_sock
= -1;
2816 /* Copy name and make sure it's NULL terminated. */
2817 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2818 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2821 * Before this can be called, when receiving the registration information,
2822 * the application compatibility is checked. So, at this point, the
2823 * application can work with this session daemon.
2825 lta
->compatible
= 1;
2827 lta
->pid
= msg
->pid
;
2828 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2830 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2832 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2839 * For a given application object, add it to every hash table.
2841 void ust_app_add(struct ust_app
*app
)
2844 assert(app
->notify_sock
>= 0);
2849 * On a re-registration, we want to kick out the previous registration of
2852 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2855 * The socket _should_ be unique until _we_ call close. So, a add_unique
2856 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2857 * already in the table.
2859 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2861 /* Add application to the notify socket hash table. */
2862 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2863 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2865 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2866 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2867 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2874 * Set the application version into the object.
2876 * Return 0 on success else a negative value either an errno code or a
2877 * LTTng-UST error code.
2879 int ust_app_version(struct ust_app
*app
)
2885 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2887 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2888 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2890 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2898 * Unregister app by removing it from the global traceable app list and freeing
2901 * The socket is already closed at this point so no close to sock.
2903 void ust_app_unregister(int sock
)
2905 struct ust_app
*lta
;
2906 struct lttng_ht_node_ulong
*node
;
2907 struct lttng_ht_iter iter
;
2908 struct ust_app_session
*ua_sess
;
2913 /* Get the node reference for a call_rcu */
2914 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2915 node
= lttng_ht_iter_get_node_ulong(&iter
);
2918 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2919 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2921 /* Remove application from PID hash table */
2922 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2926 * Remove application from notify hash table. The thread handling the
2927 * notify socket could have deleted the node so ignore on error because
2928 * either way it's valid. The close of that socket is handled by the other
2931 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2932 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2935 * Ignore return value since the node might have been removed before by an
2936 * add replace during app registration because the PID can be reassigned by
2939 iter
.iter
.node
= <a
->pid_n
.node
;
2940 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2942 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2946 /* Remove sessions so they are not visible during deletion.*/
2947 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2949 struct ust_registry_session
*registry
;
2951 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2953 /* The session was already removed so scheduled for teardown. */
2958 * Add session to list for teardown. This is safe since at this point we
2959 * are the only one using this list.
2961 pthread_mutex_lock(&ua_sess
->lock
);
2964 * Normally, this is done in the delete session process which is
2965 * executed in the call rcu below. However, upon registration we can't
2966 * afford to wait for the grace period before pushing data or else the
2967 * data pending feature can race between the unregistration and stop
2968 * command where the data pending command is sent *before* the grace
2971 * The close metadata below nullifies the metadata pointer in the
2972 * session so the delete session will NOT push/close a second time.
2974 registry
= get_session_registry(ua_sess
);
2975 if (registry
&& !registry
->metadata_closed
) {
2976 /* Push metadata for application before freeing the application. */
2977 (void) push_metadata(registry
, ua_sess
->consumer
);
2980 * Don't ask to close metadata for global per UID buffers. Close
2981 * metadata only on destroy trace session in this case. Also, the
2982 * previous push metadata could have flag the metadata registry to
2983 * close so don't send a close command if closed.
2985 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2986 !registry
->metadata_closed
) {
2987 /* And ask to close it for this session registry. */
2988 (void) close_metadata(registry
, ua_sess
->consumer
);
2992 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2993 pthread_mutex_unlock(&ua_sess
->lock
);
2997 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3004 * Return traceable_app_count
3006 unsigned long ust_app_list_count(void)
3008 unsigned long count
;
3011 count
= lttng_ht_get_count(ust_app_ht
);
3018 * Fill events array with all events name of all registered apps.
3020 int ust_app_list_events(struct lttng_event
**events
)
3023 size_t nbmem
, count
= 0;
3024 struct lttng_ht_iter iter
;
3025 struct ust_app
*app
;
3026 struct lttng_event
*tmp_event
;
3028 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3029 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3030 if (tmp_event
== NULL
) {
3031 PERROR("zmalloc ust app events");
3038 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3039 struct lttng_ust_tracepoint_iter uiter
;
3041 health_code_update();
3043 if (!app
->compatible
) {
3045 * TODO: In time, we should notice the caller of this error by
3046 * telling him that this is a version error.
3050 handle
= ustctl_tracepoint_list(app
->sock
);
3052 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3053 ERR("UST app list events getting handle failed for app pid %d",
3059 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3060 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3061 /* Handle ustctl error. */
3064 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3065 ERR("UST app tp list get failed for app %d with ret %d",
3068 DBG3("UST app tp list get failed. Application is dead");
3070 * This is normal behavior, an application can die during the
3071 * creation process. Don't report an error so the execution can
3072 * continue normally. Continue normal execution.
3079 health_code_update();
3080 if (count
>= nbmem
) {
3081 /* In case the realloc fails, we free the memory */
3084 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3087 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3089 PERROR("realloc ust app events");
3096 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3097 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3098 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3099 tmp_event
[count
].pid
= app
->pid
;
3100 tmp_event
[count
].enabled
= -1;
3106 *events
= tmp_event
;
3108 DBG2("UST app list events done (%zu events)", count
);
3113 health_code_update();
3118 * Fill events array with all events name of all registered apps.
3120 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3123 size_t nbmem
, count
= 0;
3124 struct lttng_ht_iter iter
;
3125 struct ust_app
*app
;
3126 struct lttng_event_field
*tmp_event
;
3128 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3129 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3130 if (tmp_event
== NULL
) {
3131 PERROR("zmalloc ust app event fields");
3138 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3139 struct lttng_ust_field_iter uiter
;
3141 health_code_update();
3143 if (!app
->compatible
) {
3145 * TODO: In time, we should notice the caller of this error by
3146 * telling him that this is a version error.
3150 handle
= ustctl_tracepoint_field_list(app
->sock
);
3152 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3153 ERR("UST app list field getting handle failed for app pid %d",
3159 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3160 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3161 /* Handle ustctl error. */
3164 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3165 ERR("UST app tp list field failed for app %d with ret %d",
3168 DBG3("UST app tp list field failed. Application is dead");
3170 * This is normal behavior, an application can die during the
3171 * creation process. Don't report an error so the execution can
3172 * continue normally.
3179 health_code_update();
3180 if (count
>= nbmem
) {
3181 /* In case the realloc fails, we free the memory */
3184 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3187 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3189 PERROR("realloc ust app event fields");
3197 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3198 /* Mapping between these enums matches 1 to 1. */
3199 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3200 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3202 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3203 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3204 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3205 tmp_event
[count
].event
.pid
= app
->pid
;
3206 tmp_event
[count
].event
.enabled
= -1;
3212 *fields
= tmp_event
;
3214 DBG2("UST app list event fields done (%zu events)", count
);
3219 health_code_update();
3224 * Free and clean all traceable apps of the global list.
3226 * Should _NOT_ be called with RCU read-side lock held.
3228 void ust_app_clean_list(void)
3231 struct ust_app
*app
;
3232 struct lttng_ht_iter iter
;
3234 DBG2("UST app cleaning registered apps hash table");
3238 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3239 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3241 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3244 /* Cleanup socket hash table */
3245 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3247 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3251 /* Cleanup notify socket hash table */
3252 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3253 notify_sock_n
.node
) {
3254 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3259 /* Destroy is done only when the ht is empty */
3260 ht_cleanup_push(ust_app_ht
);
3261 ht_cleanup_push(ust_app_ht_by_sock
);
3262 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3266 * Init UST app hash table.
3268 void ust_app_ht_alloc(void)
3270 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3271 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3272 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3276 * For a specific UST session, disable the channel for all registered apps.
3278 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3279 struct ltt_ust_channel
*uchan
)
3282 struct lttng_ht_iter iter
;
3283 struct lttng_ht_node_str
*ua_chan_node
;
3284 struct ust_app
*app
;
3285 struct ust_app_session
*ua_sess
;
3286 struct ust_app_channel
*ua_chan
;
3288 if (usess
== NULL
|| uchan
== NULL
) {
3289 ERR("Disabling UST global channel with NULL values");
3294 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3295 uchan
->name
, usess
->id
);
3299 /* For every registered applications */
3300 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3301 struct lttng_ht_iter uiter
;
3302 if (!app
->compatible
) {
3304 * TODO: In time, we should notice the caller of this error by
3305 * telling him that this is a version error.
3309 ua_sess
= lookup_session_by_app(usess
, app
);
3310 if (ua_sess
== NULL
) {
3315 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3316 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3317 /* If the session if found for the app, the channel must be there */
3318 assert(ua_chan_node
);
3320 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3321 /* The channel must not be already disabled */
3322 assert(ua_chan
->enabled
== 1);
3324 /* Disable channel onto application */
3325 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3327 /* XXX: We might want to report this error at some point... */
3339 * For a specific UST session, enable the channel for all registered apps.
3341 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3342 struct ltt_ust_channel
*uchan
)
3345 struct lttng_ht_iter iter
;
3346 struct ust_app
*app
;
3347 struct ust_app_session
*ua_sess
;
3349 if (usess
== NULL
|| uchan
== NULL
) {
3350 ERR("Adding UST global channel to NULL values");
3355 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3356 uchan
->name
, usess
->id
);
3360 /* For every registered applications */
3361 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3362 if (!app
->compatible
) {
3364 * TODO: In time, we should notice the caller of this error by
3365 * telling him that this is a version error.
3369 ua_sess
= lookup_session_by_app(usess
, app
);
3370 if (ua_sess
== NULL
) {
3374 /* Enable channel onto application */
3375 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3377 /* XXX: We might want to report this error at some point... */
3389 * Disable an event in a channel and for a specific session.
3391 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3392 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3395 struct lttng_ht_iter iter
, uiter
;
3396 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3397 struct ust_app
*app
;
3398 struct ust_app_session
*ua_sess
;
3399 struct ust_app_channel
*ua_chan
;
3400 struct ust_app_event
*ua_event
;
3402 DBG("UST app disabling event %s for all apps in channel "
3403 "%s for session id %" PRIu64
,
3404 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3408 /* For all registered applications */
3409 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3410 if (!app
->compatible
) {
3412 * TODO: In time, we should notice the caller of this error by
3413 * telling him that this is a version error.
3417 ua_sess
= lookup_session_by_app(usess
, app
);
3418 if (ua_sess
== NULL
) {
3423 /* Lookup channel in the ust app session */
3424 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3425 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3426 if (ua_chan_node
== NULL
) {
3427 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3428 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3431 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3433 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3434 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3435 if (ua_event_node
== NULL
) {
3436 DBG2("Event %s not found in channel %s for app pid %d."
3437 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3440 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3442 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3444 /* XXX: Report error someday... */
3455 * For a specific UST session and UST channel, the event for all
3458 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3459 struct ltt_ust_channel
*uchan
)
3462 struct lttng_ht_iter iter
, uiter
;
3463 struct lttng_ht_node_str
*ua_chan_node
;
3464 struct ust_app
*app
;
3465 struct ust_app_session
*ua_sess
;
3466 struct ust_app_channel
*ua_chan
;
3467 struct ust_app_event
*ua_event
;
3469 DBG("UST app disabling all event for all apps in channel "
3470 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3474 /* For all registered applications */
3475 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3476 if (!app
->compatible
) {
3478 * TODO: In time, we should notice the caller of this error by
3479 * telling him that this is a version error.
3483 ua_sess
= lookup_session_by_app(usess
, app
);
3485 /* The application has problem or is probably dead. */
3489 /* Lookup channel in the ust app session */
3490 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3491 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3492 /* If the channel is not found, there is a code flow error */
3493 assert(ua_chan_node
);
3495 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3497 /* Disable each events of channel */
3498 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3500 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3502 /* XXX: Report error someday... */
3514 * For a specific UST session, create the channel for all registered apps.
3516 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3517 struct ltt_ust_channel
*uchan
)
3519 int ret
= 0, created
;
3520 struct lttng_ht_iter iter
;
3521 struct ust_app
*app
;
3522 struct ust_app_session
*ua_sess
= NULL
;
3524 /* Very wrong code flow */
3528 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3529 uchan
->name
, usess
->id
);
3533 /* For every registered applications */
3534 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3535 if (!app
->compatible
) {
3537 * TODO: In time, we should notice the caller of this error by
3538 * telling him that this is a version error.
3543 * Create session on the tracer side and add it to app session HT. Note
3544 * that if session exist, it will simply return a pointer to the ust
3547 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3552 * The application's socket is not valid. Either a bad socket
3553 * or a timeout on it. We can't inform the caller that for a
3554 * specific app, the session failed so lets continue here.
3559 goto error_rcu_unlock
;
3564 pthread_mutex_lock(&ua_sess
->lock
);
3565 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3566 sizeof(uchan
->name
))) {
3567 struct ustctl_consumer_channel_attr attr
;
3568 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3569 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3572 /* Create channel onto application. We don't need the chan ref. */
3573 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3574 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3576 pthread_mutex_unlock(&ua_sess
->lock
);
3578 if (ret
== -ENOMEM
) {
3579 /* No more memory is a fatal error. Stop right now. */
3580 goto error_rcu_unlock
;
3582 /* Cleanup the created session if it's the case. */
3584 destroy_app_session(app
, ua_sess
);
3595 * Enable event for a specific session and channel on the tracer.
3597 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3598 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3601 struct lttng_ht_iter iter
, uiter
;
3602 struct lttng_ht_node_str
*ua_chan_node
;
3603 struct ust_app
*app
;
3604 struct ust_app_session
*ua_sess
;
3605 struct ust_app_channel
*ua_chan
;
3606 struct ust_app_event
*ua_event
;
3608 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3609 uevent
->attr
.name
, usess
->id
);
3612 * NOTE: At this point, this function is called only if the session and
3613 * channel passed are already created for all apps. and enabled on the
3619 /* For all registered applications */
3620 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3621 if (!app
->compatible
) {
3623 * TODO: In time, we should notice the caller of this error by
3624 * telling him that this is a version error.
3628 ua_sess
= lookup_session_by_app(usess
, app
);
3630 /* The application has problem or is probably dead. */
3634 pthread_mutex_lock(&ua_sess
->lock
);
3636 /* Lookup channel in the ust app session */
3637 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3638 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3639 /* If the channel is not found, there is a code flow error */
3640 assert(ua_chan_node
);
3642 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3644 /* Get event node */
3645 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3646 uevent
->filter
, uevent
->attr
.loglevel
);
3647 if (ua_event
== NULL
) {
3648 DBG3("UST app enable event %s not found for app PID %d."
3649 "Skipping app", uevent
->attr
.name
, app
->pid
);
3653 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3655 pthread_mutex_unlock(&ua_sess
->lock
);
3659 pthread_mutex_unlock(&ua_sess
->lock
);
3668 * For a specific existing UST session and UST channel, creates the event for
3669 * all registered apps.
3671 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3672 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3675 struct lttng_ht_iter iter
, uiter
;
3676 struct lttng_ht_node_str
*ua_chan_node
;
3677 struct ust_app
*app
;
3678 struct ust_app_session
*ua_sess
;
3679 struct ust_app_channel
*ua_chan
;
3681 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3682 uevent
->attr
.name
, usess
->id
);
3686 /* For all registered applications */
3687 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3688 if (!app
->compatible
) {
3690 * TODO: In time, we should notice the caller of this error by
3691 * telling him that this is a version error.
3695 ua_sess
= lookup_session_by_app(usess
, app
);
3697 /* The application has problem or is probably dead. */
3701 pthread_mutex_lock(&ua_sess
->lock
);
3702 /* Lookup channel in the ust app session */
3703 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3704 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3705 /* If the channel is not found, there is a code flow error */
3706 assert(ua_chan_node
);
3708 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3710 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3711 pthread_mutex_unlock(&ua_sess
->lock
);
3713 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3714 /* Possible value at this point: -ENOMEM. If so, we stop! */
3717 DBG2("UST app event %s already exist on app PID %d",
3718 uevent
->attr
.name
, app
->pid
);
3729 * Start tracing for a specific UST session and app.
3732 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3735 struct ust_app_session
*ua_sess
;
3737 DBG("Starting tracing for ust app pid %d", app
->pid
);
3741 if (!app
->compatible
) {
3745 ua_sess
= lookup_session_by_app(usess
, app
);
3746 if (ua_sess
== NULL
) {
3747 /* The session is in teardown process. Ignore and continue. */
3751 pthread_mutex_lock(&ua_sess
->lock
);
3753 /* Upon restart, we skip the setup, already done */
3754 if (ua_sess
->started
) {
3758 /* Create directories if consumer is LOCAL and has a path defined. */
3759 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3760 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3761 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3762 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3764 if (ret
!= -EEXIST
) {
3765 ERR("Trace directory creation error");
3772 * Create the metadata for the application. This returns gracefully if a
3773 * metadata was already set for the session.
3775 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3780 health_code_update();
3783 /* This start the UST tracing */
3784 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3786 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3787 ERR("Error starting tracing for app pid: %d (ret: %d)",
3790 DBG("UST app start session failed. Application is dead.");
3792 * This is normal behavior, an application can die during the
3793 * creation process. Don't report an error so the execution can
3794 * continue normally.
3796 pthread_mutex_unlock(&ua_sess
->lock
);
3802 /* Indicate that the session has been started once */
3803 ua_sess
->started
= 1;
3805 pthread_mutex_unlock(&ua_sess
->lock
);
3807 health_code_update();
3809 /* Quiescent wait after starting trace */
3810 ret
= ustctl_wait_quiescent(app
->sock
);
3811 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3812 ERR("UST app wait quiescent failed for app pid %d ret %d",
3818 health_code_update();
3822 pthread_mutex_unlock(&ua_sess
->lock
);
3824 health_code_update();
3829 * Stop tracing for a specific UST session and app.
3832 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3835 struct ust_app_session
*ua_sess
;
3836 struct ust_registry_session
*registry
;
3838 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3842 if (!app
->compatible
) {
3843 goto end_no_session
;
3846 ua_sess
= lookup_session_by_app(usess
, app
);
3847 if (ua_sess
== NULL
) {
3848 goto end_no_session
;
3851 pthread_mutex_lock(&ua_sess
->lock
);
3854 * If started = 0, it means that stop trace has been called for a session
3855 * that was never started. It's possible since we can have a fail start
3856 * from either the application manager thread or the command thread. Simply
3857 * indicate that this is a stop error.
3859 if (!ua_sess
->started
) {
3860 goto error_rcu_unlock
;
3863 health_code_update();
3865 /* This inhibits UST tracing */
3866 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3868 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3869 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3872 DBG("UST app stop session failed. Application is dead.");
3874 * This is normal behavior, an application can die during the
3875 * creation process. Don't report an error so the execution can
3876 * continue normally.
3880 goto error_rcu_unlock
;
3883 health_code_update();
3885 /* Quiescent wait after stopping trace */
3886 ret
= ustctl_wait_quiescent(app
->sock
);
3887 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3888 ERR("UST app wait quiescent failed for app pid %d ret %d",
3892 health_code_update();
3894 registry
= get_session_registry(ua_sess
);
3897 if (!registry
->metadata_closed
) {
3898 /* Push metadata for application before freeing the application. */
3899 (void) push_metadata(registry
, ua_sess
->consumer
);
3903 pthread_mutex_unlock(&ua_sess
->lock
);
3906 health_code_update();
3910 pthread_mutex_unlock(&ua_sess
->lock
);
3912 health_code_update();
3917 * Flush buffers for a specific UST session and app.
3920 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3923 struct lttng_ht_iter iter
;
3924 struct ust_app_session
*ua_sess
;
3925 struct ust_app_channel
*ua_chan
;
3927 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3931 if (!app
->compatible
) {
3932 goto end_no_session
;
3935 ua_sess
= lookup_session_by_app(usess
, app
);
3936 if (ua_sess
== NULL
) {
3937 goto end_no_session
;
3940 pthread_mutex_lock(&ua_sess
->lock
);
3942 health_code_update();
3944 /* Flushing buffers */
3945 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3947 health_code_update();
3948 assert(ua_chan
->is_sent
);
3949 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3951 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3952 ERR("UST app PID %d channel %s flush failed with ret %d",
3953 app
->pid
, ua_chan
->name
, ret
);
3955 DBG3("UST app failed to flush %s. Application is dead.",
3958 * This is normal behavior, an application can die during the
3959 * creation process. Don't report an error so the execution can
3960 * continue normally.
3963 /* Continuing flushing all buffers */
3968 health_code_update();
3970 pthread_mutex_unlock(&ua_sess
->lock
);
3973 health_code_update();
3978 * Destroy a specific UST session in apps.
3980 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3983 struct ust_app_session
*ua_sess
;
3984 struct lttng_ht_iter iter
;
3985 struct lttng_ht_node_u64
*node
;
3987 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3991 if (!app
->compatible
) {
3995 __lookup_session_by_app(usess
, app
, &iter
);
3996 node
= lttng_ht_iter_get_node_u64(&iter
);
3998 /* Session is being or is deleted. */
4001 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4003 health_code_update();
4004 destroy_app_session(app
, ua_sess
);
4006 health_code_update();
4008 /* Quiescent wait after stopping trace */
4009 ret
= ustctl_wait_quiescent(app
->sock
);
4010 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4011 ERR("UST app wait quiescent failed for app pid %d ret %d",
4016 health_code_update();
4021 * Start tracing for the UST session.
4023 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4026 struct lttng_ht_iter iter
;
4027 struct ust_app
*app
;
4029 DBG("Starting all UST traces");
4033 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4034 ret
= ust_app_start_trace(usess
, app
);
4036 /* Continue to next apps even on error */
4047 * Start tracing for the UST session.
4049 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4052 struct lttng_ht_iter iter
;
4053 struct ust_app
*app
;
4055 DBG("Stopping all UST traces");
4059 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4060 ret
= ust_app_stop_trace(usess
, app
);
4062 /* Continue to next apps even on error */
4067 /* Flush buffers and push metadata (for UID buffers). */
4068 switch (usess
->buffer_type
) {
4069 case LTTNG_BUFFER_PER_UID
:
4071 struct buffer_reg_uid
*reg
;
4073 /* Flush all per UID buffers associated to that session. */
4074 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4075 struct ust_registry_session
*ust_session_reg
;
4076 struct buffer_reg_channel
*reg_chan
;
4077 struct consumer_socket
*socket
;
4079 /* Get consumer socket to use to push the metadata.*/
4080 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4083 /* Ignore request if no consumer is found for the session. */
4087 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4088 reg_chan
, node
.node
) {
4090 * The following call will print error values so the return
4091 * code is of little importance because whatever happens, we
4092 * have to try them all.
4094 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4097 ust_session_reg
= reg
->registry
->reg
.ust
;
4098 if (!ust_session_reg
->metadata_closed
) {
4099 /* Push metadata. */
4100 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4106 case LTTNG_BUFFER_PER_PID
:
4107 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4108 ret
= ust_app_flush_trace(usess
, app
);
4110 /* Continue to next apps even on error */
4126 * Destroy app UST session.
4128 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4131 struct lttng_ht_iter iter
;
4132 struct ust_app
*app
;
4134 DBG("Destroy all UST traces");
4138 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4139 ret
= destroy_trace(usess
, app
);
4141 /* Continue to next apps even on error */
4152 * Add channels/events from UST global domain to registered apps at sock.
4154 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4157 struct lttng_ht_iter iter
, uiter
;
4158 struct ust_app
*app
;
4159 struct ust_app_session
*ua_sess
= NULL
;
4160 struct ust_app_channel
*ua_chan
;
4161 struct ust_app_event
*ua_event
;
4162 struct ust_app_ctx
*ua_ctx
;
4167 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4172 app
= find_app_by_sock(sock
);
4175 * Application can be unregistered before so this is possible hence
4176 * simply stopping the update.
4178 DBG3("UST app update failed to find app sock %d", sock
);
4182 if (!app
->compatible
) {
4186 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4188 /* Tracer is probably gone or ENOMEM. */
4193 pthread_mutex_lock(&ua_sess
->lock
);
4196 * We can iterate safely here over all UST app session since the create ust
4197 * app session above made a shadow copy of the UST global domain from the
4200 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4203 * For a metadata channel, handle it differently.
4205 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4206 sizeof(ua_chan
->name
))) {
4207 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4212 /* Remove it from the hash table and continue!. */
4213 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4215 delete_ust_app_channel(-1, ua_chan
, app
);
4218 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4221 * Stop everything. On error, the application failed, no more
4222 * file descriptor are available or ENOMEM so stopping here is
4223 * the only thing we can do for now.
4230 * Add context using the list so they are enabled in the same order the
4233 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4234 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4241 /* For each events */
4242 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4244 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4251 pthread_mutex_unlock(&ua_sess
->lock
);
4253 if (usess
->start_trace
) {
4254 ret
= ust_app_start_trace(usess
, app
);
4259 DBG2("UST trace started for app pid %d", app
->pid
);
4262 /* Everything went well at this point. */
4267 pthread_mutex_unlock(&ua_sess
->lock
);
4270 destroy_app_session(app
, ua_sess
);
4277 * Add context to a specific channel for global UST domain.
4279 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4280 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4283 struct lttng_ht_node_str
*ua_chan_node
;
4284 struct lttng_ht_iter iter
, uiter
;
4285 struct ust_app_channel
*ua_chan
= NULL
;
4286 struct ust_app_session
*ua_sess
;
4287 struct ust_app
*app
;
4291 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4292 if (!app
->compatible
) {
4294 * TODO: In time, we should notice the caller of this error by
4295 * telling him that this is a version error.
4299 ua_sess
= lookup_session_by_app(usess
, app
);
4300 if (ua_sess
== NULL
) {
4304 pthread_mutex_lock(&ua_sess
->lock
);
4305 /* Lookup channel in the ust app session */
4306 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4307 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4308 if (ua_chan_node
== NULL
) {
4311 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4313 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4318 pthread_mutex_unlock(&ua_sess
->lock
);
4326 * Enable event for a channel from a UST session for a specific PID.
4328 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4329 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4332 struct lttng_ht_iter iter
;
4333 struct lttng_ht_node_str
*ua_chan_node
;
4334 struct ust_app
*app
;
4335 struct ust_app_session
*ua_sess
;
4336 struct ust_app_channel
*ua_chan
;
4337 struct ust_app_event
*ua_event
;
4339 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4343 app
= ust_app_find_by_pid(pid
);
4345 ERR("UST app enable event per PID %d not found", pid
);
4350 if (!app
->compatible
) {
4355 ua_sess
= lookup_session_by_app(usess
, app
);
4357 /* The application has problem or is probably dead. */
4362 pthread_mutex_lock(&ua_sess
->lock
);
4363 /* Lookup channel in the ust app session */
4364 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4365 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4366 /* If the channel is not found, there is a code flow error */
4367 assert(ua_chan_node
);
4369 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4371 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4372 uevent
->filter
, uevent
->attr
.loglevel
);
4373 if (ua_event
== NULL
) {
4374 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4379 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4386 pthread_mutex_unlock(&ua_sess
->lock
);
4393 * Disable event for a channel from a UST session for a specific PID.
4395 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4396 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4399 struct lttng_ht_iter iter
;
4400 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4401 struct ust_app
*app
;
4402 struct ust_app_session
*ua_sess
;
4403 struct ust_app_channel
*ua_chan
;
4404 struct ust_app_event
*ua_event
;
4406 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4410 app
= ust_app_find_by_pid(pid
);
4412 ERR("UST app disable event per PID %d not found", pid
);
4417 if (!app
->compatible
) {
4422 ua_sess
= lookup_session_by_app(usess
, app
);
4424 /* The application has problem or is probably dead. */
4428 /* Lookup channel in the ust app session */
4429 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4430 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4431 if (ua_chan_node
== NULL
) {
4432 /* Channel does not exist, skip disabling */
4435 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4437 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4438 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4439 if (ua_event_node
== NULL
) {
4440 /* Event does not exist, skip disabling */
4443 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4445 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4456 * Calibrate registered applications.
4458 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4461 struct lttng_ht_iter iter
;
4462 struct ust_app
*app
;
4466 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4467 if (!app
->compatible
) {
4469 * TODO: In time, we should notice the caller of this error by
4470 * telling him that this is a version error.
4475 health_code_update();
4477 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4481 /* Means that it's not implemented on the tracer side. */
4485 DBG2("Calibrate app PID %d returned with error %d",
4492 DBG("UST app global domain calibration finished");
4496 health_code_update();
4502 * Receive registration and populate the given msg structure.
4504 * On success return 0 else a negative value returned by the ustctl call.
4506 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4509 uint32_t pid
, ppid
, uid
, gid
;
4513 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4514 &pid
, &ppid
, &uid
, &gid
,
4515 &msg
->bits_per_long
,
4516 &msg
->uint8_t_alignment
,
4517 &msg
->uint16_t_alignment
,
4518 &msg
->uint32_t_alignment
,
4519 &msg
->uint64_t_alignment
,
4520 &msg
->long_alignment
,
4527 case LTTNG_UST_ERR_EXITING
:
4528 DBG3("UST app recv reg message failed. Application died");
4530 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4531 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4532 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4533 LTTNG_UST_ABI_MINOR_VERSION
);
4536 ERR("UST app recv reg message failed with ret %d", ret
);
4541 msg
->pid
= (pid_t
) pid
;
4542 msg
->ppid
= (pid_t
) ppid
;
4543 msg
->uid
= (uid_t
) uid
;
4544 msg
->gid
= (gid_t
) gid
;
4551 * Return a ust app channel object using the application object and the channel
4552 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4553 * lock MUST be acquired before calling this function.
4555 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4558 struct lttng_ht_node_ulong
*node
;
4559 struct lttng_ht_iter iter
;
4560 struct ust_app_channel
*ua_chan
= NULL
;
4564 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4565 node
= lttng_ht_iter_get_node_ulong(&iter
);
4567 DBG2("UST app channel find by objd %d not found", objd
);
4571 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4578 * Reply to a register channel notification from an application on the notify
4579 * socket. The channel metadata is also created.
4581 * The session UST registry lock is acquired in this function.
4583 * On success 0 is returned else a negative value.
4585 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4586 size_t nr_fields
, struct ustctl_field
*fields
)
4588 int ret
, ret_code
= 0;
4589 uint32_t chan_id
, reg_count
;
4590 uint64_t chan_reg_key
;
4591 enum ustctl_channel_header type
;
4592 struct ust_app
*app
;
4593 struct ust_app_channel
*ua_chan
;
4594 struct ust_app_session
*ua_sess
;
4595 struct ust_registry_session
*registry
;
4596 struct ust_registry_channel
*chan_reg
;
4600 /* Lookup application. If not found, there is a code flow error. */
4601 app
= find_app_by_notify_sock(sock
);
4603 DBG("Application socket %d is being teardown. Abort event notify",
4607 goto error_rcu_unlock
;
4610 /* Lookup channel by UST object descriptor. */
4611 ua_chan
= find_channel_by_objd(app
, cobjd
);
4613 DBG("Application channel is being teardown. Abort event notify");
4616 goto error_rcu_unlock
;
4619 assert(ua_chan
->session
);
4620 ua_sess
= ua_chan
->session
;
4622 /* Get right session registry depending on the session buffer type. */
4623 registry
= get_session_registry(ua_sess
);
4626 /* Depending on the buffer type, a different channel key is used. */
4627 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4628 chan_reg_key
= ua_chan
->tracing_channel_id
;
4630 chan_reg_key
= ua_chan
->key
;
4633 pthread_mutex_lock(®istry
->lock
);
4635 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4638 if (!chan_reg
->register_done
) {
4639 reg_count
= ust_registry_get_event_count(chan_reg
);
4640 if (reg_count
< 31) {
4641 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4643 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4646 chan_reg
->nr_ctx_fields
= nr_fields
;
4647 chan_reg
->ctx_fields
= fields
;
4648 chan_reg
->header_type
= type
;
4650 /* Get current already assigned values. */
4651 type
= chan_reg
->header_type
;
4653 /* Set to NULL so the error path does not do a double free. */
4656 /* Channel id is set during the object creation. */
4657 chan_id
= chan_reg
->chan_id
;
4659 /* Append to metadata */
4660 if (!chan_reg
->metadata_dumped
) {
4661 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4663 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4669 DBG3("UST app replying to register channel key %" PRIu64
4670 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4673 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4675 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4676 ERR("UST app reply channel failed with ret %d", ret
);
4678 DBG3("UST app reply channel failed. Application died");
4683 /* This channel registry registration is completed. */
4684 chan_reg
->register_done
= 1;
4687 pthread_mutex_unlock(®istry
->lock
);
4697 * Add event to the UST channel registry. When the event is added to the
4698 * registry, the metadata is also created. Once done, this replies to the
4699 * application with the appropriate error code.
4701 * The session UST registry lock is acquired in the function.
4703 * On success 0 is returned else a negative value.
4705 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4706 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4707 char *model_emf_uri
)
4710 uint32_t event_id
= 0;
4711 uint64_t chan_reg_key
;
4712 struct ust_app
*app
;
4713 struct ust_app_channel
*ua_chan
;
4714 struct ust_app_session
*ua_sess
;
4715 struct ust_registry_session
*registry
;
4719 /* Lookup application. If not found, there is a code flow error. */
4720 app
= find_app_by_notify_sock(sock
);
4722 DBG("Application socket %d is being teardown. Abort event notify",
4727 free(model_emf_uri
);
4728 goto error_rcu_unlock
;
4731 /* Lookup channel by UST object descriptor. */
4732 ua_chan
= find_channel_by_objd(app
, cobjd
);
4734 DBG("Application channel is being teardown. Abort event notify");
4738 free(model_emf_uri
);
4739 goto error_rcu_unlock
;
4742 assert(ua_chan
->session
);
4743 ua_sess
= ua_chan
->session
;
4745 registry
= get_session_registry(ua_sess
);
4748 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4749 chan_reg_key
= ua_chan
->tracing_channel_id
;
4751 chan_reg_key
= ua_chan
->key
;
4754 pthread_mutex_lock(®istry
->lock
);
4757 * From this point on, this call acquires the ownership of the sig, fields
4758 * and model_emf_uri meaning any free are done inside it if needed. These
4759 * three variables MUST NOT be read/write after this.
4761 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4762 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4763 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4767 * The return value is returned to ustctl so in case of an error, the
4768 * application can be notified. In case of an error, it's important not to
4769 * return a negative error or else the application will get closed.
4771 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4773 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4774 ERR("UST app reply event failed with ret %d", ret
);
4776 DBG3("UST app reply event failed. Application died");
4779 * No need to wipe the create event since the application socket will
4780 * get close on error hence cleaning up everything by itself.
4785 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4789 pthread_mutex_unlock(®istry
->lock
);
4796 * Handle application notification through the given notify socket.
4798 * Return 0 on success or else a negative value.
4800 int ust_app_recv_notify(int sock
)
4803 enum ustctl_notify_cmd cmd
;
4805 DBG3("UST app receiving notify from sock %d", sock
);
4807 ret
= ustctl_recv_notify(sock
, &cmd
);
4809 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4810 ERR("UST app recv notify failed with ret %d", ret
);
4812 DBG3("UST app recv notify failed. Application died");
4818 case USTCTL_NOTIFY_CMD_EVENT
:
4820 int sobjd
, cobjd
, loglevel
;
4821 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4823 struct ustctl_field
*fields
;
4825 DBG2("UST app ustctl register event received");
4827 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4828 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4830 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4831 ERR("UST app recv event failed with ret %d", ret
);
4833 DBG3("UST app recv event failed. Application died");
4839 * Add event to the UST registry coming from the notify socket. This
4840 * call will free if needed the sig, fields and model_emf_uri. This
4841 * code path loses the ownsership of these variables and transfer them
4842 * to the this function.
4844 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4845 fields
, loglevel
, model_emf_uri
);
4852 case USTCTL_NOTIFY_CMD_CHANNEL
:
4856 struct ustctl_field
*fields
;
4858 DBG2("UST app ustctl register channel received");
4860 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4863 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4864 ERR("UST app recv channel failed with ret %d", ret
);
4866 DBG3("UST app recv channel failed. Application died");
4872 * The fields ownership are transfered to this function call meaning
4873 * that if needed it will be freed. After this, it's invalid to access
4874 * fields or clean it up.
4876 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4885 /* Should NEVER happen. */
4894 * Once the notify socket hangs up, this is called. First, it tries to find the
4895 * corresponding application. On failure, the call_rcu to close the socket is
4896 * executed. If an application is found, it tries to delete it from the notify
4897 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4899 * Note that an object needs to be allocated here so on ENOMEM failure, the
4900 * call RCU is not done but the rest of the cleanup is.
4902 void ust_app_notify_sock_unregister(int sock
)
4905 struct lttng_ht_iter iter
;
4906 struct ust_app
*app
;
4907 struct ust_app_notify_sock_obj
*obj
;
4913 obj
= zmalloc(sizeof(*obj
));
4916 * An ENOMEM is kind of uncool. If this strikes we continue the
4917 * procedure but the call_rcu will not be called. In this case, we
4918 * accept the fd leak rather than possibly creating an unsynchronized
4919 * state between threads.
4921 * TODO: The notify object should be created once the notify socket is
4922 * registered and stored independantely from the ust app object. The
4923 * tricky part is to synchronize the teardown of the application and
4924 * this notify object. Let's keep that in mind so we can avoid this
4925 * kind of shenanigans with ENOMEM in the teardown path.
4932 DBG("UST app notify socket unregister %d", sock
);
4935 * Lookup application by notify socket. If this fails, this means that the
4936 * hash table delete has already been done by the application
4937 * unregistration process so we can safely close the notify socket in a
4940 app
= find_app_by_notify_sock(sock
);
4945 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4948 * Whatever happens here either we fail or succeed, in both cases we have
4949 * to close the socket after a grace period to continue to the call RCU
4950 * here. If the deletion is successful, the application is not visible
4951 * anymore by other threads and is it fails it means that it was already
4952 * deleted from the hash table so either way we just have to close the
4955 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4961 * Close socket after a grace period to avoid for the socket to be reused
4962 * before the application object is freed creating potential race between
4963 * threads trying to add unique in the global hash table.
4966 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4971 * Destroy a ust app data structure and free its memory.
4973 void ust_app_destroy(struct ust_app
*app
)
4979 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);