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
);
476 pthread_mutex_unlock(®istry
->lock
);
483 * For a given application and session, push metadata to consumer. The session
484 * lock MUST be acquired here before calling this.
485 * Either sock or consumer is required : if sock is NULL, the default
486 * socket to send the metadata is retrieved from consumer, if sock
487 * is not NULL we use it to send the metadata.
489 * Return 0 on success else a negative error.
491 static int push_metadata(struct ust_registry_session
*registry
,
492 struct consumer_output
*consumer
)
496 struct consumer_socket
*socket
;
504 * Means that no metadata was assigned to the session. This can happens if
505 * no start has been done previously.
507 if (!registry
->metadata_key
) {
512 /* Get consumer socket to use to push the metadata.*/
513 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
517 goto error_rcu_unlock
;
521 * TODO: Currently, we hold the socket lock around sampling of the next
522 * metadata segment to ensure we send metadata over the consumer socket in
523 * the correct order. This makes the registry lock nest inside the socket
526 * Please note that this is a temporary measure: we should move this lock
527 * back into ust_consumer_push_metadata() when the consumer gets the
528 * ability to reorder the metadata it receives.
530 pthread_mutex_lock(socket
->lock
);
531 ret
= ust_app_push_metadata(registry
, socket
, 0);
532 pthread_mutex_unlock(socket
->lock
);
535 goto error_rcu_unlock
;
543 * On error, flag the registry that the metadata is closed. We were unable
544 * to push anything and this means that either the consumer is not
545 * responding or the metadata cache has been destroyed on the consumer.
547 registry
->metadata_closed
= 1;
554 * Send to the consumer a close metadata command for the given session. Once
555 * done, the metadata channel is deleted and the session metadata pointer is
556 * nullified. The session lock MUST be acquired here unless the application is
557 * in the destroy path.
559 * Return 0 on success else a negative value.
561 static int close_metadata(struct ust_registry_session
*registry
,
562 struct consumer_output
*consumer
)
565 struct consumer_socket
*socket
;
572 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
577 /* Get consumer socket to use to push the metadata.*/
578 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
585 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
592 * Metadata closed. Even on error this means that the consumer is not
593 * responding or not found so either way a second close should NOT be emit
596 registry
->metadata_closed
= 1;
603 * We need to execute ht_destroy outside of RCU read-side critical
604 * section and outside of call_rcu thread, so we postpone its execution
605 * using ht_cleanup_push. It is simpler than to change the semantic of
606 * the many callers of delete_ust_app_session().
609 void delete_ust_app_session_rcu(struct rcu_head
*head
)
611 struct ust_app_session
*ua_sess
=
612 caa_container_of(head
, struct ust_app_session
, rcu_head
);
614 ht_cleanup_push(ua_sess
->channels
);
619 * Delete ust app session safely. RCU read lock must be held before calling
623 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
627 struct lttng_ht_iter iter
;
628 struct ust_app_channel
*ua_chan
;
629 struct ust_registry_session
*registry
;
633 pthread_mutex_lock(&ua_sess
->lock
);
635 registry
= get_session_registry(ua_sess
);
636 if (registry
&& !registry
->metadata_closed
) {
637 /* Push metadata for application before freeing the application. */
638 (void) push_metadata(registry
, ua_sess
->consumer
);
641 * Don't ask to close metadata for global per UID buffers. Close
642 * metadata only on destroy trace session in this case. Also, the
643 * previous push metadata could have flag the metadata registry to
644 * close so don't send a close command if closed.
646 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
647 !registry
->metadata_closed
) {
648 /* And ask to close it for this session registry. */
649 (void) close_metadata(registry
, ua_sess
->consumer
);
653 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
655 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
657 delete_ust_app_channel(sock
, ua_chan
, app
);
660 /* In case of per PID, the registry is kept in the session. */
661 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
662 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
664 buffer_reg_pid_remove(reg_pid
);
665 buffer_reg_pid_destroy(reg_pid
);
669 if (ua_sess
->handle
!= -1) {
670 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
671 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
672 ERR("UST app sock %d release session handle failed with ret %d",
676 pthread_mutex_unlock(&ua_sess
->lock
);
678 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
682 * Delete a traceable application structure from the global list. Never call
683 * this function outside of a call_rcu call.
685 * RCU read side lock should _NOT_ be held when calling this function.
688 void delete_ust_app(struct ust_app
*app
)
691 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
693 /* Delete ust app sessions info */
698 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
700 /* Free every object in the session and the session. */
702 delete_ust_app_session(sock
, ua_sess
, app
);
706 ht_cleanup_push(app
->sessions
);
707 ht_cleanup_push(app
->ust_objd
);
710 * Wait until we have deleted the application from the sock hash table
711 * before closing this socket, otherwise an application could re-use the
712 * socket ID and race with the teardown, using the same hash table entry.
714 * It's OK to leave the close in call_rcu. We want it to stay unique for
715 * all RCU readers that could run concurrently with unregister app,
716 * therefore we _need_ to only close that socket after a grace period. So
717 * it should stay in this RCU callback.
719 * This close() is a very important step of the synchronization model so
720 * every modification to this function must be carefully reviewed.
726 lttng_fd_put(LTTNG_FD_APPS
, 1);
728 DBG2("UST app pid %d deleted", app
->pid
);
733 * URCU intermediate call to delete an UST app.
736 void delete_ust_app_rcu(struct rcu_head
*head
)
738 struct lttng_ht_node_ulong
*node
=
739 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
740 struct ust_app
*app
=
741 caa_container_of(node
, struct ust_app
, pid_n
);
743 DBG3("Call RCU deleting app PID %d", app
->pid
);
748 * Delete the session from the application ht and delete the data structure by
749 * freeing every object inside and releasing them.
751 static void destroy_app_session(struct ust_app
*app
,
752 struct ust_app_session
*ua_sess
)
755 struct lttng_ht_iter iter
;
760 iter
.iter
.node
= &ua_sess
->node
.node
;
761 ret
= lttng_ht_del(app
->sessions
, &iter
);
763 /* Already scheduled for teardown. */
767 /* Once deleted, free the data structure. */
768 delete_ust_app_session(app
->sock
, ua_sess
, app
);
775 * Alloc new UST app session.
778 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
780 struct ust_app_session
*ua_sess
;
782 /* Init most of the default value by allocating and zeroing */
783 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
784 if (ua_sess
== NULL
) {
789 ua_sess
->handle
= -1;
790 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
791 pthread_mutex_init(&ua_sess
->lock
, NULL
);
800 * Alloc new UST app channel.
803 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
804 struct ust_app_session
*ua_sess
,
805 struct lttng_ust_channel_attr
*attr
)
807 struct ust_app_channel
*ua_chan
;
809 /* Init most of the default value by allocating and zeroing */
810 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
811 if (ua_chan
== NULL
) {
816 /* Setup channel name */
817 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
818 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
820 ua_chan
->enabled
= 1;
821 ua_chan
->handle
= -1;
822 ua_chan
->session
= ua_sess
;
823 ua_chan
->key
= get_next_channel_key();
824 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
825 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
826 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
828 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
829 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
831 /* Copy attributes */
833 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
834 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
835 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
836 ua_chan
->attr
.overwrite
= attr
->overwrite
;
837 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
838 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
839 ua_chan
->attr
.output
= attr
->output
;
841 /* By default, the channel is a per cpu channel. */
842 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
844 DBG3("UST app channel %s allocated", ua_chan
->name
);
853 * Allocate and initialize a UST app stream.
855 * Return newly allocated stream pointer or NULL on error.
857 struct ust_app_stream
*ust_app_alloc_stream(void)
859 struct ust_app_stream
*stream
= NULL
;
861 stream
= zmalloc(sizeof(*stream
));
862 if (stream
== NULL
) {
863 PERROR("zmalloc ust app stream");
867 /* Zero could be a valid value for a handle so flag it to -1. */
875 * Alloc new UST app event.
878 struct ust_app_event
*alloc_ust_app_event(char *name
,
879 struct lttng_ust_event
*attr
)
881 struct ust_app_event
*ua_event
;
883 /* Init most of the default value by allocating and zeroing */
884 ua_event
= zmalloc(sizeof(struct ust_app_event
));
885 if (ua_event
== NULL
) {
890 ua_event
->enabled
= 1;
891 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
892 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
893 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
895 /* Copy attributes */
897 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
900 DBG3("UST app event %s allocated", ua_event
->name
);
909 * Alloc new UST app context.
912 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
914 struct ust_app_ctx
*ua_ctx
;
916 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
917 if (ua_ctx
== NULL
) {
921 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
924 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
927 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
934 * Allocate a filter and copy the given original filter.
936 * Return allocated filter or NULL on error.
938 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
939 struct lttng_ust_filter_bytecode
*orig_f
)
941 struct lttng_ust_filter_bytecode
*filter
= NULL
;
943 /* Copy filter bytecode */
944 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
946 PERROR("zmalloc alloc ust app filter");
950 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
957 * Find an ust_app using the sock and return it. RCU read side lock must be
958 * held before calling this helper function.
961 struct ust_app
*find_app_by_sock(int sock
)
963 struct lttng_ht_node_ulong
*node
;
964 struct lttng_ht_iter iter
;
966 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
967 node
= lttng_ht_iter_get_node_ulong(&iter
);
969 DBG2("UST app find by sock %d not found", sock
);
973 return caa_container_of(node
, struct ust_app
, sock_n
);
980 * Find an ust_app using the notify sock and return it. RCU read side lock must
981 * be held before calling this helper function.
983 static struct ust_app
*find_app_by_notify_sock(int sock
)
985 struct lttng_ht_node_ulong
*node
;
986 struct lttng_ht_iter iter
;
988 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
990 node
= lttng_ht_iter_get_node_ulong(&iter
);
992 DBG2("UST app find by notify sock %d not found", sock
);
996 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1003 * Lookup for an ust app event based on event name, filter bytecode and the
1006 * Return an ust_app_event object or NULL on error.
1008 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1009 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1011 struct lttng_ht_iter iter
;
1012 struct lttng_ht_node_str
*node
;
1013 struct ust_app_event
*event
= NULL
;
1014 struct ust_app_ht_key key
;
1019 /* Setup key for event lookup. */
1021 key
.filter
= filter
;
1022 key
.loglevel
= loglevel
;
1024 /* Lookup using the event name as hash and a custom match fct. */
1025 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1026 ht_match_ust_app_event
, &key
, &iter
.iter
);
1027 node
= lttng_ht_iter_get_node_str(&iter
);
1032 event
= caa_container_of(node
, struct ust_app_event
, node
);
1039 * Create the channel context on the tracer.
1041 * Called with UST app session lock held.
1044 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1045 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1049 health_code_update();
1051 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1052 ua_chan
->obj
, &ua_ctx
->obj
);
1054 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1055 ERR("UST app create channel context failed for app (pid: %d) "
1056 "with ret %d", app
->pid
, ret
);
1059 * This is normal behavior, an application can die during the
1060 * creation process. Don't report an error so the execution can
1061 * continue normally.
1064 DBG3("UST app disable event failed. Application is dead.");
1069 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1071 DBG2("UST app context handle %d created successfully for channel %s",
1072 ua_ctx
->handle
, ua_chan
->name
);
1075 health_code_update();
1080 * Set the filter on the tracer.
1083 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1084 struct ust_app
*app
)
1088 health_code_update();
1090 if (!ua_event
->filter
) {
1095 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1098 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1099 ERR("UST app event %s filter failed for app (pid: %d) "
1100 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1103 * This is normal behavior, an application can die during the
1104 * creation process. Don't report an error so the execution can
1105 * continue normally.
1108 DBG3("UST app filter event failed. Application is dead.");
1113 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1116 health_code_update();
1121 * Disable the specified event on to UST tracer for the UST session.
1123 static int disable_ust_event(struct ust_app
*app
,
1124 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1128 health_code_update();
1130 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1132 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1133 ERR("UST app event %s disable failed for app (pid: %d) "
1134 "and session handle %d with ret %d",
1135 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1138 * This is normal behavior, an application can die during the
1139 * creation process. Don't report an error so the execution can
1140 * continue normally.
1143 DBG3("UST app disable event failed. Application is dead.");
1148 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1149 ua_event
->attr
.name
, app
->pid
);
1152 health_code_update();
1157 * Disable the specified channel on to UST tracer for the UST session.
1159 static int disable_ust_channel(struct ust_app
*app
,
1160 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1164 health_code_update();
1166 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1168 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1169 ERR("UST app channel %s disable failed for app (pid: %d) "
1170 "and session handle %d with ret %d",
1171 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1174 * This is normal behavior, an application can die during the
1175 * creation process. Don't report an error so the execution can
1176 * continue normally.
1179 DBG3("UST app disable channel failed. Application is dead.");
1184 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1185 ua_chan
->name
, app
->pid
);
1188 health_code_update();
1193 * Enable the specified channel on to UST tracer for the UST session.
1195 static int enable_ust_channel(struct ust_app
*app
,
1196 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1200 health_code_update();
1202 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1204 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1205 ERR("UST app channel %s enable failed for app (pid: %d) "
1206 "and session handle %d with ret %d",
1207 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1210 * This is normal behavior, an application can die during the
1211 * creation process. Don't report an error so the execution can
1212 * continue normally.
1215 DBG3("UST app enable channel failed. Application is dead.");
1220 ua_chan
->enabled
= 1;
1222 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1223 ua_chan
->name
, app
->pid
);
1226 health_code_update();
1231 * Enable the specified event on to UST tracer for the UST session.
1233 static int enable_ust_event(struct ust_app
*app
,
1234 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1238 health_code_update();
1240 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1242 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1243 ERR("UST app event %s enable failed for app (pid: %d) "
1244 "and session handle %d with ret %d",
1245 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1248 * This is normal behavior, an application can die during the
1249 * creation process. Don't report an error so the execution can
1250 * continue normally.
1253 DBG3("UST app enable event failed. Application is dead.");
1258 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1259 ua_event
->attr
.name
, app
->pid
);
1262 health_code_update();
1267 * Send channel and stream buffer to application.
1269 * Return 0 on success. On error, a negative value is returned.
1271 static int send_channel_pid_to_ust(struct ust_app
*app
,
1272 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1275 struct ust_app_stream
*stream
, *stmp
;
1281 health_code_update();
1283 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1286 /* Send channel to the application. */
1287 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1292 health_code_update();
1294 /* Send all streams to application. */
1295 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1296 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1300 /* We don't need the stream anymore once sent to the tracer. */
1301 cds_list_del(&stream
->list
);
1302 delete_ust_app_stream(-1, stream
);
1304 /* Flag the channel that it is sent to the application. */
1305 ua_chan
->is_sent
= 1;
1308 health_code_update();
1313 * Create the specified event onto the UST tracer for a UST session.
1315 * Should be called with session mutex held.
1318 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1319 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1323 health_code_update();
1325 /* Create UST event on tracer */
1326 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1329 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1330 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1331 ua_event
->attr
.name
, app
->pid
, ret
);
1334 * This is normal behavior, an application can die during the
1335 * creation process. Don't report an error so the execution can
1336 * continue normally.
1339 DBG3("UST app create event failed. Application is dead.");
1344 ua_event
->handle
= ua_event
->obj
->handle
;
1346 DBG2("UST app event %s created successfully for pid:%d",
1347 ua_event
->attr
.name
, app
->pid
);
1349 health_code_update();
1351 /* Set filter if one is present. */
1352 if (ua_event
->filter
) {
1353 ret
= set_ust_event_filter(ua_event
, app
);
1359 /* If event not enabled, disable it on the tracer */
1360 if (ua_event
->enabled
== 0) {
1361 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1364 * If we hit an EPERM, something is wrong with our disable call. If
1365 * we get an EEXIST, there is a problem on the tracer side since we
1369 case -LTTNG_UST_ERR_PERM
:
1370 /* Code flow problem */
1372 case -LTTNG_UST_ERR_EXIST
:
1373 /* It's OK for our use case. */
1384 health_code_update();
1389 * Copy data between an UST app event and a LTT event.
1391 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1392 struct ltt_ust_event
*uevent
)
1394 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1395 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1397 ua_event
->enabled
= uevent
->enabled
;
1399 /* Copy event attributes */
1400 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1402 /* Copy filter bytecode */
1403 if (uevent
->filter
) {
1404 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1405 /* Filter might be NULL here in case of ENONEM. */
1410 * Copy data between an UST app channel and a LTT channel.
1412 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1413 struct ltt_ust_channel
*uchan
)
1415 struct lttng_ht_iter iter
;
1416 struct ltt_ust_event
*uevent
;
1417 struct ltt_ust_context
*uctx
;
1418 struct ust_app_event
*ua_event
;
1419 struct ust_app_ctx
*ua_ctx
;
1421 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1423 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1424 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1426 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1427 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1429 /* Copy event attributes since the layout is different. */
1430 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1431 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1432 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1433 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1434 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1435 ua_chan
->attr
.output
= uchan
->attr
.output
;
1437 * Note that the attribute channel type is not set since the channel on the
1438 * tracing registry side does not have this information.
1441 ua_chan
->enabled
= uchan
->enabled
;
1442 ua_chan
->tracing_channel_id
= uchan
->id
;
1444 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1445 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1446 if (ua_ctx
== NULL
) {
1449 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1450 (unsigned long) ua_ctx
->ctx
.ctx
);
1451 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1452 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1455 /* Copy all events from ltt ust channel to ust app channel */
1456 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1457 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1458 uevent
->filter
, uevent
->attr
.loglevel
);
1459 if (ua_event
== NULL
) {
1460 DBG2("UST event %s not found on shadow copy channel",
1462 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1463 if (ua_event
== NULL
) {
1466 shadow_copy_event(ua_event
, uevent
);
1467 add_unique_ust_app_event(ua_chan
, ua_event
);
1471 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1475 * Copy data between a UST app session and a regular LTT session.
1477 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1478 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1480 struct lttng_ht_node_str
*ua_chan_node
;
1481 struct lttng_ht_iter iter
;
1482 struct ltt_ust_channel
*uchan
;
1483 struct ust_app_channel
*ua_chan
;
1485 struct tm
*timeinfo
;
1489 /* Get date and time for unique app path */
1491 timeinfo
= localtime(&rawtime
);
1492 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1494 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1496 ua_sess
->tracing_id
= usess
->id
;
1497 ua_sess
->id
= get_next_session_id();
1498 ua_sess
->uid
= app
->uid
;
1499 ua_sess
->gid
= app
->gid
;
1500 ua_sess
->euid
= usess
->uid
;
1501 ua_sess
->egid
= usess
->gid
;
1502 ua_sess
->buffer_type
= usess
->buffer_type
;
1503 ua_sess
->bits_per_long
= app
->bits_per_long
;
1504 /* There is only one consumer object per session possible. */
1505 ua_sess
->consumer
= usess
->consumer
;
1507 switch (ua_sess
->buffer_type
) {
1508 case LTTNG_BUFFER_PER_PID
:
1509 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1510 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1513 case LTTNG_BUFFER_PER_UID
:
1514 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1515 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1522 PERROR("asprintf UST shadow copy session");
1527 /* Iterate over all channels in global domain. */
1528 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1530 struct lttng_ht_iter uiter
;
1532 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1533 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1534 if (ua_chan_node
!= NULL
) {
1535 /* Session exist. Contiuing. */
1539 DBG2("Channel %s not found on shadow session copy, creating it",
1541 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1542 if (ua_chan
== NULL
) {
1543 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1546 shadow_copy_channel(ua_chan
, uchan
);
1548 * The concept of metadata channel does not exist on the tracing
1549 * registry side of the session daemon so this can only be a per CPU
1550 * channel and not metadata.
1552 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1554 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1562 * Lookup sesison wrapper.
1565 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1566 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1568 /* Get right UST app session from app */
1569 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1573 * Return ust app session from the app session hashtable using the UST session
1576 static struct ust_app_session
*lookup_session_by_app(
1577 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1579 struct lttng_ht_iter iter
;
1580 struct lttng_ht_node_u64
*node
;
1582 __lookup_session_by_app(usess
, app
, &iter
);
1583 node
= lttng_ht_iter_get_node_u64(&iter
);
1588 return caa_container_of(node
, struct ust_app_session
, node
);
1595 * Setup buffer registry per PID for the given session and application. If none
1596 * is found, a new one is created, added to the global registry and
1597 * initialized. If regp is valid, it's set with the newly created object.
1599 * Return 0 on success or else a negative value.
1601 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1602 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1605 struct buffer_reg_pid
*reg_pid
;
1612 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1615 * This is the create channel path meaning that if there is NO
1616 * registry available, we have to create one for this session.
1618 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1622 buffer_reg_pid_add(reg_pid
);
1627 /* Initialize registry. */
1628 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1629 app
->bits_per_long
, app
->uint8_t_alignment
,
1630 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1631 app
->uint64_t_alignment
, app
->long_alignment
,
1632 app
->byte_order
, app
->version
.major
,
1633 app
->version
.minor
);
1638 DBG3("UST app buffer registry per PID created successfully");
1650 * Setup buffer registry per UID for the given session and application. If none
1651 * is found, a new one is created, added to the global registry and
1652 * initialized. If regp is valid, it's set with the newly created object.
1654 * Return 0 on success or else a negative value.
1656 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1657 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1660 struct buffer_reg_uid
*reg_uid
;
1667 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1670 * This is the create channel path meaning that if there is NO
1671 * registry available, we have to create one for this session.
1673 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1674 LTTNG_DOMAIN_UST
, ®_uid
);
1678 buffer_reg_uid_add(reg_uid
);
1683 /* Initialize registry. */
1684 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1685 app
->bits_per_long
, app
->uint8_t_alignment
,
1686 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1687 app
->uint64_t_alignment
, app
->long_alignment
,
1688 app
->byte_order
, app
->version
.major
,
1689 app
->version
.minor
);
1693 /* Add node to teardown list of the session. */
1694 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1696 DBG3("UST app buffer registry per UID created successfully");
1708 * Create a session on the tracer side for the given app.
1710 * On success, ua_sess_ptr is populated with the session pointer or else left
1711 * untouched. If the session was created, is_created is set to 1. On error,
1712 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1715 * Returns 0 on success or else a negative code which is either -ENOMEM or
1716 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1718 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1719 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1722 int ret
, created
= 0;
1723 struct ust_app_session
*ua_sess
;
1727 assert(ua_sess_ptr
);
1729 health_code_update();
1731 ua_sess
= lookup_session_by_app(usess
, app
);
1732 if (ua_sess
== NULL
) {
1733 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1734 app
->pid
, usess
->id
);
1735 ua_sess
= alloc_ust_app_session(app
);
1736 if (ua_sess
== NULL
) {
1737 /* Only malloc can failed so something is really wrong */
1741 shadow_copy_session(ua_sess
, usess
, app
);
1745 switch (usess
->buffer_type
) {
1746 case LTTNG_BUFFER_PER_PID
:
1747 /* Init local registry. */
1748 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1753 case LTTNG_BUFFER_PER_UID
:
1754 /* Look for a global registry. If none exists, create one. */
1755 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1766 health_code_update();
1768 if (ua_sess
->handle
== -1) {
1769 ret
= ustctl_create_session(app
->sock
);
1771 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1772 ERR("Creating session for app pid %d with ret %d",
1775 DBG("UST app creating session failed. Application is dead");
1777 * This is normal behavior, an application can die during the
1778 * creation process. Don't report an error so the execution can
1779 * continue normally. This will get flagged ENOTCONN and the
1780 * caller will handle it.
1784 delete_ust_app_session(-1, ua_sess
, app
);
1785 if (ret
!= -ENOMEM
) {
1787 * Tracer is probably gone or got an internal error so let's
1788 * behave like it will soon unregister or not usable.
1795 ua_sess
->handle
= ret
;
1797 /* Add ust app session to app's HT */
1798 lttng_ht_node_init_u64(&ua_sess
->node
,
1799 ua_sess
->tracing_id
);
1800 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1802 DBG2("UST app session created successfully with handle %d", ret
);
1805 *ua_sess_ptr
= ua_sess
;
1807 *is_created
= created
;
1810 /* Everything went well. */
1814 health_code_update();
1819 * Create a context for the channel on the tracer.
1821 * Called with UST app session lock held and a RCU read side lock.
1824 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1825 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1826 struct ust_app
*app
)
1829 struct lttng_ht_iter iter
;
1830 struct lttng_ht_node_ulong
*node
;
1831 struct ust_app_ctx
*ua_ctx
;
1833 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1835 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1836 node
= lttng_ht_iter_get_node_ulong(&iter
);
1842 ua_ctx
= alloc_ust_app_ctx(uctx
);
1843 if (ua_ctx
== NULL
) {
1849 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1850 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1851 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1853 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1863 * Enable on the tracer side a ust app event for the session and channel.
1865 * Called with UST app session lock held.
1868 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1869 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1873 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1878 ua_event
->enabled
= 1;
1885 * Disable on the tracer side a ust app event for the session and channel.
1887 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1888 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1892 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1897 ua_event
->enabled
= 0;
1904 * Lookup ust app channel for session and disable it on the tracer side.
1907 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1908 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1912 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1917 ua_chan
->enabled
= 0;
1924 * Lookup ust app channel for session and enable it on the tracer side. This
1925 * MUST be called with a RCU read side lock acquired.
1927 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1928 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1931 struct lttng_ht_iter iter
;
1932 struct lttng_ht_node_str
*ua_chan_node
;
1933 struct ust_app_channel
*ua_chan
;
1935 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1936 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1937 if (ua_chan_node
== NULL
) {
1938 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1939 uchan
->name
, ua_sess
->tracing_id
);
1943 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1945 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1955 * Ask the consumer to create a channel and get it if successful.
1957 * Return 0 on success or else a negative value.
1959 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1960 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1961 int bitness
, struct ust_registry_session
*registry
)
1964 unsigned int nb_fd
= 0;
1965 struct consumer_socket
*socket
;
1973 health_code_update();
1975 /* Get the right consumer socket for the application. */
1976 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1982 health_code_update();
1984 /* Need one fd for the channel. */
1985 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1987 ERR("Exhausted number of available FD upon create channel");
1992 * Ask consumer to create channel. The consumer will return the number of
1993 * stream we have to expect.
1995 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2002 * Compute the number of fd needed before receiving them. It must be 2 per
2003 * stream (2 being the default value here).
2005 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2007 /* Reserve the amount of file descriptor we need. */
2008 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2010 ERR("Exhausted number of available FD upon create channel");
2011 goto error_fd_get_stream
;
2014 health_code_update();
2017 * Now get the channel from the consumer. This call wil populate the stream
2018 * list of that channel and set the ust objects.
2020 if (usess
->consumer
->enabled
) {
2021 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2031 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2032 error_fd_get_stream
:
2034 * Initiate a destroy channel on the consumer since we had an error
2035 * handling it on our side. The return value is of no importance since we
2036 * already have a ret value set by the previous error that we need to
2039 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2041 lttng_fd_put(LTTNG_FD_APPS
, 1);
2043 health_code_update();
2049 * Duplicate the ust data object of the ust app stream and save it in the
2050 * buffer registry stream.
2052 * Return 0 on success or else a negative value.
2054 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2055 struct ust_app_stream
*stream
)
2062 /* Reserve the amount of file descriptor we need. */
2063 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2065 ERR("Exhausted number of available FD upon duplicate stream");
2069 /* Duplicate object for stream once the original is in the registry. */
2070 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2071 reg_stream
->obj
.ust
);
2073 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2074 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2075 lttng_fd_put(LTTNG_FD_APPS
, 2);
2078 stream
->handle
= stream
->obj
->handle
;
2085 * Duplicate the ust data object of the ust app. channel and save it in the
2086 * buffer registry channel.
2088 * Return 0 on success or else a negative value.
2090 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2091 struct ust_app_channel
*ua_chan
)
2098 /* Need two fds for the channel. */
2099 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2101 ERR("Exhausted number of available FD upon duplicate channel");
2105 /* Duplicate object for stream once the original is in the registry. */
2106 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2108 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2109 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2112 ua_chan
->handle
= ua_chan
->obj
->handle
;
2117 lttng_fd_put(LTTNG_FD_APPS
, 1);
2123 * For a given channel buffer registry, setup all streams of the given ust
2124 * application channel.
2126 * Return 0 on success or else a negative value.
2128 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2129 struct ust_app_channel
*ua_chan
)
2132 struct ust_app_stream
*stream
, *stmp
;
2137 DBG2("UST app setup buffer registry stream");
2139 /* Send all streams to application. */
2140 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2141 struct buffer_reg_stream
*reg_stream
;
2143 ret
= buffer_reg_stream_create(®_stream
);
2149 * Keep original pointer and nullify it in the stream so the delete
2150 * stream call does not release the object.
2152 reg_stream
->obj
.ust
= stream
->obj
;
2154 buffer_reg_stream_add(reg_stream
, reg_chan
);
2156 /* We don't need the streams anymore. */
2157 cds_list_del(&stream
->list
);
2158 delete_ust_app_stream(-1, stream
);
2166 * Create a buffer registry channel for the given session registry and
2167 * application channel object. If regp pointer is valid, it's set with the
2168 * created object. Important, the created object is NOT added to the session
2169 * registry hash table.
2171 * Return 0 on success else a negative value.
2173 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2174 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2177 struct buffer_reg_channel
*reg_chan
= NULL
;
2182 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2184 /* Create buffer registry channel. */
2185 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2190 reg_chan
->consumer_key
= ua_chan
->key
;
2192 /* Create and add a channel registry to session. */
2193 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2194 ua_chan
->tracing_channel_id
);
2198 buffer_reg_channel_add(reg_sess
, reg_chan
);
2207 /* Safe because the registry channel object was not added to any HT. */
2208 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2214 * Setup buffer registry channel for the given session registry and application
2215 * channel object. If regp pointer is valid, it's set with the created object.
2217 * Return 0 on success else a negative value.
2219 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2220 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2227 assert(ua_chan
->obj
);
2229 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2231 /* Setup all streams for the registry. */
2232 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2237 reg_chan
->obj
.ust
= ua_chan
->obj
;
2238 ua_chan
->obj
= NULL
;
2243 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2244 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2249 * Send buffer registry channel to the application.
2251 * Return 0 on success else a negative value.
2253 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2254 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2255 struct ust_app_channel
*ua_chan
)
2258 struct buffer_reg_stream
*reg_stream
;
2265 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2267 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2272 /* Send channel to the application. */
2273 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2278 health_code_update();
2280 /* Send all streams to application. */
2281 pthread_mutex_lock(®_chan
->stream_list_lock
);
2282 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2283 struct ust_app_stream stream
;
2285 ret
= duplicate_stream_object(reg_stream
, &stream
);
2287 goto error_stream_unlock
;
2290 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2292 (void) release_ust_app_stream(-1, &stream
);
2293 goto error_stream_unlock
;
2297 * The return value is not important here. This function will output an
2300 (void) release_ust_app_stream(-1, &stream
);
2302 ua_chan
->is_sent
= 1;
2304 error_stream_unlock
:
2305 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2311 * Create and send to the application the created buffers with per UID buffers.
2313 * Return 0 on success else a negative value.
2315 static int create_channel_per_uid(struct ust_app
*app
,
2316 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2317 struct ust_app_channel
*ua_chan
)
2320 struct buffer_reg_uid
*reg_uid
;
2321 struct buffer_reg_channel
*reg_chan
;
2328 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2330 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2332 * The session creation handles the creation of this global registry
2333 * object. If none can be find, there is a code flow problem or a
2338 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2341 /* Create the buffer registry channel object. */
2342 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2349 * Create the buffers on the consumer side. This call populates the
2350 * ust app channel object with all streams and data object.
2352 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2353 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2356 * Let's remove the previously created buffer registry channel so
2357 * it's not visible anymore in the session registry.
2359 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2360 ua_chan
->tracing_channel_id
);
2361 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2362 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2367 * Setup the streams and add it to the session registry.
2369 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2376 /* Send buffers to the application. */
2377 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2387 * Create and send to the application the created buffers with per PID buffers.
2389 * Return 0 on success else a negative value.
2391 static int create_channel_per_pid(struct ust_app
*app
,
2392 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2393 struct ust_app_channel
*ua_chan
)
2396 struct ust_registry_session
*registry
;
2403 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2407 registry
= get_session_registry(ua_sess
);
2410 /* Create and add a new channel registry to session. */
2411 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2416 /* Create and get channel on the consumer side. */
2417 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2418 app
->bits_per_long
, registry
);
2423 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2434 * From an already allocated ust app channel, create the channel buffers if
2435 * need and send it to the application. This MUST be called with a RCU read
2436 * side lock acquired.
2438 * Return 0 on success or else a negative value.
2440 static int do_create_channel(struct ust_app
*app
,
2441 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2442 struct ust_app_channel
*ua_chan
)
2451 /* Handle buffer type before sending the channel to the application. */
2452 switch (usess
->buffer_type
) {
2453 case LTTNG_BUFFER_PER_UID
:
2455 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2461 case LTTNG_BUFFER_PER_PID
:
2463 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2475 /* Initialize ust objd object using the received handle and add it. */
2476 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2477 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2479 /* If channel is not enabled, disable it on the tracer */
2480 if (!ua_chan
->enabled
) {
2481 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2492 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2493 * newly created channel if not NULL.
2495 * Called with UST app session lock and RCU read-side lock held.
2497 * Return 0 on success or else a negative value.
2499 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2500 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2501 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2502 struct ust_app_channel
**ua_chanp
)
2505 struct lttng_ht_iter iter
;
2506 struct lttng_ht_node_str
*ua_chan_node
;
2507 struct ust_app_channel
*ua_chan
;
2509 /* Lookup channel in the ust app session */
2510 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2511 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2512 if (ua_chan_node
!= NULL
) {
2513 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2517 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2518 if (ua_chan
== NULL
) {
2519 /* Only malloc can fail here */
2523 shadow_copy_channel(ua_chan
, uchan
);
2525 /* Set channel type. */
2526 ua_chan
->attr
.type
= type
;
2528 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2533 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2536 /* Only add the channel if successful on the tracer side. */
2537 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2541 *ua_chanp
= ua_chan
;
2544 /* Everything went well. */
2548 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2554 * Create UST app event and create it on the tracer side.
2556 * Called with ust app session mutex held.
2559 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2560 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2561 struct ust_app
*app
)
2564 struct ust_app_event
*ua_event
;
2566 /* Get event node */
2567 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2568 uevent
->filter
, uevent
->attr
.loglevel
);
2569 if (ua_event
!= NULL
) {
2574 /* Does not exist so create one */
2575 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2576 if (ua_event
== NULL
) {
2577 /* Only malloc can failed so something is really wrong */
2581 shadow_copy_event(ua_event
, uevent
);
2583 /* Create it on the tracer side */
2584 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2586 /* Not found previously means that it does not exist on the tracer */
2587 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2591 add_unique_ust_app_event(ua_chan
, ua_event
);
2593 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2600 /* Valid. Calling here is already in a read side lock */
2601 delete_ust_app_event(-1, ua_event
);
2606 * Create UST metadata and open it on the tracer side.
2608 * Called with UST app session lock held and RCU read side lock.
2610 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2611 struct ust_app
*app
, struct consumer_output
*consumer
,
2612 struct ustctl_consumer_channel_attr
*attr
)
2615 struct ust_app_channel
*metadata
;
2616 struct consumer_socket
*socket
;
2617 struct ust_registry_session
*registry
;
2623 registry
= get_session_registry(ua_sess
);
2626 /* Metadata already exists for this registry or it was closed previously */
2627 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2632 /* Allocate UST metadata */
2633 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2635 /* malloc() failed */
2641 /* Set default attributes for metadata. */
2642 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2643 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2644 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2645 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2646 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2647 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2648 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2650 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2651 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2652 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2655 /* Need one fd for the channel. */
2656 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2658 ERR("Exhausted number of available FD upon create metadata");
2662 /* Get the right consumer socket for the application. */
2663 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2666 goto error_consumer
;
2670 * Keep metadata key so we can identify it on the consumer side. Assign it
2671 * to the registry *before* we ask the consumer so we avoid the race of the
2672 * consumer requesting the metadata and the ask_channel call on our side
2673 * did not returned yet.
2675 registry
->metadata_key
= metadata
->key
;
2678 * Ask the metadata channel creation to the consumer. The metadata object
2679 * will be created by the consumer and kept their. However, the stream is
2680 * never added or monitored until we do a first push metadata to the
2683 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2686 /* Nullify the metadata key so we don't try to close it later on. */
2687 registry
->metadata_key
= 0;
2688 goto error_consumer
;
2692 * The setup command will make the metadata stream be sent to the relayd,
2693 * if applicable, and the thread managing the metadatas. This is important
2694 * because after this point, if an error occurs, the only way the stream
2695 * can be deleted is to be monitored in the consumer.
2697 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2699 /* Nullify the metadata key so we don't try to close it later on. */
2700 registry
->metadata_key
= 0;
2701 goto error_consumer
;
2704 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2705 metadata
->key
, app
->pid
);
2708 lttng_fd_put(LTTNG_FD_APPS
, 1);
2709 delete_ust_app_channel(-1, metadata
, app
);
2715 * Return pointer to traceable apps list.
2717 struct lttng_ht
*ust_app_get_ht(void)
2723 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2724 * acquired before calling this function.
2726 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2728 struct ust_app
*app
= NULL
;
2729 struct lttng_ht_node_ulong
*node
;
2730 struct lttng_ht_iter iter
;
2732 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2733 node
= lttng_ht_iter_get_node_ulong(&iter
);
2735 DBG2("UST app no found with pid %d", pid
);
2739 DBG2("Found UST app by pid %d", pid
);
2741 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2748 * Allocate and init an UST app object using the registration information and
2749 * the command socket. This is called when the command socket connects to the
2752 * The object is returned on success or else NULL.
2754 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2756 struct ust_app
*lta
= NULL
;
2761 DBG3("UST app creating application for socket %d", sock
);
2763 if ((msg
->bits_per_long
== 64 &&
2764 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2765 || (msg
->bits_per_long
== 32 &&
2766 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2767 ERR("Registration failed: application \"%s\" (pid: %d) has "
2768 "%d-bit long, but no consumerd for this size is available.\n",
2769 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2773 lta
= zmalloc(sizeof(struct ust_app
));
2779 lta
->ppid
= msg
->ppid
;
2780 lta
->uid
= msg
->uid
;
2781 lta
->gid
= msg
->gid
;
2783 lta
->bits_per_long
= msg
->bits_per_long
;
2784 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2785 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2786 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2787 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2788 lta
->long_alignment
= msg
->long_alignment
;
2789 lta
->byte_order
= msg
->byte_order
;
2791 lta
->v_major
= msg
->major
;
2792 lta
->v_minor
= msg
->minor
;
2793 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2794 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2795 lta
->notify_sock
= -1;
2797 /* Copy name and make sure it's NULL terminated. */
2798 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2799 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2802 * Before this can be called, when receiving the registration information,
2803 * the application compatibility is checked. So, at this point, the
2804 * application can work with this session daemon.
2806 lta
->compatible
= 1;
2808 lta
->pid
= msg
->pid
;
2809 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2811 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2813 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2820 * For a given application object, add it to every hash table.
2822 void ust_app_add(struct ust_app
*app
)
2825 assert(app
->notify_sock
>= 0);
2830 * On a re-registration, we want to kick out the previous registration of
2833 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2836 * The socket _should_ be unique until _we_ call close. So, a add_unique
2837 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2838 * already in the table.
2840 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2842 /* Add application to the notify socket hash table. */
2843 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2844 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2846 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2847 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2848 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2855 * Set the application version into the object.
2857 * Return 0 on success else a negative value either an errno code or a
2858 * LTTng-UST error code.
2860 int ust_app_version(struct ust_app
*app
)
2866 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2868 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2869 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2871 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2879 * Unregister app by removing it from the global traceable app list and freeing
2882 * The socket is already closed at this point so no close to sock.
2884 void ust_app_unregister(int sock
)
2886 struct ust_app
*lta
;
2887 struct lttng_ht_node_ulong
*node
;
2888 struct lttng_ht_iter iter
;
2889 struct ust_app_session
*ua_sess
;
2894 /* Get the node reference for a call_rcu */
2895 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2896 node
= lttng_ht_iter_get_node_ulong(&iter
);
2899 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2900 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2902 /* Remove application from PID hash table */
2903 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2907 * Remove application from notify hash table. The thread handling the
2908 * notify socket could have deleted the node so ignore on error because
2909 * either way it's valid. The close of that socket is handled by the other
2912 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2913 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2916 * Ignore return value since the node might have been removed before by an
2917 * add replace during app registration because the PID can be reassigned by
2920 iter
.iter
.node
= <a
->pid_n
.node
;
2921 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2923 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2927 /* Remove sessions so they are not visible during deletion.*/
2928 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2930 struct ust_registry_session
*registry
;
2932 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2934 /* The session was already removed so scheduled for teardown. */
2939 * Add session to list for teardown. This is safe since at this point we
2940 * are the only one using this list.
2942 pthread_mutex_lock(&ua_sess
->lock
);
2945 * Normally, this is done in the delete session process which is
2946 * executed in the call rcu below. However, upon registration we can't
2947 * afford to wait for the grace period before pushing data or else the
2948 * data pending feature can race between the unregistration and stop
2949 * command where the data pending command is sent *before* the grace
2952 * The close metadata below nullifies the metadata pointer in the
2953 * session so the delete session will NOT push/close a second time.
2955 registry
= get_session_registry(ua_sess
);
2956 if (registry
&& !registry
->metadata_closed
) {
2957 /* Push metadata for application before freeing the application. */
2958 (void) push_metadata(registry
, ua_sess
->consumer
);
2961 * Don't ask to close metadata for global per UID buffers. Close
2962 * metadata only on destroy trace session in this case. Also, the
2963 * previous push metadata could have flag the metadata registry to
2964 * close so don't send a close command if closed.
2966 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2967 !registry
->metadata_closed
) {
2968 /* And ask to close it for this session registry. */
2969 (void) close_metadata(registry
, ua_sess
->consumer
);
2973 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2974 pthread_mutex_unlock(&ua_sess
->lock
);
2978 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2985 * Return traceable_app_count
2987 unsigned long ust_app_list_count(void)
2989 unsigned long count
;
2992 count
= lttng_ht_get_count(ust_app_ht
);
2999 * Fill events array with all events name of all registered apps.
3001 int ust_app_list_events(struct lttng_event
**events
)
3004 size_t nbmem
, count
= 0;
3005 struct lttng_ht_iter iter
;
3006 struct ust_app
*app
;
3007 struct lttng_event
*tmp_event
;
3009 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3010 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3011 if (tmp_event
== NULL
) {
3012 PERROR("zmalloc ust app events");
3019 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3020 struct lttng_ust_tracepoint_iter uiter
;
3022 health_code_update();
3024 if (!app
->compatible
) {
3026 * TODO: In time, we should notice the caller of this error by
3027 * telling him that this is a version error.
3031 handle
= ustctl_tracepoint_list(app
->sock
);
3033 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3034 ERR("UST app list events getting handle failed for app pid %d",
3040 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3041 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3042 /* Handle ustctl error. */
3045 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3046 ERR("UST app tp list get failed for app %d with ret %d",
3049 DBG3("UST app tp list get failed. Application is dead");
3051 * This is normal behavior, an application can die during the
3052 * creation process. Don't report an error so the execution can
3053 * continue normally. Continue normal execution.
3060 health_code_update();
3061 if (count
>= nbmem
) {
3062 /* In case the realloc fails, we free the memory */
3065 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3068 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3070 PERROR("realloc ust app events");
3077 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3078 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3079 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3080 tmp_event
[count
].pid
= app
->pid
;
3081 tmp_event
[count
].enabled
= -1;
3087 *events
= tmp_event
;
3089 DBG2("UST app list events done (%zu events)", count
);
3094 health_code_update();
3099 * Fill events array with all events name of all registered apps.
3101 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3104 size_t nbmem
, count
= 0;
3105 struct lttng_ht_iter iter
;
3106 struct ust_app
*app
;
3107 struct lttng_event_field
*tmp_event
;
3109 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3110 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3111 if (tmp_event
== NULL
) {
3112 PERROR("zmalloc ust app event fields");
3119 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3120 struct lttng_ust_field_iter uiter
;
3122 health_code_update();
3124 if (!app
->compatible
) {
3126 * TODO: In time, we should notice the caller of this error by
3127 * telling him that this is a version error.
3131 handle
= ustctl_tracepoint_field_list(app
->sock
);
3133 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3134 ERR("UST app list field getting handle failed for app pid %d",
3140 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3141 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3142 /* Handle ustctl error. */
3145 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3146 ERR("UST app tp list field failed for app %d with ret %d",
3149 DBG3("UST app tp list field failed. Application is dead");
3151 * This is normal behavior, an application can die during the
3152 * creation process. Don't report an error so the execution can
3153 * continue normally.
3160 health_code_update();
3161 if (count
>= nbmem
) {
3162 /* In case the realloc fails, we free the memory */
3165 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3168 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3170 PERROR("realloc ust app event fields");
3178 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3179 tmp_event
[count
].type
= uiter
.type
;
3180 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3182 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3183 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3184 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3185 tmp_event
[count
].event
.pid
= app
->pid
;
3186 tmp_event
[count
].event
.enabled
= -1;
3192 *fields
= tmp_event
;
3194 DBG2("UST app list event fields done (%zu events)", count
);
3199 health_code_update();
3204 * Free and clean all traceable apps of the global list.
3206 * Should _NOT_ be called with RCU read-side lock held.
3208 void ust_app_clean_list(void)
3211 struct ust_app
*app
;
3212 struct lttng_ht_iter iter
;
3214 DBG2("UST app cleaning registered apps hash table");
3218 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3219 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3221 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3224 /* Cleanup socket hash table */
3225 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3227 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3231 /* Cleanup notify socket hash table */
3232 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3233 notify_sock_n
.node
) {
3234 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3239 /* Destroy is done only when the ht is empty */
3240 ht_cleanup_push(ust_app_ht
);
3241 ht_cleanup_push(ust_app_ht_by_sock
);
3242 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3246 * Init UST app hash table.
3248 void ust_app_ht_alloc(void)
3250 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3251 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3252 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3256 * For a specific UST session, disable the channel for all registered apps.
3258 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3259 struct ltt_ust_channel
*uchan
)
3262 struct lttng_ht_iter iter
;
3263 struct lttng_ht_node_str
*ua_chan_node
;
3264 struct ust_app
*app
;
3265 struct ust_app_session
*ua_sess
;
3266 struct ust_app_channel
*ua_chan
;
3268 if (usess
== NULL
|| uchan
== NULL
) {
3269 ERR("Disabling UST global channel with NULL values");
3274 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3275 uchan
->name
, usess
->id
);
3279 /* For every registered applications */
3280 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3281 struct lttng_ht_iter uiter
;
3282 if (!app
->compatible
) {
3284 * TODO: In time, we should notice the caller of this error by
3285 * telling him that this is a version error.
3289 ua_sess
= lookup_session_by_app(usess
, app
);
3290 if (ua_sess
== NULL
) {
3295 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3296 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3297 /* If the session if found for the app, the channel must be there */
3298 assert(ua_chan_node
);
3300 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3301 /* The channel must not be already disabled */
3302 assert(ua_chan
->enabled
== 1);
3304 /* Disable channel onto application */
3305 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3307 /* XXX: We might want to report this error at some point... */
3319 * For a specific UST session, enable the channel for all registered apps.
3321 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3322 struct ltt_ust_channel
*uchan
)
3325 struct lttng_ht_iter iter
;
3326 struct ust_app
*app
;
3327 struct ust_app_session
*ua_sess
;
3329 if (usess
== NULL
|| uchan
== NULL
) {
3330 ERR("Adding UST global channel to NULL values");
3335 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3336 uchan
->name
, usess
->id
);
3340 /* For every registered applications */
3341 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3342 if (!app
->compatible
) {
3344 * TODO: In time, we should notice the caller of this error by
3345 * telling him that this is a version error.
3349 ua_sess
= lookup_session_by_app(usess
, app
);
3350 if (ua_sess
== NULL
) {
3354 /* Enable channel onto application */
3355 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3357 /* XXX: We might want to report this error at some point... */
3369 * Disable an event in a channel and for a specific session.
3371 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3372 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3375 struct lttng_ht_iter iter
, uiter
;
3376 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3377 struct ust_app
*app
;
3378 struct ust_app_session
*ua_sess
;
3379 struct ust_app_channel
*ua_chan
;
3380 struct ust_app_event
*ua_event
;
3382 DBG("UST app disabling event %s for all apps in channel "
3383 "%s for session id %" PRIu64
,
3384 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3388 /* For all registered applications */
3389 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3390 if (!app
->compatible
) {
3392 * TODO: In time, we should notice the caller of this error by
3393 * telling him that this is a version error.
3397 ua_sess
= lookup_session_by_app(usess
, app
);
3398 if (ua_sess
== NULL
) {
3403 /* Lookup channel in the ust app session */
3404 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3405 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3406 if (ua_chan_node
== NULL
) {
3407 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3408 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3411 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3413 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3414 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3415 if (ua_event_node
== NULL
) {
3416 DBG2("Event %s not found in channel %s for app pid %d."
3417 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3420 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3422 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3424 /* XXX: Report error someday... */
3435 * For a specific UST session and UST channel, the event for all
3438 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3439 struct ltt_ust_channel
*uchan
)
3442 struct lttng_ht_iter iter
, uiter
;
3443 struct lttng_ht_node_str
*ua_chan_node
;
3444 struct ust_app
*app
;
3445 struct ust_app_session
*ua_sess
;
3446 struct ust_app_channel
*ua_chan
;
3447 struct ust_app_event
*ua_event
;
3449 DBG("UST app disabling all event for all apps in channel "
3450 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3454 /* For all registered applications */
3455 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3456 if (!app
->compatible
) {
3458 * TODO: In time, we should notice the caller of this error by
3459 * telling him that this is a version error.
3463 ua_sess
= lookup_session_by_app(usess
, app
);
3465 /* The application has problem or is probably dead. */
3469 /* Lookup channel in the ust app session */
3470 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3471 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3472 /* If the channel is not found, there is a code flow error */
3473 assert(ua_chan_node
);
3475 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3477 /* Disable each events of channel */
3478 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3480 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3482 /* XXX: Report error someday... */
3494 * For a specific UST session, create the channel for all registered apps.
3496 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3497 struct ltt_ust_channel
*uchan
)
3499 int ret
= 0, created
;
3500 struct lttng_ht_iter iter
;
3501 struct ust_app
*app
;
3502 struct ust_app_session
*ua_sess
= NULL
;
3504 /* Very wrong code flow */
3508 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3509 uchan
->name
, usess
->id
);
3513 /* For every registered applications */
3514 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3515 if (!app
->compatible
) {
3517 * TODO: In time, we should notice the caller of this error by
3518 * telling him that this is a version error.
3523 * Create session on the tracer side and add it to app session HT. Note
3524 * that if session exist, it will simply return a pointer to the ust
3527 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3532 * The application's socket is not valid. Either a bad socket
3533 * or a timeout on it. We can't inform the caller that for a
3534 * specific app, the session failed so lets continue here.
3539 goto error_rcu_unlock
;
3544 pthread_mutex_lock(&ua_sess
->lock
);
3545 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3546 sizeof(uchan
->name
))) {
3547 struct ustctl_consumer_channel_attr attr
;
3548 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3549 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3552 /* Create channel onto application. We don't need the chan ref. */
3553 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3554 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3556 pthread_mutex_unlock(&ua_sess
->lock
);
3558 if (ret
== -ENOMEM
) {
3559 /* No more memory is a fatal error. Stop right now. */
3560 goto error_rcu_unlock
;
3562 /* Cleanup the created session if it's the case. */
3564 destroy_app_session(app
, ua_sess
);
3575 * Enable event for a specific session and channel on the tracer.
3577 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3578 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3581 struct lttng_ht_iter iter
, uiter
;
3582 struct lttng_ht_node_str
*ua_chan_node
;
3583 struct ust_app
*app
;
3584 struct ust_app_session
*ua_sess
;
3585 struct ust_app_channel
*ua_chan
;
3586 struct ust_app_event
*ua_event
;
3588 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3589 uevent
->attr
.name
, usess
->id
);
3592 * NOTE: At this point, this function is called only if the session and
3593 * channel passed are already created for all apps. and enabled on the
3599 /* For all registered applications */
3600 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3601 if (!app
->compatible
) {
3603 * TODO: In time, we should notice the caller of this error by
3604 * telling him that this is a version error.
3608 ua_sess
= lookup_session_by_app(usess
, app
);
3610 /* The application has problem or is probably dead. */
3614 pthread_mutex_lock(&ua_sess
->lock
);
3616 /* Lookup channel in the ust app session */
3617 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3618 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3619 /* If the channel is not found, there is a code flow error */
3620 assert(ua_chan_node
);
3622 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3624 /* Get event node */
3625 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3626 uevent
->filter
, uevent
->attr
.loglevel
);
3627 if (ua_event
== NULL
) {
3628 DBG3("UST app enable event %s not found for app PID %d."
3629 "Skipping app", uevent
->attr
.name
, app
->pid
);
3633 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3635 pthread_mutex_unlock(&ua_sess
->lock
);
3639 pthread_mutex_unlock(&ua_sess
->lock
);
3648 * For a specific existing UST session and UST channel, creates the event for
3649 * all registered apps.
3651 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3652 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3655 struct lttng_ht_iter iter
, uiter
;
3656 struct lttng_ht_node_str
*ua_chan_node
;
3657 struct ust_app
*app
;
3658 struct ust_app_session
*ua_sess
;
3659 struct ust_app_channel
*ua_chan
;
3661 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3662 uevent
->attr
.name
, usess
->id
);
3666 /* For all registered applications */
3667 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3668 if (!app
->compatible
) {
3670 * TODO: In time, we should notice the caller of this error by
3671 * telling him that this is a version error.
3675 ua_sess
= lookup_session_by_app(usess
, app
);
3677 /* The application has problem or is probably dead. */
3681 pthread_mutex_lock(&ua_sess
->lock
);
3682 /* Lookup channel in the ust app session */
3683 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3684 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3685 /* If the channel is not found, there is a code flow error */
3686 assert(ua_chan_node
);
3688 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3690 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3691 pthread_mutex_unlock(&ua_sess
->lock
);
3693 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3694 /* Possible value at this point: -ENOMEM. If so, we stop! */
3697 DBG2("UST app event %s already exist on app PID %d",
3698 uevent
->attr
.name
, app
->pid
);
3709 * Start tracing for a specific UST session and app.
3712 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3715 struct ust_app_session
*ua_sess
;
3717 DBG("Starting tracing for ust app pid %d", app
->pid
);
3721 if (!app
->compatible
) {
3725 ua_sess
= lookup_session_by_app(usess
, app
);
3726 if (ua_sess
== NULL
) {
3727 /* The session is in teardown process. Ignore and continue. */
3731 pthread_mutex_lock(&ua_sess
->lock
);
3733 /* Upon restart, we skip the setup, already done */
3734 if (ua_sess
->started
) {
3738 /* Create directories if consumer is LOCAL and has a path defined. */
3739 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3740 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3741 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3742 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3744 if (ret
!= -EEXIST
) {
3745 ERR("Trace directory creation error");
3752 * Create the metadata for the application. This returns gracefully if a
3753 * metadata was already set for the session.
3755 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3760 health_code_update();
3763 /* This start the UST tracing */
3764 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3766 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3767 ERR("Error starting tracing for app pid: %d (ret: %d)",
3770 DBG("UST app start session failed. Application is dead.");
3772 * This is normal behavior, an application can die during the
3773 * creation process. Don't report an error so the execution can
3774 * continue normally.
3776 pthread_mutex_unlock(&ua_sess
->lock
);
3782 /* Indicate that the session has been started once */
3783 ua_sess
->started
= 1;
3785 pthread_mutex_unlock(&ua_sess
->lock
);
3787 health_code_update();
3789 /* Quiescent wait after starting trace */
3790 ret
= ustctl_wait_quiescent(app
->sock
);
3791 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3792 ERR("UST app wait quiescent failed for app pid %d ret %d",
3798 health_code_update();
3802 pthread_mutex_unlock(&ua_sess
->lock
);
3804 health_code_update();
3809 * Stop tracing for a specific UST session and app.
3812 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3815 struct ust_app_session
*ua_sess
;
3816 struct ust_registry_session
*registry
;
3818 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3822 if (!app
->compatible
) {
3823 goto end_no_session
;
3826 ua_sess
= lookup_session_by_app(usess
, app
);
3827 if (ua_sess
== NULL
) {
3828 goto end_no_session
;
3831 pthread_mutex_lock(&ua_sess
->lock
);
3834 * If started = 0, it means that stop trace has been called for a session
3835 * that was never started. It's possible since we can have a fail start
3836 * from either the application manager thread or the command thread. Simply
3837 * indicate that this is a stop error.
3839 if (!ua_sess
->started
) {
3840 goto error_rcu_unlock
;
3843 health_code_update();
3845 /* This inhibits UST tracing */
3846 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3848 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3849 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3852 DBG("UST app stop session failed. Application is dead.");
3854 * This is normal behavior, an application can die during the
3855 * creation process. Don't report an error so the execution can
3856 * continue normally.
3860 goto error_rcu_unlock
;
3863 health_code_update();
3865 /* Quiescent wait after stopping trace */
3866 ret
= ustctl_wait_quiescent(app
->sock
);
3867 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3868 ERR("UST app wait quiescent failed for app pid %d ret %d",
3872 health_code_update();
3874 registry
= get_session_registry(ua_sess
);
3877 if (!registry
->metadata_closed
) {
3878 /* Push metadata for application before freeing the application. */
3879 (void) push_metadata(registry
, ua_sess
->consumer
);
3883 pthread_mutex_unlock(&ua_sess
->lock
);
3886 health_code_update();
3890 pthread_mutex_unlock(&ua_sess
->lock
);
3892 health_code_update();
3897 * Flush buffers for a specific UST session and app.
3900 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3903 struct lttng_ht_iter iter
;
3904 struct ust_app_session
*ua_sess
;
3905 struct ust_app_channel
*ua_chan
;
3907 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3911 if (!app
->compatible
) {
3912 goto end_no_session
;
3915 ua_sess
= lookup_session_by_app(usess
, app
);
3916 if (ua_sess
== NULL
) {
3917 goto end_no_session
;
3920 pthread_mutex_lock(&ua_sess
->lock
);
3922 health_code_update();
3924 /* Flushing buffers */
3925 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3927 health_code_update();
3928 assert(ua_chan
->is_sent
);
3929 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3931 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3932 ERR("UST app PID %d channel %s flush failed with ret %d",
3933 app
->pid
, ua_chan
->name
, ret
);
3935 DBG3("UST app failed to flush %s. Application is dead.",
3938 * This is normal behavior, an application can die during the
3939 * creation process. Don't report an error so the execution can
3940 * continue normally.
3943 /* Continuing flushing all buffers */
3948 health_code_update();
3950 pthread_mutex_unlock(&ua_sess
->lock
);
3953 health_code_update();
3958 * Destroy a specific UST session in apps.
3960 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3963 struct ust_app_session
*ua_sess
;
3964 struct lttng_ht_iter iter
;
3965 struct lttng_ht_node_u64
*node
;
3967 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3971 if (!app
->compatible
) {
3975 __lookup_session_by_app(usess
, app
, &iter
);
3976 node
= lttng_ht_iter_get_node_u64(&iter
);
3978 /* Session is being or is deleted. */
3981 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3983 health_code_update();
3984 destroy_app_session(app
, ua_sess
);
3986 health_code_update();
3988 /* Quiescent wait after stopping trace */
3989 ret
= ustctl_wait_quiescent(app
->sock
);
3990 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3991 ERR("UST app wait quiescent failed for app pid %d ret %d",
3996 health_code_update();
4001 * Start tracing for the UST session.
4003 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4006 struct lttng_ht_iter iter
;
4007 struct ust_app
*app
;
4009 DBG("Starting all UST traces");
4013 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4014 ret
= ust_app_start_trace(usess
, app
);
4016 /* Continue to next apps even on error */
4027 * Start tracing for the UST session.
4029 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4032 struct lttng_ht_iter iter
;
4033 struct ust_app
*app
;
4035 DBG("Stopping all UST traces");
4039 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4040 ret
= ust_app_stop_trace(usess
, app
);
4042 /* Continue to next apps even on error */
4047 /* Flush buffers and push metadata (for UID buffers). */
4048 switch (usess
->buffer_type
) {
4049 case LTTNG_BUFFER_PER_UID
:
4051 struct buffer_reg_uid
*reg
;
4053 /* Flush all per UID buffers associated to that session. */
4054 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4055 struct ust_registry_session
*ust_session_reg
;
4056 struct buffer_reg_channel
*reg_chan
;
4057 struct consumer_socket
*socket
;
4059 /* Get consumer socket to use to push the metadata.*/
4060 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4063 /* Ignore request if no consumer is found for the session. */
4067 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4068 reg_chan
, node
.node
) {
4070 * The following call will print error values so the return
4071 * code is of little importance because whatever happens, we
4072 * have to try them all.
4074 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4077 ust_session_reg
= reg
->registry
->reg
.ust
;
4078 if (!ust_session_reg
->metadata_closed
) {
4079 /* Push metadata. */
4080 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4086 case LTTNG_BUFFER_PER_PID
:
4087 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4088 ret
= ust_app_flush_trace(usess
, app
);
4090 /* Continue to next apps even on error */
4106 * Destroy app UST session.
4108 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4111 struct lttng_ht_iter iter
;
4112 struct ust_app
*app
;
4114 DBG("Destroy all UST traces");
4118 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4119 ret
= destroy_trace(usess
, app
);
4121 /* Continue to next apps even on error */
4132 * Add channels/events from UST global domain to registered apps at sock.
4134 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4137 struct lttng_ht_iter iter
, uiter
;
4138 struct ust_app
*app
;
4139 struct ust_app_session
*ua_sess
= NULL
;
4140 struct ust_app_channel
*ua_chan
;
4141 struct ust_app_event
*ua_event
;
4142 struct ust_app_ctx
*ua_ctx
;
4147 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4152 app
= find_app_by_sock(sock
);
4155 * Application can be unregistered before so this is possible hence
4156 * simply stopping the update.
4158 DBG3("UST app update failed to find app sock %d", sock
);
4162 if (!app
->compatible
) {
4166 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4168 /* Tracer is probably gone or ENOMEM. */
4173 pthread_mutex_lock(&ua_sess
->lock
);
4176 * We can iterate safely here over all UST app session since the create ust
4177 * app session above made a shadow copy of the UST global domain from the
4180 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4183 * For a metadata channel, handle it differently.
4185 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4186 sizeof(ua_chan
->name
))) {
4187 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4192 /* Remove it from the hash table and continue!. */
4193 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4195 delete_ust_app_channel(-1, ua_chan
, app
);
4198 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4201 * Stop everything. On error, the application failed, no more
4202 * file descriptor are available or ENOMEM so stopping here is
4203 * the only thing we can do for now.
4210 * Add context using the list so they are enabled in the same order the
4213 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4214 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4221 /* For each events */
4222 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4224 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4231 pthread_mutex_unlock(&ua_sess
->lock
);
4233 if (usess
->start_trace
) {
4234 ret
= ust_app_start_trace(usess
, app
);
4239 DBG2("UST trace started for app pid %d", app
->pid
);
4242 /* Everything went well at this point. */
4247 pthread_mutex_unlock(&ua_sess
->lock
);
4250 destroy_app_session(app
, ua_sess
);
4257 * Add context to a specific channel for global UST domain.
4259 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4260 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4263 struct lttng_ht_node_str
*ua_chan_node
;
4264 struct lttng_ht_iter iter
, uiter
;
4265 struct ust_app_channel
*ua_chan
= NULL
;
4266 struct ust_app_session
*ua_sess
;
4267 struct ust_app
*app
;
4271 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4272 if (!app
->compatible
) {
4274 * TODO: In time, we should notice the caller of this error by
4275 * telling him that this is a version error.
4279 ua_sess
= lookup_session_by_app(usess
, app
);
4280 if (ua_sess
== NULL
) {
4284 pthread_mutex_lock(&ua_sess
->lock
);
4285 /* Lookup channel in the ust app session */
4286 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4287 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4288 if (ua_chan_node
== NULL
) {
4291 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4293 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4298 pthread_mutex_unlock(&ua_sess
->lock
);
4306 * Enable event for a channel from a UST session for a specific PID.
4308 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4309 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4312 struct lttng_ht_iter iter
;
4313 struct lttng_ht_node_str
*ua_chan_node
;
4314 struct ust_app
*app
;
4315 struct ust_app_session
*ua_sess
;
4316 struct ust_app_channel
*ua_chan
;
4317 struct ust_app_event
*ua_event
;
4319 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4323 app
= ust_app_find_by_pid(pid
);
4325 ERR("UST app enable event per PID %d not found", pid
);
4330 if (!app
->compatible
) {
4335 ua_sess
= lookup_session_by_app(usess
, app
);
4337 /* The application has problem or is probably dead. */
4342 pthread_mutex_lock(&ua_sess
->lock
);
4343 /* Lookup channel in the ust app session */
4344 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4345 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4346 /* If the channel is not found, there is a code flow error */
4347 assert(ua_chan_node
);
4349 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4351 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4352 uevent
->filter
, uevent
->attr
.loglevel
);
4353 if (ua_event
== NULL
) {
4354 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4359 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4366 pthread_mutex_unlock(&ua_sess
->lock
);
4373 * Disable event for a channel from a UST session for a specific PID.
4375 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4376 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4379 struct lttng_ht_iter iter
;
4380 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4381 struct ust_app
*app
;
4382 struct ust_app_session
*ua_sess
;
4383 struct ust_app_channel
*ua_chan
;
4384 struct ust_app_event
*ua_event
;
4386 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4390 app
= ust_app_find_by_pid(pid
);
4392 ERR("UST app disable event per PID %d not found", pid
);
4397 if (!app
->compatible
) {
4402 ua_sess
= lookup_session_by_app(usess
, app
);
4404 /* The application has problem or is probably dead. */
4408 /* Lookup channel in the ust app session */
4409 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4410 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4411 if (ua_chan_node
== NULL
) {
4412 /* Channel does not exist, skip disabling */
4415 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4417 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4418 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4419 if (ua_event_node
== NULL
) {
4420 /* Event does not exist, skip disabling */
4423 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4425 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4436 * Calibrate registered applications.
4438 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4441 struct lttng_ht_iter iter
;
4442 struct ust_app
*app
;
4446 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4447 if (!app
->compatible
) {
4449 * TODO: In time, we should notice the caller of this error by
4450 * telling him that this is a version error.
4455 health_code_update();
4457 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4461 /* Means that it's not implemented on the tracer side. */
4465 DBG2("Calibrate app PID %d returned with error %d",
4472 DBG("UST app global domain calibration finished");
4476 health_code_update();
4482 * Receive registration and populate the given msg structure.
4484 * On success return 0 else a negative value returned by the ustctl call.
4486 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4489 uint32_t pid
, ppid
, uid
, gid
;
4493 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4494 &pid
, &ppid
, &uid
, &gid
,
4495 &msg
->bits_per_long
,
4496 &msg
->uint8_t_alignment
,
4497 &msg
->uint16_t_alignment
,
4498 &msg
->uint32_t_alignment
,
4499 &msg
->uint64_t_alignment
,
4500 &msg
->long_alignment
,
4507 case LTTNG_UST_ERR_EXITING
:
4508 DBG3("UST app recv reg message failed. Application died");
4510 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4511 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4512 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4513 LTTNG_UST_ABI_MINOR_VERSION
);
4516 ERR("UST app recv reg message failed with ret %d", ret
);
4521 msg
->pid
= (pid_t
) pid
;
4522 msg
->ppid
= (pid_t
) ppid
;
4523 msg
->uid
= (uid_t
) uid
;
4524 msg
->gid
= (gid_t
) gid
;
4531 * Return a ust app channel object using the application object and the channel
4532 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4533 * lock MUST be acquired before calling this function.
4535 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4538 struct lttng_ht_node_ulong
*node
;
4539 struct lttng_ht_iter iter
;
4540 struct ust_app_channel
*ua_chan
= NULL
;
4544 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4545 node
= lttng_ht_iter_get_node_ulong(&iter
);
4547 DBG2("UST app channel find by objd %d not found", objd
);
4551 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4558 * Reply to a register channel notification from an application on the notify
4559 * socket. The channel metadata is also created.
4561 * The session UST registry lock is acquired in this function.
4563 * On success 0 is returned else a negative value.
4565 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4566 size_t nr_fields
, struct ustctl_field
*fields
)
4568 int ret
, ret_code
= 0;
4569 uint32_t chan_id
, reg_count
;
4570 uint64_t chan_reg_key
;
4571 enum ustctl_channel_header type
;
4572 struct ust_app
*app
;
4573 struct ust_app_channel
*ua_chan
;
4574 struct ust_app_session
*ua_sess
;
4575 struct ust_registry_session
*registry
;
4576 struct ust_registry_channel
*chan_reg
;
4580 /* Lookup application. If not found, there is a code flow error. */
4581 app
= find_app_by_notify_sock(sock
);
4583 DBG("Application socket %d is being teardown. Abort event notify",
4587 goto error_rcu_unlock
;
4590 /* Lookup channel by UST object descriptor. */
4591 ua_chan
= find_channel_by_objd(app
, cobjd
);
4593 DBG("Application channel is being teardown. Abort event notify");
4596 goto error_rcu_unlock
;
4599 assert(ua_chan
->session
);
4600 ua_sess
= ua_chan
->session
;
4602 /* Get right session registry depending on the session buffer type. */
4603 registry
= get_session_registry(ua_sess
);
4606 /* Depending on the buffer type, a different channel key is used. */
4607 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4608 chan_reg_key
= ua_chan
->tracing_channel_id
;
4610 chan_reg_key
= ua_chan
->key
;
4613 pthread_mutex_lock(®istry
->lock
);
4615 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4618 if (!chan_reg
->register_done
) {
4619 reg_count
= ust_registry_get_event_count(chan_reg
);
4620 if (reg_count
< 31) {
4621 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4623 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4626 chan_reg
->nr_ctx_fields
= nr_fields
;
4627 chan_reg
->ctx_fields
= fields
;
4628 chan_reg
->header_type
= type
;
4630 /* Get current already assigned values. */
4631 type
= chan_reg
->header_type
;
4633 /* Set to NULL so the error path does not do a double free. */
4636 /* Channel id is set during the object creation. */
4637 chan_id
= chan_reg
->chan_id
;
4639 /* Append to metadata */
4640 if (!chan_reg
->metadata_dumped
) {
4641 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4643 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4649 DBG3("UST app replying to register channel key %" PRIu64
4650 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4653 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4655 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4656 ERR("UST app reply channel failed with ret %d", ret
);
4658 DBG3("UST app reply channel failed. Application died");
4663 /* This channel registry registration is completed. */
4664 chan_reg
->register_done
= 1;
4667 pthread_mutex_unlock(®istry
->lock
);
4677 * Add event to the UST channel registry. When the event is added to the
4678 * registry, the metadata is also created. Once done, this replies to the
4679 * application with the appropriate error code.
4681 * The session UST registry lock is acquired in the function.
4683 * On success 0 is returned else a negative value.
4685 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4686 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4687 char *model_emf_uri
)
4690 uint32_t event_id
= 0;
4691 uint64_t chan_reg_key
;
4692 struct ust_app
*app
;
4693 struct ust_app_channel
*ua_chan
;
4694 struct ust_app_session
*ua_sess
;
4695 struct ust_registry_session
*registry
;
4699 /* Lookup application. If not found, there is a code flow error. */
4700 app
= find_app_by_notify_sock(sock
);
4702 DBG("Application socket %d is being teardown. Abort event notify",
4707 free(model_emf_uri
);
4708 goto error_rcu_unlock
;
4711 /* Lookup channel by UST object descriptor. */
4712 ua_chan
= find_channel_by_objd(app
, cobjd
);
4714 DBG("Application channel is being teardown. Abort event notify");
4718 free(model_emf_uri
);
4719 goto error_rcu_unlock
;
4722 assert(ua_chan
->session
);
4723 ua_sess
= ua_chan
->session
;
4725 registry
= get_session_registry(ua_sess
);
4728 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4729 chan_reg_key
= ua_chan
->tracing_channel_id
;
4731 chan_reg_key
= ua_chan
->key
;
4734 pthread_mutex_lock(®istry
->lock
);
4737 * From this point on, this call acquires the ownership of the sig, fields
4738 * and model_emf_uri meaning any free are done inside it if needed. These
4739 * three variables MUST NOT be read/write after this.
4741 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4742 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4743 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4747 * The return value is returned to ustctl so in case of an error, the
4748 * application can be notified. In case of an error, it's important not to
4749 * return a negative error or else the application will get closed.
4751 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4753 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4754 ERR("UST app reply event failed with ret %d", ret
);
4756 DBG3("UST app reply event failed. Application died");
4759 * No need to wipe the create event since the application socket will
4760 * get close on error hence cleaning up everything by itself.
4765 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4769 pthread_mutex_unlock(®istry
->lock
);
4776 * Handle application notification through the given notify socket.
4778 * Return 0 on success or else a negative value.
4780 int ust_app_recv_notify(int sock
)
4783 enum ustctl_notify_cmd cmd
;
4785 DBG3("UST app receiving notify from sock %d", sock
);
4787 ret
= ustctl_recv_notify(sock
, &cmd
);
4789 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4790 ERR("UST app recv notify failed with ret %d", ret
);
4792 DBG3("UST app recv notify failed. Application died");
4798 case USTCTL_NOTIFY_CMD_EVENT
:
4800 int sobjd
, cobjd
, loglevel
;
4801 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4803 struct ustctl_field
*fields
;
4805 DBG2("UST app ustctl register event received");
4807 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4808 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4810 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4811 ERR("UST app recv event failed with ret %d", ret
);
4813 DBG3("UST app recv event failed. Application died");
4819 * Add event to the UST registry coming from the notify socket. This
4820 * call will free if needed the sig, fields and model_emf_uri. This
4821 * code path loses the ownsership of these variables and transfer them
4822 * to the this function.
4824 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4825 fields
, loglevel
, model_emf_uri
);
4832 case USTCTL_NOTIFY_CMD_CHANNEL
:
4836 struct ustctl_field
*fields
;
4838 DBG2("UST app ustctl register channel received");
4840 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4843 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4844 ERR("UST app recv channel failed with ret %d", ret
);
4846 DBG3("UST app recv channel failed. Application died");
4852 * The fields ownership are transfered to this function call meaning
4853 * that if needed it will be freed. After this, it's invalid to access
4854 * fields or clean it up.
4856 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4865 /* Should NEVER happen. */
4874 * Once the notify socket hangs up, this is called. First, it tries to find the
4875 * corresponding application. On failure, the call_rcu to close the socket is
4876 * executed. If an application is found, it tries to delete it from the notify
4877 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4879 * Note that an object needs to be allocated here so on ENOMEM failure, the
4880 * call RCU is not done but the rest of the cleanup is.
4882 void ust_app_notify_sock_unregister(int sock
)
4885 struct lttng_ht_iter iter
;
4886 struct ust_app
*app
;
4887 struct ust_app_notify_sock_obj
*obj
;
4893 obj
= zmalloc(sizeof(*obj
));
4896 * An ENOMEM is kind of uncool. If this strikes we continue the
4897 * procedure but the call_rcu will not be called. In this case, we
4898 * accept the fd leak rather than possibly creating an unsynchronized
4899 * state between threads.
4901 * TODO: The notify object should be created once the notify socket is
4902 * registered and stored independantely from the ust app object. The
4903 * tricky part is to synchronize the teardown of the application and
4904 * this notify object. Let's keep that in mind so we can avoid this
4905 * kind of shenanigans with ENOMEM in the teardown path.
4912 DBG("UST app notify socket unregister %d", sock
);
4915 * Lookup application by notify socket. If this fails, this means that the
4916 * hash table delete has already been done by the application
4917 * unregistration process so we can safely close the notify socket in a
4920 app
= find_app_by_notify_sock(sock
);
4925 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4928 * Whatever happens here either we fail or succeed, in both cases we have
4929 * to close the socket after a grace period to continue to the call RCU
4930 * here. If the deletion is successful, the application is not visible
4931 * anymore by other threads and is it fails it means that it was already
4932 * deleted from the hash table so either way we just have to close the
4935 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4941 * Close socket after a grace period to avoid for the socket to be reused
4942 * before the application object is freed creating potential race between
4943 * threads trying to add unique in the global hash table.
4946 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4951 * Destroy a ust app data structure and free its memory.
4953 void ust_app_destroy(struct ust_app
*app
)
4959 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);