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 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
369 delete_ust_app_ctx(sock
, ua_ctx
);
373 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
375 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
377 delete_ust_app_event(sock
, ua_event
);
380 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
381 /* Wipe and free registry from session registry. */
382 registry
= get_session_registry(ua_chan
->session
);
384 ust_registry_channel_del_free(registry
, ua_chan
->key
);
388 if (ua_chan
->obj
!= NULL
) {
389 /* Remove channel from application UST object descriptor. */
390 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
391 lttng_ht_del(app
->ust_objd
, &iter
);
392 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
393 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
394 ERR("UST app sock %d release channel obj failed with ret %d",
397 lttng_fd_put(LTTNG_FD_APPS
, 1);
400 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
404 * Push metadata to consumer socket.
406 * The socket lock MUST be acquired.
407 * The ust app session lock MUST be acquired.
409 * On success, return the len of metadata pushed or else a negative value.
411 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
412 struct consumer_socket
*socket
, int send_zero_data
)
415 char *metadata_str
= NULL
;
423 * On a push metadata error either the consumer is dead or the metadata
424 * channel has been destroyed because its endpoint might have died (e.g:
425 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
426 * metadata again which is not valid anymore on the consumer side.
428 * The ust app session mutex locked allows us to make this check without
431 if (registry
->metadata_closed
) {
435 pthread_mutex_lock(®istry
->lock
);
437 offset
= registry
->metadata_len_sent
;
438 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
440 DBG3("No metadata to push for metadata key %" PRIu64
,
441 registry
->metadata_key
);
443 if (send_zero_data
) {
444 DBG("No metadata to push");
450 /* Allocate only what we have to send. */
451 metadata_str
= zmalloc(len
);
453 PERROR("zmalloc ust app metadata string");
457 /* Copy what we haven't send out. */
458 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
459 registry
->metadata_len_sent
+= len
;
462 pthread_mutex_unlock(®istry
->lock
);
463 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
464 metadata_str
, len
, offset
);
475 pthread_mutex_unlock(®istry
->lock
);
482 * For a given application and session, push metadata to consumer. The session
483 * lock MUST be acquired here before calling this.
484 * Either sock or consumer is required : if sock is NULL, the default
485 * socket to send the metadata is retrieved from consumer, if sock
486 * is not NULL we use it to send the metadata.
488 * Return 0 on success else a negative error.
490 static int push_metadata(struct ust_registry_session
*registry
,
491 struct consumer_output
*consumer
)
495 struct consumer_socket
*socket
;
503 * Means that no metadata was assigned to the session. This can happens if
504 * no start has been done previously.
506 if (!registry
->metadata_key
) {
511 /* Get consumer socket to use to push the metadata.*/
512 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
516 goto error_rcu_unlock
;
520 * TODO: Currently, we hold the socket lock around sampling of the next
521 * metadata segment to ensure we send metadata over the consumer socket in
522 * the correct order. This makes the registry lock nest inside the socket
525 * Please note that this is a temporary measure: we should move this lock
526 * back into ust_consumer_push_metadata() when the consumer gets the
527 * ability to reorder the metadata it receives.
529 pthread_mutex_lock(socket
->lock
);
530 ret
= ust_app_push_metadata(registry
, socket
, 0);
531 pthread_mutex_unlock(socket
->lock
);
534 goto error_rcu_unlock
;
542 * On error, flag the registry that the metadata is closed. We were unable
543 * to push anything and this means that either the consumer is not
544 * responding or the metadata cache has been destroyed on the consumer.
546 registry
->metadata_closed
= 1;
553 * Send to the consumer a close metadata command for the given session. Once
554 * done, the metadata channel is deleted and the session metadata pointer is
555 * nullified. The session lock MUST be acquired here unless the application is
556 * in the destroy path.
558 * Return 0 on success else a negative value.
560 static int close_metadata(struct ust_registry_session
*registry
,
561 struct consumer_output
*consumer
)
564 struct consumer_socket
*socket
;
571 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
576 /* Get consumer socket to use to push the metadata.*/
577 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
584 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
591 * Metadata closed. Even on error this means that the consumer is not
592 * responding or not found so either way a second close should NOT be emit
595 registry
->metadata_closed
= 1;
602 * We need to execute ht_destroy outside of RCU read-side critical
603 * section and outside of call_rcu thread, so we postpone its execution
604 * using ht_cleanup_push. It is simpler than to change the semantic of
605 * the many callers of delete_ust_app_session().
608 void delete_ust_app_session_rcu(struct rcu_head
*head
)
610 struct ust_app_session
*ua_sess
=
611 caa_container_of(head
, struct ust_app_session
, rcu_head
);
613 ht_cleanup_push(ua_sess
->channels
);
618 * Delete ust app session safely. RCU read lock must be held before calling
622 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
626 struct lttng_ht_iter iter
;
627 struct ust_app_channel
*ua_chan
;
628 struct ust_registry_session
*registry
;
632 pthread_mutex_lock(&ua_sess
->lock
);
634 registry
= get_session_registry(ua_sess
);
635 if (registry
&& !registry
->metadata_closed
) {
636 /* Push metadata for application before freeing the application. */
637 (void) push_metadata(registry
, ua_sess
->consumer
);
640 * Don't ask to close metadata for global per UID buffers. Close
641 * metadata only on destroy trace session in this case. Also, the
642 * previous push metadata could have flag the metadata registry to
643 * close so don't send a close command if closed.
645 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
646 !registry
->metadata_closed
) {
647 /* And ask to close it for this session registry. */
648 (void) close_metadata(registry
, ua_sess
->consumer
);
652 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
654 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
656 delete_ust_app_channel(sock
, ua_chan
, app
);
659 /* In case of per PID, the registry is kept in the session. */
660 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
661 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
663 buffer_reg_pid_remove(reg_pid
);
664 buffer_reg_pid_destroy(reg_pid
);
668 if (ua_sess
->handle
!= -1) {
669 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
670 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
671 ERR("UST app sock %d release session handle failed with ret %d",
675 pthread_mutex_unlock(&ua_sess
->lock
);
677 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
681 * Delete a traceable application structure from the global list. Never call
682 * this function outside of a call_rcu call.
684 * RCU read side lock should _NOT_ be held when calling this function.
687 void delete_ust_app(struct ust_app
*app
)
690 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
692 /* Delete ust app sessions info */
697 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
699 /* Free every object in the session and the session. */
701 delete_ust_app_session(sock
, ua_sess
, app
);
705 ht_cleanup_push(app
->sessions
);
706 ht_cleanup_push(app
->ust_objd
);
709 * Wait until we have deleted the application from the sock hash table
710 * before closing this socket, otherwise an application could re-use the
711 * socket ID and race with the teardown, using the same hash table entry.
713 * It's OK to leave the close in call_rcu. We want it to stay unique for
714 * all RCU readers that could run concurrently with unregister app,
715 * therefore we _need_ to only close that socket after a grace period. So
716 * it should stay in this RCU callback.
718 * This close() is a very important step of the synchronization model so
719 * every modification to this function must be carefully reviewed.
725 lttng_fd_put(LTTNG_FD_APPS
, 1);
727 DBG2("UST app pid %d deleted", app
->pid
);
732 * URCU intermediate call to delete an UST app.
735 void delete_ust_app_rcu(struct rcu_head
*head
)
737 struct lttng_ht_node_ulong
*node
=
738 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
739 struct ust_app
*app
=
740 caa_container_of(node
, struct ust_app
, pid_n
);
742 DBG3("Call RCU deleting app PID %d", app
->pid
);
747 * Delete the session from the application ht and delete the data structure by
748 * freeing every object inside and releasing them.
750 static void destroy_app_session(struct ust_app
*app
,
751 struct ust_app_session
*ua_sess
)
754 struct lttng_ht_iter iter
;
759 iter
.iter
.node
= &ua_sess
->node
.node
;
760 ret
= lttng_ht_del(app
->sessions
, &iter
);
762 /* Already scheduled for teardown. */
766 /* Once deleted, free the data structure. */
767 delete_ust_app_session(app
->sock
, ua_sess
, app
);
774 * Alloc new UST app session.
777 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
779 struct ust_app_session
*ua_sess
;
781 /* Init most of the default value by allocating and zeroing */
782 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
783 if (ua_sess
== NULL
) {
788 ua_sess
->handle
= -1;
789 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
790 pthread_mutex_init(&ua_sess
->lock
, NULL
);
799 * Alloc new UST app channel.
802 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
803 struct ust_app_session
*ua_sess
,
804 struct lttng_ust_channel_attr
*attr
)
806 struct ust_app_channel
*ua_chan
;
808 /* Init most of the default value by allocating and zeroing */
809 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
810 if (ua_chan
== NULL
) {
815 /* Setup channel name */
816 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
817 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
819 ua_chan
->enabled
= 1;
820 ua_chan
->handle
= -1;
821 ua_chan
->session
= ua_sess
;
822 ua_chan
->key
= get_next_channel_key();
823 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
824 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
825 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
827 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
829 /* Copy attributes */
831 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
832 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
833 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
834 ua_chan
->attr
.overwrite
= attr
->overwrite
;
835 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
836 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
837 ua_chan
->attr
.output
= attr
->output
;
839 /* By default, the channel is a per cpu channel. */
840 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
842 DBG3("UST app channel %s allocated", ua_chan
->name
);
851 * Allocate and initialize a UST app stream.
853 * Return newly allocated stream pointer or NULL on error.
855 struct ust_app_stream
*ust_app_alloc_stream(void)
857 struct ust_app_stream
*stream
= NULL
;
859 stream
= zmalloc(sizeof(*stream
));
860 if (stream
== NULL
) {
861 PERROR("zmalloc ust app stream");
865 /* Zero could be a valid value for a handle so flag it to -1. */
873 * Alloc new UST app event.
876 struct ust_app_event
*alloc_ust_app_event(char *name
,
877 struct lttng_ust_event
*attr
)
879 struct ust_app_event
*ua_event
;
881 /* Init most of the default value by allocating and zeroing */
882 ua_event
= zmalloc(sizeof(struct ust_app_event
));
883 if (ua_event
== NULL
) {
888 ua_event
->enabled
= 1;
889 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
890 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
891 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
893 /* Copy attributes */
895 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
898 DBG3("UST app event %s allocated", ua_event
->name
);
907 * Alloc new UST app context.
910 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
912 struct ust_app_ctx
*ua_ctx
;
914 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
915 if (ua_ctx
== NULL
) {
920 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
923 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
930 * Allocate a filter and copy the given original filter.
932 * Return allocated filter or NULL on error.
934 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
935 struct lttng_ust_filter_bytecode
*orig_f
)
937 struct lttng_ust_filter_bytecode
*filter
= NULL
;
939 /* Copy filter bytecode */
940 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
942 PERROR("zmalloc alloc ust app filter");
946 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
953 * Find an ust_app using the sock and return it. RCU read side lock must be
954 * held before calling this helper function.
957 struct ust_app
*find_app_by_sock(int sock
)
959 struct lttng_ht_node_ulong
*node
;
960 struct lttng_ht_iter iter
;
962 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
963 node
= lttng_ht_iter_get_node_ulong(&iter
);
965 DBG2("UST app find by sock %d not found", sock
);
969 return caa_container_of(node
, struct ust_app
, sock_n
);
976 * Find an ust_app using the notify sock and return it. RCU read side lock must
977 * be held before calling this helper function.
979 static struct ust_app
*find_app_by_notify_sock(int sock
)
981 struct lttng_ht_node_ulong
*node
;
982 struct lttng_ht_iter iter
;
984 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
986 node
= lttng_ht_iter_get_node_ulong(&iter
);
988 DBG2("UST app find by notify sock %d not found", sock
);
992 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
999 * Lookup for an ust app event based on event name, filter bytecode and the
1002 * Return an ust_app_event object or NULL on error.
1004 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1005 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
1007 struct lttng_ht_iter iter
;
1008 struct lttng_ht_node_str
*node
;
1009 struct ust_app_event
*event
= NULL
;
1010 struct ust_app_ht_key key
;
1015 /* Setup key for event lookup. */
1017 key
.filter
= filter
;
1018 key
.loglevel
= loglevel
;
1020 /* Lookup using the event name as hash and a custom match fct. */
1021 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1022 ht_match_ust_app_event
, &key
, &iter
.iter
);
1023 node
= lttng_ht_iter_get_node_str(&iter
);
1028 event
= caa_container_of(node
, struct ust_app_event
, node
);
1035 * Create the channel context on the tracer.
1037 * Called with UST app session lock held.
1040 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1041 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1045 health_code_update();
1047 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1048 ua_chan
->obj
, &ua_ctx
->obj
);
1050 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1051 ERR("UST app create channel context failed for app (pid: %d) "
1052 "with ret %d", app
->pid
, ret
);
1054 DBG3("UST app disable event failed. Application is dead.");
1059 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1061 DBG2("UST app context handle %d created successfully for channel %s",
1062 ua_ctx
->handle
, ua_chan
->name
);
1065 health_code_update();
1070 * Set the filter on the tracer.
1073 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1074 struct ust_app
*app
)
1078 health_code_update();
1080 if (!ua_event
->filter
) {
1085 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1088 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1089 ERR("UST app event %s filter failed for app (pid: %d) "
1090 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1092 DBG3("UST app filter event failed. Application is dead.");
1097 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1100 health_code_update();
1105 * Disable the specified event on to UST tracer for the UST session.
1107 static int disable_ust_event(struct ust_app
*app
,
1108 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1112 health_code_update();
1114 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1116 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1117 ERR("UST app event %s disable failed for app (pid: %d) "
1118 "and session handle %d with ret %d",
1119 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1121 DBG3("UST app disable event failed. Application is dead.");
1126 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1127 ua_event
->attr
.name
, app
->pid
);
1130 health_code_update();
1135 * Disable the specified channel on to UST tracer for the UST session.
1137 static int disable_ust_channel(struct ust_app
*app
,
1138 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1142 health_code_update();
1144 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1146 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1147 ERR("UST app channel %s disable failed for app (pid: %d) "
1148 "and session handle %d with ret %d",
1149 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1151 DBG3("UST app disable channel failed. Application is dead.");
1156 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1157 ua_chan
->name
, app
->pid
);
1160 health_code_update();
1165 * Enable the specified channel on to UST tracer for the UST session.
1167 static int enable_ust_channel(struct ust_app
*app
,
1168 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1172 health_code_update();
1174 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1176 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1177 ERR("UST app channel %s enable failed for app (pid: %d) "
1178 "and session handle %d with ret %d",
1179 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1181 DBG3("UST app enable channel failed. Application is dead.");
1186 ua_chan
->enabled
= 1;
1188 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1189 ua_chan
->name
, app
->pid
);
1192 health_code_update();
1197 * Enable the specified event on to UST tracer for the UST session.
1199 static int enable_ust_event(struct ust_app
*app
,
1200 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1204 health_code_update();
1206 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1208 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1209 ERR("UST app event %s enable failed for app (pid: %d) "
1210 "and session handle %d with ret %d",
1211 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1213 DBG3("UST app enable event failed. Application is dead.");
1218 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1219 ua_event
->attr
.name
, app
->pid
);
1222 health_code_update();
1227 * Send channel and stream buffer to application.
1229 * Return 0 on success. On error, a negative value is returned.
1231 static int send_channel_pid_to_ust(struct ust_app
*app
,
1232 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1235 struct ust_app_stream
*stream
, *stmp
;
1241 health_code_update();
1243 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1246 /* Send channel to the application. */
1247 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1252 health_code_update();
1254 /* Send all streams to application. */
1255 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1256 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1260 /* We don't need the stream anymore once sent to the tracer. */
1261 cds_list_del(&stream
->list
);
1262 delete_ust_app_stream(-1, stream
);
1264 /* Flag the channel that it is sent to the application. */
1265 ua_chan
->is_sent
= 1;
1268 health_code_update();
1273 * Create the specified event onto the UST tracer for a UST session.
1275 * Should be called with session mutex held.
1278 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1279 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1283 health_code_update();
1285 /* Create UST event on tracer */
1286 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1289 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1290 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1291 ua_event
->attr
.name
, app
->pid
, ret
);
1293 DBG3("UST app create event failed. Application is dead.");
1298 ua_event
->handle
= ua_event
->obj
->handle
;
1300 DBG2("UST app event %s created successfully for pid:%d",
1301 ua_event
->attr
.name
, app
->pid
);
1303 health_code_update();
1305 /* Set filter if one is present. */
1306 if (ua_event
->filter
) {
1307 ret
= set_ust_event_filter(ua_event
, app
);
1313 /* If event not enabled, disable it on the tracer */
1314 if (ua_event
->enabled
== 0) {
1315 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1318 * If we hit an EPERM, something is wrong with our disable call. If
1319 * we get an EEXIST, there is a problem on the tracer side since we
1323 case -LTTNG_UST_ERR_PERM
:
1324 /* Code flow problem */
1326 case -LTTNG_UST_ERR_EXIST
:
1327 /* It's OK for our use case. */
1338 health_code_update();
1343 * Copy data between an UST app event and a LTT event.
1345 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1346 struct ltt_ust_event
*uevent
)
1348 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1349 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1351 ua_event
->enabled
= uevent
->enabled
;
1353 /* Copy event attributes */
1354 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1356 /* Copy filter bytecode */
1357 if (uevent
->filter
) {
1358 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1359 /* Filter might be NULL here in case of ENONEM. */
1364 * Copy data between an UST app channel and a LTT channel.
1366 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1367 struct ltt_ust_channel
*uchan
)
1369 struct lttng_ht_iter iter
;
1370 struct ltt_ust_event
*uevent
;
1371 struct ltt_ust_context
*uctx
;
1372 struct ust_app_event
*ua_event
;
1373 struct ust_app_ctx
*ua_ctx
;
1375 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1377 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1378 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1380 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1381 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1383 /* Copy event attributes since the layout is different. */
1384 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1385 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1386 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1387 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1388 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1389 ua_chan
->attr
.output
= uchan
->attr
.output
;
1391 * Note that the attribute channel type is not set since the channel on the
1392 * tracing registry side does not have this information.
1395 ua_chan
->enabled
= uchan
->enabled
;
1396 ua_chan
->tracing_channel_id
= uchan
->id
;
1398 cds_lfht_for_each_entry(uchan
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
1399 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1400 if (ua_ctx
== NULL
) {
1403 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1404 (unsigned long) ua_ctx
->ctx
.ctx
);
1405 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1408 /* Copy all events from ltt ust channel to ust app channel */
1409 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1410 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1411 uevent
->filter
, uevent
->attr
.loglevel
);
1412 if (ua_event
== NULL
) {
1413 DBG2("UST event %s not found on shadow copy channel",
1415 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1416 if (ua_event
== NULL
) {
1419 shadow_copy_event(ua_event
, uevent
);
1420 add_unique_ust_app_event(ua_chan
, ua_event
);
1424 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1428 * Copy data between a UST app session and a regular LTT session.
1430 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1431 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1433 struct lttng_ht_node_str
*ua_chan_node
;
1434 struct lttng_ht_iter iter
;
1435 struct ltt_ust_channel
*uchan
;
1436 struct ust_app_channel
*ua_chan
;
1438 struct tm
*timeinfo
;
1442 /* Get date and time for unique app path */
1444 timeinfo
= localtime(&rawtime
);
1445 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1447 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1449 ua_sess
->tracing_id
= usess
->id
;
1450 ua_sess
->id
= get_next_session_id();
1451 ua_sess
->uid
= app
->uid
;
1452 ua_sess
->gid
= app
->gid
;
1453 ua_sess
->euid
= usess
->uid
;
1454 ua_sess
->egid
= usess
->gid
;
1455 ua_sess
->buffer_type
= usess
->buffer_type
;
1456 ua_sess
->bits_per_long
= app
->bits_per_long
;
1457 /* There is only one consumer object per session possible. */
1458 ua_sess
->consumer
= usess
->consumer
;
1460 switch (ua_sess
->buffer_type
) {
1461 case LTTNG_BUFFER_PER_PID
:
1462 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1463 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1466 case LTTNG_BUFFER_PER_UID
:
1467 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1468 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1475 PERROR("asprintf UST shadow copy session");
1480 /* Iterate over all channels in global domain. */
1481 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1483 struct lttng_ht_iter uiter
;
1485 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1486 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1487 if (ua_chan_node
!= NULL
) {
1488 /* Session exist. Contiuing. */
1492 DBG2("Channel %s not found on shadow session copy, creating it",
1494 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1495 if (ua_chan
== NULL
) {
1496 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1499 shadow_copy_channel(ua_chan
, uchan
);
1501 * The concept of metadata channel does not exist on the tracing
1502 * registry side of the session daemon so this can only be a per CPU
1503 * channel and not metadata.
1505 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1507 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1515 * Lookup sesison wrapper.
1518 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1519 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1521 /* Get right UST app session from app */
1522 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1526 * Return ust app session from the app session hashtable using the UST session
1529 static struct ust_app_session
*lookup_session_by_app(
1530 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1532 struct lttng_ht_iter iter
;
1533 struct lttng_ht_node_u64
*node
;
1535 __lookup_session_by_app(usess
, app
, &iter
);
1536 node
= lttng_ht_iter_get_node_u64(&iter
);
1541 return caa_container_of(node
, struct ust_app_session
, node
);
1548 * Setup buffer registry per PID for the given session and application. If none
1549 * is found, a new one is created, added to the global registry and
1550 * initialized. If regp is valid, it's set with the newly created object.
1552 * Return 0 on success or else a negative value.
1554 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1555 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1558 struct buffer_reg_pid
*reg_pid
;
1565 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1568 * This is the create channel path meaning that if there is NO
1569 * registry available, we have to create one for this session.
1571 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1575 buffer_reg_pid_add(reg_pid
);
1580 /* Initialize registry. */
1581 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1582 app
->bits_per_long
, app
->uint8_t_alignment
,
1583 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1584 app
->uint64_t_alignment
, app
->long_alignment
,
1585 app
->byte_order
, app
->version
.major
,
1586 app
->version
.minor
);
1591 DBG3("UST app buffer registry per PID created successfully");
1603 * Setup buffer registry per UID for the given session and application. If none
1604 * is found, a new one is created, added to the global registry and
1605 * initialized. If regp is valid, it's set with the newly created object.
1607 * Return 0 on success or else a negative value.
1609 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1610 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1613 struct buffer_reg_uid
*reg_uid
;
1620 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1623 * This is the create channel path meaning that if there is NO
1624 * registry available, we have to create one for this session.
1626 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1627 LTTNG_DOMAIN_UST
, ®_uid
);
1631 buffer_reg_uid_add(reg_uid
);
1636 /* Initialize registry. */
1637 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1638 app
->bits_per_long
, app
->uint8_t_alignment
,
1639 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1640 app
->uint64_t_alignment
, app
->long_alignment
,
1641 app
->byte_order
, app
->version
.major
,
1642 app
->version
.minor
);
1646 /* Add node to teardown list of the session. */
1647 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1649 DBG3("UST app buffer registry per UID created successfully");
1661 * Create a session on the tracer side for the given app.
1663 * On success, ua_sess_ptr is populated with the session pointer or else left
1664 * untouched. If the session was created, is_created is set to 1. On error,
1665 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1668 * Returns 0 on success or else a negative code which is either -ENOMEM or
1669 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1671 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1672 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1675 int ret
, created
= 0;
1676 struct ust_app_session
*ua_sess
;
1680 assert(ua_sess_ptr
);
1682 health_code_update();
1684 ua_sess
= lookup_session_by_app(usess
, app
);
1685 if (ua_sess
== NULL
) {
1686 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1687 app
->pid
, usess
->id
);
1688 ua_sess
= alloc_ust_app_session(app
);
1689 if (ua_sess
== NULL
) {
1690 /* Only malloc can failed so something is really wrong */
1694 shadow_copy_session(ua_sess
, usess
, app
);
1698 switch (usess
->buffer_type
) {
1699 case LTTNG_BUFFER_PER_PID
:
1700 /* Init local registry. */
1701 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1706 case LTTNG_BUFFER_PER_UID
:
1707 /* Look for a global registry. If none exists, create one. */
1708 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1719 health_code_update();
1721 if (ua_sess
->handle
== -1) {
1722 ret
= ustctl_create_session(app
->sock
);
1724 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1725 ERR("Creating session for app pid %d with ret %d",
1728 DBG("UST app creating session failed. Application is dead");
1730 delete_ust_app_session(-1, ua_sess
, app
);
1731 if (ret
!= -ENOMEM
) {
1733 * Tracer is probably gone or got an internal error so let's
1734 * behave like it will soon unregister or not usable.
1741 ua_sess
->handle
= ret
;
1743 /* Add ust app session to app's HT */
1744 lttng_ht_node_init_u64(&ua_sess
->node
,
1745 ua_sess
->tracing_id
);
1746 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1748 DBG2("UST app session created successfully with handle %d", ret
);
1751 *ua_sess_ptr
= ua_sess
;
1753 *is_created
= created
;
1756 /* Everything went well. */
1760 health_code_update();
1765 * Create a context for the channel on the tracer.
1767 * Called with UST app session lock held and a RCU read side lock.
1770 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1771 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1772 struct ust_app
*app
)
1775 struct lttng_ht_iter iter
;
1776 struct lttng_ht_node_ulong
*node
;
1777 struct ust_app_ctx
*ua_ctx
;
1779 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1781 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1782 node
= lttng_ht_iter_get_node_ulong(&iter
);
1788 ua_ctx
= alloc_ust_app_ctx(uctx
);
1789 if (ua_ctx
== NULL
) {
1795 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1796 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1798 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1808 * Enable on the tracer side a ust app event for the session and channel.
1810 * Called with UST app session lock held.
1813 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1814 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1818 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1823 ua_event
->enabled
= 1;
1830 * Disable on the tracer side a ust app event for the session and channel.
1832 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1833 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1837 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1842 ua_event
->enabled
= 0;
1849 * Lookup ust app channel for session and disable it on the tracer side.
1852 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1853 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1857 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1862 ua_chan
->enabled
= 0;
1869 * Lookup ust app channel for session and enable it on the tracer side. This
1870 * MUST be called with a RCU read side lock acquired.
1872 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1873 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1876 struct lttng_ht_iter iter
;
1877 struct lttng_ht_node_str
*ua_chan_node
;
1878 struct ust_app_channel
*ua_chan
;
1880 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1881 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1882 if (ua_chan_node
== NULL
) {
1883 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
1884 uchan
->name
, ua_sess
->tracing_id
);
1888 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1890 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1900 * Ask the consumer to create a channel and get it if successful.
1902 * Return 0 on success or else a negative value.
1904 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1905 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1906 int bitness
, struct ust_registry_session
*registry
)
1909 unsigned int nb_fd
= 0;
1910 struct consumer_socket
*socket
;
1918 health_code_update();
1920 /* Get the right consumer socket for the application. */
1921 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1927 health_code_update();
1929 /* Need one fd for the channel. */
1930 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1932 ERR("Exhausted number of available FD upon create channel");
1937 * Ask consumer to create channel. The consumer will return the number of
1938 * stream we have to expect.
1940 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
1947 * Compute the number of fd needed before receiving them. It must be 2 per
1948 * stream (2 being the default value here).
1950 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
1952 /* Reserve the amount of file descriptor we need. */
1953 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
1955 ERR("Exhausted number of available FD upon create channel");
1956 goto error_fd_get_stream
;
1959 health_code_update();
1962 * Now get the channel from the consumer. This call wil populate the stream
1963 * list of that channel and set the ust objects.
1965 if (usess
->consumer
->enabled
) {
1966 ret
= ust_consumer_get_channel(socket
, ua_chan
);
1976 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
1977 error_fd_get_stream
:
1979 * Initiate a destroy channel on the consumer since we had an error
1980 * handling it on our side. The return value is of no importance since we
1981 * already have a ret value set by the previous error that we need to
1984 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
1986 lttng_fd_put(LTTNG_FD_APPS
, 1);
1988 health_code_update();
1994 * Duplicate the ust data object of the ust app stream and save it in the
1995 * buffer registry stream.
1997 * Return 0 on success or else a negative value.
1999 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2000 struct ust_app_stream
*stream
)
2007 /* Reserve the amount of file descriptor we need. */
2008 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2010 ERR("Exhausted number of available FD upon duplicate stream");
2014 /* Duplicate object for stream once the original is in the registry. */
2015 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2016 reg_stream
->obj
.ust
);
2018 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2019 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2020 lttng_fd_put(LTTNG_FD_APPS
, 2);
2023 stream
->handle
= stream
->obj
->handle
;
2030 * Duplicate the ust data object of the ust app. channel and save it in the
2031 * buffer registry channel.
2033 * Return 0 on success or else a negative value.
2035 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2036 struct ust_app_channel
*ua_chan
)
2043 /* Need two fds for the channel. */
2044 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2046 ERR("Exhausted number of available FD upon duplicate channel");
2050 /* Duplicate object for stream once the original is in the registry. */
2051 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2053 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2054 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2057 ua_chan
->handle
= ua_chan
->obj
->handle
;
2062 lttng_fd_put(LTTNG_FD_APPS
, 1);
2068 * For a given channel buffer registry, setup all streams of the given ust
2069 * application channel.
2071 * Return 0 on success or else a negative value.
2073 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2074 struct ust_app_channel
*ua_chan
)
2077 struct ust_app_stream
*stream
, *stmp
;
2082 DBG2("UST app setup buffer registry stream");
2084 /* Send all streams to application. */
2085 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2086 struct buffer_reg_stream
*reg_stream
;
2088 ret
= buffer_reg_stream_create(®_stream
);
2094 * Keep original pointer and nullify it in the stream so the delete
2095 * stream call does not release the object.
2097 reg_stream
->obj
.ust
= stream
->obj
;
2099 buffer_reg_stream_add(reg_stream
, reg_chan
);
2101 /* We don't need the streams anymore. */
2102 cds_list_del(&stream
->list
);
2103 delete_ust_app_stream(-1, stream
);
2111 * Create a buffer registry channel for the given session registry and
2112 * application channel object. If regp pointer is valid, it's set with the
2113 * created object. Important, the created object is NOT added to the session
2114 * registry hash table.
2116 * Return 0 on success else a negative value.
2118 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2119 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2122 struct buffer_reg_channel
*reg_chan
= NULL
;
2127 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2129 /* Create buffer registry channel. */
2130 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2135 reg_chan
->consumer_key
= ua_chan
->key
;
2137 /* Create and add a channel registry to session. */
2138 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2139 ua_chan
->tracing_channel_id
);
2143 buffer_reg_channel_add(reg_sess
, reg_chan
);
2152 /* Safe because the registry channel object was not added to any HT. */
2153 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2159 * Setup buffer registry channel for the given session registry and application
2160 * channel object. If regp pointer is valid, it's set with the created object.
2162 * Return 0 on success else a negative value.
2164 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2165 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2172 assert(ua_chan
->obj
);
2174 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2176 /* Setup all streams for the registry. */
2177 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2182 reg_chan
->obj
.ust
= ua_chan
->obj
;
2183 ua_chan
->obj
= NULL
;
2188 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2189 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2194 * Send buffer registry channel to the application.
2196 * Return 0 on success else a negative value.
2198 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2199 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2200 struct ust_app_channel
*ua_chan
)
2203 struct buffer_reg_stream
*reg_stream
;
2210 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2212 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2217 /* Send channel to the application. */
2218 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2223 health_code_update();
2225 /* Send all streams to application. */
2226 pthread_mutex_lock(®_chan
->stream_list_lock
);
2227 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2228 struct ust_app_stream stream
;
2230 ret
= duplicate_stream_object(reg_stream
, &stream
);
2232 goto error_stream_unlock
;
2235 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2237 (void) release_ust_app_stream(-1, &stream
);
2238 goto error_stream_unlock
;
2242 * The return value is not important here. This function will output an
2245 (void) release_ust_app_stream(-1, &stream
);
2247 ua_chan
->is_sent
= 1;
2249 error_stream_unlock
:
2250 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2256 * Create and send to the application the created buffers with per UID buffers.
2258 * Return 0 on success else a negative value.
2260 static int create_channel_per_uid(struct ust_app
*app
,
2261 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2262 struct ust_app_channel
*ua_chan
)
2265 struct buffer_reg_uid
*reg_uid
;
2266 struct buffer_reg_channel
*reg_chan
;
2273 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2275 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2277 * The session creation handles the creation of this global registry
2278 * object. If none can be find, there is a code flow problem or a
2283 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2286 /* Create the buffer registry channel object. */
2287 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2294 * Create the buffers on the consumer side. This call populates the
2295 * ust app channel object with all streams and data object.
2297 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2298 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2301 * Let's remove the previously created buffer registry channel so
2302 * it's not visible anymore in the session registry.
2304 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2305 ua_chan
->tracing_channel_id
);
2306 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2307 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2312 * Setup the streams and add it to the session registry.
2314 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2321 /* Send buffers to the application. */
2322 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2332 * Create and send to the application the created buffers with per PID buffers.
2334 * Return 0 on success else a negative value.
2336 static int create_channel_per_pid(struct ust_app
*app
,
2337 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2338 struct ust_app_channel
*ua_chan
)
2341 struct ust_registry_session
*registry
;
2348 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2352 registry
= get_session_registry(ua_sess
);
2355 /* Create and add a new channel registry to session. */
2356 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2361 /* Create and get channel on the consumer side. */
2362 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2363 app
->bits_per_long
, registry
);
2368 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2379 * From an already allocated ust app channel, create the channel buffers if
2380 * need and send it to the application. This MUST be called with a RCU read
2381 * side lock acquired.
2383 * Return 0 on success or else a negative value.
2385 static int do_create_channel(struct ust_app
*app
,
2386 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2387 struct ust_app_channel
*ua_chan
)
2396 /* Handle buffer type before sending the channel to the application. */
2397 switch (usess
->buffer_type
) {
2398 case LTTNG_BUFFER_PER_UID
:
2400 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2406 case LTTNG_BUFFER_PER_PID
:
2408 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2420 /* Initialize ust objd object using the received handle and add it. */
2421 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2422 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2424 /* If channel is not enabled, disable it on the tracer */
2425 if (!ua_chan
->enabled
) {
2426 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2437 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2438 * newly created channel if not NULL.
2440 * Called with UST app session lock and RCU read-side lock held.
2442 * Return 0 on success or else a negative value.
2444 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2445 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2446 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2447 struct ust_app_channel
**ua_chanp
)
2450 struct lttng_ht_iter iter
;
2451 struct lttng_ht_node_str
*ua_chan_node
;
2452 struct ust_app_channel
*ua_chan
;
2454 /* Lookup channel in the ust app session */
2455 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2456 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2457 if (ua_chan_node
!= NULL
) {
2458 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2462 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2463 if (ua_chan
== NULL
) {
2464 /* Only malloc can fail here */
2468 shadow_copy_channel(ua_chan
, uchan
);
2470 /* Set channel type. */
2471 ua_chan
->attr
.type
= type
;
2473 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2478 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2481 /* Only add the channel if successful on the tracer side. */
2482 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2486 *ua_chanp
= ua_chan
;
2489 /* Everything went well. */
2493 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2499 * Create UST app event and create it on the tracer side.
2501 * Called with ust app session mutex held.
2504 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2505 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2506 struct ust_app
*app
)
2509 struct ust_app_event
*ua_event
;
2511 /* Get event node */
2512 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2513 uevent
->filter
, uevent
->attr
.loglevel
);
2514 if (ua_event
!= NULL
) {
2519 /* Does not exist so create one */
2520 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2521 if (ua_event
== NULL
) {
2522 /* Only malloc can failed so something is really wrong */
2526 shadow_copy_event(ua_event
, uevent
);
2528 /* Create it on the tracer side */
2529 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2531 /* Not found previously means that it does not exist on the tracer */
2532 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2536 add_unique_ust_app_event(ua_chan
, ua_event
);
2538 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2545 /* Valid. Calling here is already in a read side lock */
2546 delete_ust_app_event(-1, ua_event
);
2551 * Create UST metadata and open it on the tracer side.
2553 * Called with UST app session lock held and RCU read side lock.
2555 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2556 struct ust_app
*app
, struct consumer_output
*consumer
,
2557 struct ustctl_consumer_channel_attr
*attr
)
2560 struct ust_app_channel
*metadata
;
2561 struct consumer_socket
*socket
;
2562 struct ust_registry_session
*registry
;
2568 registry
= get_session_registry(ua_sess
);
2571 /* Metadata already exists for this registry or it was closed previously */
2572 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2577 /* Allocate UST metadata */
2578 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2580 /* malloc() failed */
2586 /* Set default attributes for metadata. */
2587 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2588 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2589 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2590 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2591 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2592 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2593 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2595 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2596 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2597 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2600 /* Need one fd for the channel. */
2601 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2603 ERR("Exhausted number of available FD upon create metadata");
2607 /* Get the right consumer socket for the application. */
2608 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2611 goto error_consumer
;
2615 * Keep metadata key so we can identify it on the consumer side. Assign it
2616 * to the registry *before* we ask the consumer so we avoid the race of the
2617 * consumer requesting the metadata and the ask_channel call on our side
2618 * did not returned yet.
2620 registry
->metadata_key
= metadata
->key
;
2623 * Ask the metadata channel creation to the consumer. The metadata object
2624 * will be created by the consumer and kept their. However, the stream is
2625 * never added or monitored until we do a first push metadata to the
2628 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2631 /* Nullify the metadata key so we don't try to close it later on. */
2632 registry
->metadata_key
= 0;
2633 goto error_consumer
;
2637 * The setup command will make the metadata stream be sent to the relayd,
2638 * if applicable, and the thread managing the metadatas. This is important
2639 * because after this point, if an error occurs, the only way the stream
2640 * can be deleted is to be monitored in the consumer.
2642 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2644 /* Nullify the metadata key so we don't try to close it later on. */
2645 registry
->metadata_key
= 0;
2646 goto error_consumer
;
2649 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2650 metadata
->key
, app
->pid
);
2653 lttng_fd_put(LTTNG_FD_APPS
, 1);
2654 delete_ust_app_channel(-1, metadata
, app
);
2660 * Return pointer to traceable apps list.
2662 struct lttng_ht
*ust_app_get_ht(void)
2668 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2669 * acquired before calling this function.
2671 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2673 struct ust_app
*app
= NULL
;
2674 struct lttng_ht_node_ulong
*node
;
2675 struct lttng_ht_iter iter
;
2677 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2678 node
= lttng_ht_iter_get_node_ulong(&iter
);
2680 DBG2("UST app no found with pid %d", pid
);
2684 DBG2("Found UST app by pid %d", pid
);
2686 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2693 * Allocate and init an UST app object using the registration information and
2694 * the command socket. This is called when the command socket connects to the
2697 * The object is returned on success or else NULL.
2699 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2701 struct ust_app
*lta
= NULL
;
2706 DBG3("UST app creating application for socket %d", sock
);
2708 if ((msg
->bits_per_long
== 64 &&
2709 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2710 || (msg
->bits_per_long
== 32 &&
2711 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2712 ERR("Registration failed: application \"%s\" (pid: %d) has "
2713 "%d-bit long, but no consumerd for this size is available.\n",
2714 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2718 lta
= zmalloc(sizeof(struct ust_app
));
2724 lta
->ppid
= msg
->ppid
;
2725 lta
->uid
= msg
->uid
;
2726 lta
->gid
= msg
->gid
;
2728 lta
->bits_per_long
= msg
->bits_per_long
;
2729 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2730 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2731 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2732 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2733 lta
->long_alignment
= msg
->long_alignment
;
2734 lta
->byte_order
= msg
->byte_order
;
2736 lta
->v_major
= msg
->major
;
2737 lta
->v_minor
= msg
->minor
;
2738 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2739 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2740 lta
->notify_sock
= -1;
2742 /* Copy name and make sure it's NULL terminated. */
2743 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2744 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2747 * Before this can be called, when receiving the registration information,
2748 * the application compatibility is checked. So, at this point, the
2749 * application can work with this session daemon.
2751 lta
->compatible
= 1;
2753 lta
->pid
= msg
->pid
;
2754 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2756 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2758 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2765 * For a given application object, add it to every hash table.
2767 void ust_app_add(struct ust_app
*app
)
2770 assert(app
->notify_sock
>= 0);
2775 * On a re-registration, we want to kick out the previous registration of
2778 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2781 * The socket _should_ be unique until _we_ call close. So, a add_unique
2782 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2783 * already in the table.
2785 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2787 /* Add application to the notify socket hash table. */
2788 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2789 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2791 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2792 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2793 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2800 * Set the application version into the object.
2802 * Return 0 on success else a negative value either an errno code or a
2803 * LTTng-UST error code.
2805 int ust_app_version(struct ust_app
*app
)
2811 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2813 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2814 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2816 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2824 * Unregister app by removing it from the global traceable app list and freeing
2827 * The socket is already closed at this point so no close to sock.
2829 void ust_app_unregister(int sock
)
2831 struct ust_app
*lta
;
2832 struct lttng_ht_node_ulong
*node
;
2833 struct lttng_ht_iter iter
;
2834 struct ust_app_session
*ua_sess
;
2839 /* Get the node reference for a call_rcu */
2840 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2841 node
= lttng_ht_iter_get_node_ulong(&iter
);
2844 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2845 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2847 /* Remove application from PID hash table */
2848 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2852 * Remove application from notify hash table. The thread handling the
2853 * notify socket could have deleted the node so ignore on error because
2854 * either way it's valid. The close of that socket is handled by the other
2857 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2858 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2861 * Ignore return value since the node might have been removed before by an
2862 * add replace during app registration because the PID can be reassigned by
2865 iter
.iter
.node
= <a
->pid_n
.node
;
2866 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2868 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2872 /* Remove sessions so they are not visible during deletion.*/
2873 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2875 struct ust_registry_session
*registry
;
2877 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2879 /* The session was already removed so scheduled for teardown. */
2884 * Add session to list for teardown. This is safe since at this point we
2885 * are the only one using this list.
2887 pthread_mutex_lock(&ua_sess
->lock
);
2890 * Normally, this is done in the delete session process which is
2891 * executed in the call rcu below. However, upon registration we can't
2892 * afford to wait for the grace period before pushing data or else the
2893 * data pending feature can race between the unregistration and stop
2894 * command where the data pending command is sent *before* the grace
2897 * The close metadata below nullifies the metadata pointer in the
2898 * session so the delete session will NOT push/close a second time.
2900 registry
= get_session_registry(ua_sess
);
2901 if (registry
&& !registry
->metadata_closed
) {
2902 /* Push metadata for application before freeing the application. */
2903 (void) push_metadata(registry
, ua_sess
->consumer
);
2906 * Don't ask to close metadata for global per UID buffers. Close
2907 * metadata only on destroy trace session in this case. Also, the
2908 * previous push metadata could have flag the metadata registry to
2909 * close so don't send a close command if closed.
2911 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2912 !registry
->metadata_closed
) {
2913 /* And ask to close it for this session registry. */
2914 (void) close_metadata(registry
, ua_sess
->consumer
);
2918 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2919 pthread_mutex_unlock(&ua_sess
->lock
);
2923 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2930 * Return traceable_app_count
2932 unsigned long ust_app_list_count(void)
2934 unsigned long count
;
2937 count
= lttng_ht_get_count(ust_app_ht
);
2944 * Fill events array with all events name of all registered apps.
2946 int ust_app_list_events(struct lttng_event
**events
)
2949 size_t nbmem
, count
= 0;
2950 struct lttng_ht_iter iter
;
2951 struct ust_app
*app
;
2952 struct lttng_event
*tmp_event
;
2954 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2955 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
2956 if (tmp_event
== NULL
) {
2957 PERROR("zmalloc ust app events");
2964 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2965 struct lttng_ust_tracepoint_iter uiter
;
2967 health_code_update();
2969 if (!app
->compatible
) {
2971 * TODO: In time, we should notice the caller of this error by
2972 * telling him that this is a version error.
2976 handle
= ustctl_tracepoint_list(app
->sock
);
2978 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
2979 ERR("UST app list events getting handle failed for app pid %d",
2985 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
2986 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
2987 /* Handle ustctl error. */
2990 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
2991 ERR("UST app tp list get failed for app %d with ret %d",
2994 DBG3("UST app tp list get failed. Application is dead");
2999 health_code_update();
3000 if (count
>= nbmem
) {
3001 /* In case the realloc fails, we free the memory */
3004 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
3007 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
3009 PERROR("realloc ust app events");
3016 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3017 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3018 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3019 tmp_event
[count
].pid
= app
->pid
;
3020 tmp_event
[count
].enabled
= -1;
3026 *events
= tmp_event
;
3028 DBG2("UST app list events done (%zu events)", count
);
3033 health_code_update();
3038 * Fill events array with all events name of all registered apps.
3040 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3043 size_t nbmem
, count
= 0;
3044 struct lttng_ht_iter iter
;
3045 struct ust_app
*app
;
3046 struct lttng_event_field
*tmp_event
;
3048 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3049 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3050 if (tmp_event
== NULL
) {
3051 PERROR("zmalloc ust app event fields");
3058 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3059 struct lttng_ust_field_iter uiter
;
3061 health_code_update();
3063 if (!app
->compatible
) {
3065 * TODO: In time, we should notice the caller of this error by
3066 * telling him that this is a version error.
3070 handle
= ustctl_tracepoint_field_list(app
->sock
);
3072 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3073 ERR("UST app list field getting handle failed for app pid %d",
3079 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3080 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3081 /* Handle ustctl error. */
3084 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3085 ERR("UST app tp list field failed for app %d with ret %d",
3088 DBG3("UST app tp list field failed. Application is dead");
3093 health_code_update();
3094 if (count
>= nbmem
) {
3095 /* In case the realloc fails, we free the memory */
3098 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3101 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3103 PERROR("realloc ust app event fields");
3111 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3112 tmp_event
[count
].type
= uiter
.type
;
3113 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3115 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3116 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3117 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3118 tmp_event
[count
].event
.pid
= app
->pid
;
3119 tmp_event
[count
].event
.enabled
= -1;
3125 *fields
= tmp_event
;
3127 DBG2("UST app list event fields done (%zu events)", count
);
3132 health_code_update();
3137 * Free and clean all traceable apps of the global list.
3139 * Should _NOT_ be called with RCU read-side lock held.
3141 void ust_app_clean_list(void)
3144 struct ust_app
*app
;
3145 struct lttng_ht_iter iter
;
3147 DBG2("UST app cleaning registered apps hash table");
3151 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3152 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3154 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3157 /* Cleanup socket hash table */
3158 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3160 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3164 /* Cleanup notify socket hash table */
3165 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3166 notify_sock_n
.node
) {
3167 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3172 /* Destroy is done only when the ht is empty */
3173 ht_cleanup_push(ust_app_ht
);
3174 ht_cleanup_push(ust_app_ht_by_sock
);
3175 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3179 * Init UST app hash table.
3181 void ust_app_ht_alloc(void)
3183 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3184 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3185 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3189 * For a specific UST session, disable the channel for all registered apps.
3191 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3192 struct ltt_ust_channel
*uchan
)
3195 struct lttng_ht_iter iter
;
3196 struct lttng_ht_node_str
*ua_chan_node
;
3197 struct ust_app
*app
;
3198 struct ust_app_session
*ua_sess
;
3199 struct ust_app_channel
*ua_chan
;
3201 if (usess
== NULL
|| uchan
== NULL
) {
3202 ERR("Disabling UST global channel with NULL values");
3207 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3208 uchan
->name
, usess
->id
);
3212 /* For every registered applications */
3213 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3214 struct lttng_ht_iter uiter
;
3215 if (!app
->compatible
) {
3217 * TODO: In time, we should notice the caller of this error by
3218 * telling him that this is a version error.
3222 ua_sess
= lookup_session_by_app(usess
, app
);
3223 if (ua_sess
== NULL
) {
3228 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3229 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3230 /* If the session if found for the app, the channel must be there */
3231 assert(ua_chan_node
);
3233 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3234 /* The channel must not be already disabled */
3235 assert(ua_chan
->enabled
== 1);
3237 /* Disable channel onto application */
3238 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3240 /* XXX: We might want to report this error at some point... */
3252 * For a specific UST session, enable the channel for all registered apps.
3254 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3255 struct ltt_ust_channel
*uchan
)
3258 struct lttng_ht_iter iter
;
3259 struct ust_app
*app
;
3260 struct ust_app_session
*ua_sess
;
3262 if (usess
== NULL
|| uchan
== NULL
) {
3263 ERR("Adding UST global channel to NULL values");
3268 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3269 uchan
->name
, usess
->id
);
3273 /* For every registered applications */
3274 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3275 if (!app
->compatible
) {
3277 * TODO: In time, we should notice the caller of this error by
3278 * telling him that this is a version error.
3282 ua_sess
= lookup_session_by_app(usess
, app
);
3283 if (ua_sess
== NULL
) {
3287 /* Enable channel onto application */
3288 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3290 /* XXX: We might want to report this error at some point... */
3302 * Disable an event in a channel and for a specific session.
3304 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3305 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3308 struct lttng_ht_iter iter
, uiter
;
3309 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3310 struct ust_app
*app
;
3311 struct ust_app_session
*ua_sess
;
3312 struct ust_app_channel
*ua_chan
;
3313 struct ust_app_event
*ua_event
;
3315 DBG("UST app disabling event %s for all apps in channel "
3316 "%s for session id %" PRIu64
,
3317 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3321 /* For all registered applications */
3322 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3323 if (!app
->compatible
) {
3325 * TODO: In time, we should notice the caller of this error by
3326 * telling him that this is a version error.
3330 ua_sess
= lookup_session_by_app(usess
, app
);
3331 if (ua_sess
== NULL
) {
3336 /* Lookup channel in the ust app session */
3337 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3338 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3339 if (ua_chan_node
== NULL
) {
3340 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3341 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3344 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3346 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3347 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3348 if (ua_event_node
== NULL
) {
3349 DBG2("Event %s not found in channel %s for app pid %d."
3350 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3353 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3355 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3357 /* XXX: Report error someday... */
3368 * For a specific UST session and UST channel, the event for all
3371 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3372 struct ltt_ust_channel
*uchan
)
3375 struct lttng_ht_iter iter
, uiter
;
3376 struct lttng_ht_node_str
*ua_chan_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 all event for all apps in channel "
3383 "%s for session id %" PRIu64
, uchan
->name
, usess
->id
);
3387 /* For all registered applications */
3388 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3389 if (!app
->compatible
) {
3391 * TODO: In time, we should notice the caller of this error by
3392 * telling him that this is a version error.
3396 ua_sess
= lookup_session_by_app(usess
, app
);
3398 /* The application has problem or is probably dead. */
3402 /* Lookup channel in the ust app session */
3403 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3404 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3405 /* If the channel is not found, there is a code flow error */
3406 assert(ua_chan_node
);
3408 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3410 /* Disable each events of channel */
3411 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3413 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3415 /* XXX: Report error someday... */
3427 * For a specific UST session, create the channel for all registered apps.
3429 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3430 struct ltt_ust_channel
*uchan
)
3432 int ret
= 0, created
;
3433 struct lttng_ht_iter iter
;
3434 struct ust_app
*app
;
3435 struct ust_app_session
*ua_sess
= NULL
;
3437 /* Very wrong code flow */
3441 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3442 uchan
->name
, usess
->id
);
3446 /* For every registered applications */
3447 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3448 if (!app
->compatible
) {
3450 * TODO: In time, we should notice the caller of this error by
3451 * telling him that this is a version error.
3456 * Create session on the tracer side and add it to app session HT. Note
3457 * that if session exist, it will simply return a pointer to the ust
3460 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3465 * The application's socket is not valid. Either a bad socket
3466 * or a timeout on it. We can't inform the caller that for a
3467 * specific app, the session failed so lets continue here.
3472 goto error_rcu_unlock
;
3477 pthread_mutex_lock(&ua_sess
->lock
);
3478 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3479 sizeof(uchan
->name
))) {
3480 struct ustctl_consumer_channel_attr attr
;
3481 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3482 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3485 /* Create channel onto application. We don't need the chan ref. */
3486 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3487 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3489 pthread_mutex_unlock(&ua_sess
->lock
);
3491 if (ret
== -ENOMEM
) {
3492 /* No more memory is a fatal error. Stop right now. */
3493 goto error_rcu_unlock
;
3495 /* Cleanup the created session if it's the case. */
3497 destroy_app_session(app
, ua_sess
);
3508 * Enable event for a specific session and channel on the tracer.
3510 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3511 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3514 struct lttng_ht_iter iter
, uiter
;
3515 struct lttng_ht_node_str
*ua_chan_node
;
3516 struct ust_app
*app
;
3517 struct ust_app_session
*ua_sess
;
3518 struct ust_app_channel
*ua_chan
;
3519 struct ust_app_event
*ua_event
;
3521 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3522 uevent
->attr
.name
, usess
->id
);
3525 * NOTE: At this point, this function is called only if the session and
3526 * channel passed are already created for all apps. and enabled on the
3532 /* For all registered applications */
3533 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3534 if (!app
->compatible
) {
3536 * TODO: In time, we should notice the caller of this error by
3537 * telling him that this is a version error.
3541 ua_sess
= lookup_session_by_app(usess
, app
);
3543 /* The application has problem or is probably dead. */
3547 pthread_mutex_lock(&ua_sess
->lock
);
3549 /* Lookup channel in the ust app session */
3550 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3551 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3552 /* If the channel is not found, there is a code flow error */
3553 assert(ua_chan_node
);
3555 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3557 /* Get event node */
3558 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3559 uevent
->filter
, uevent
->attr
.loglevel
);
3560 if (ua_event
== NULL
) {
3561 DBG3("UST app enable event %s not found for app PID %d."
3562 "Skipping app", uevent
->attr
.name
, app
->pid
);
3566 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3568 pthread_mutex_unlock(&ua_sess
->lock
);
3572 pthread_mutex_unlock(&ua_sess
->lock
);
3581 * For a specific existing UST session and UST channel, creates the event for
3582 * all registered apps.
3584 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3585 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3588 struct lttng_ht_iter iter
, uiter
;
3589 struct lttng_ht_node_str
*ua_chan_node
;
3590 struct ust_app
*app
;
3591 struct ust_app_session
*ua_sess
;
3592 struct ust_app_channel
*ua_chan
;
3594 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3595 uevent
->attr
.name
, usess
->id
);
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
);
3615 /* Lookup channel in the ust app session */
3616 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3617 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3618 /* If the channel is not found, there is a code flow error */
3619 assert(ua_chan_node
);
3621 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3623 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3624 pthread_mutex_unlock(&ua_sess
->lock
);
3626 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3627 /* Possible value at this point: -ENOMEM. If so, we stop! */
3630 DBG2("UST app event %s already exist on app PID %d",
3631 uevent
->attr
.name
, app
->pid
);
3642 * Start tracing for a specific UST session and app.
3645 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3648 struct ust_app_session
*ua_sess
;
3650 DBG("Starting tracing for ust app pid %d", app
->pid
);
3654 if (!app
->compatible
) {
3658 ua_sess
= lookup_session_by_app(usess
, app
);
3659 if (ua_sess
== NULL
) {
3660 /* The session is in teardown process. Ignore and continue. */
3664 pthread_mutex_lock(&ua_sess
->lock
);
3666 /* Upon restart, we skip the setup, already done */
3667 if (ua_sess
->started
) {
3671 /* Create directories if consumer is LOCAL and has a path defined. */
3672 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3673 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3674 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3675 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3677 if (ret
!= -EEXIST
) {
3678 ERR("Trace directory creation error");
3685 * Create the metadata for the application. This returns gracefully if a
3686 * metadata was already set for the session.
3688 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3693 health_code_update();
3696 /* This start the UST tracing */
3697 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3699 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3700 ERR("Error starting tracing for app pid: %d (ret: %d)",
3703 DBG("UST app start session failed. Application is dead.");
3708 /* Indicate that the session has been started once */
3709 ua_sess
->started
= 1;
3711 pthread_mutex_unlock(&ua_sess
->lock
);
3713 health_code_update();
3715 /* Quiescent wait after starting trace */
3716 ret
= ustctl_wait_quiescent(app
->sock
);
3717 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3718 ERR("UST app wait quiescent failed for app pid %d ret %d",
3724 health_code_update();
3728 pthread_mutex_unlock(&ua_sess
->lock
);
3730 health_code_update();
3735 * Stop tracing for a specific UST session and app.
3738 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3741 struct ust_app_session
*ua_sess
;
3742 struct ust_registry_session
*registry
;
3744 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3748 if (!app
->compatible
) {
3749 goto end_no_session
;
3752 ua_sess
= lookup_session_by_app(usess
, app
);
3753 if (ua_sess
== NULL
) {
3754 goto end_no_session
;
3757 pthread_mutex_lock(&ua_sess
->lock
);
3760 * If started = 0, it means that stop trace has been called for a session
3761 * that was never started. It's possible since we can have a fail start
3762 * from either the application manager thread or the command thread. Simply
3763 * indicate that this is a stop error.
3765 if (!ua_sess
->started
) {
3766 goto error_rcu_unlock
;
3769 health_code_update();
3771 /* This inhibits UST tracing */
3772 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3774 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3775 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3778 DBG("UST app stop session failed. Application is dead.");
3780 goto error_rcu_unlock
;
3783 health_code_update();
3785 /* Quiescent wait after stopping trace */
3786 ret
= ustctl_wait_quiescent(app
->sock
);
3787 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3788 ERR("UST app wait quiescent failed for app pid %d ret %d",
3792 health_code_update();
3794 registry
= get_session_registry(ua_sess
);
3797 if (!registry
->metadata_closed
) {
3798 /* Push metadata for application before freeing the application. */
3799 (void) push_metadata(registry
, ua_sess
->consumer
);
3802 pthread_mutex_unlock(&ua_sess
->lock
);
3805 health_code_update();
3809 pthread_mutex_unlock(&ua_sess
->lock
);
3811 health_code_update();
3816 * Flush buffers for a specific UST session and app.
3819 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3822 struct lttng_ht_iter iter
;
3823 struct ust_app_session
*ua_sess
;
3824 struct ust_app_channel
*ua_chan
;
3826 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3830 if (!app
->compatible
) {
3831 goto end_no_session
;
3834 ua_sess
= lookup_session_by_app(usess
, app
);
3835 if (ua_sess
== NULL
) {
3836 goto end_no_session
;
3839 pthread_mutex_lock(&ua_sess
->lock
);
3841 health_code_update();
3843 /* Flushing buffers */
3844 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3846 health_code_update();
3847 assert(ua_chan
->is_sent
);
3848 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3850 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3851 ERR("UST app PID %d channel %s flush failed with ret %d",
3852 app
->pid
, ua_chan
->name
, ret
);
3854 DBG3("UST app failed to flush %s. Application is dead.",
3856 /* No need to continue. */
3859 /* Continuing flushing all buffers */
3864 health_code_update();
3866 pthread_mutex_unlock(&ua_sess
->lock
);
3869 health_code_update();
3874 * Destroy a specific UST session in apps.
3876 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3879 struct ust_app_session
*ua_sess
;
3880 struct lttng_ht_iter iter
;
3881 struct lttng_ht_node_u64
*node
;
3883 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3887 if (!app
->compatible
) {
3891 __lookup_session_by_app(usess
, app
, &iter
);
3892 node
= lttng_ht_iter_get_node_u64(&iter
);
3894 /* Session is being or is deleted. */
3897 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3899 health_code_update();
3900 destroy_app_session(app
, ua_sess
);
3902 health_code_update();
3904 /* Quiescent wait after stopping trace */
3905 ret
= ustctl_wait_quiescent(app
->sock
);
3906 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3907 ERR("UST app wait quiescent failed for app pid %d ret %d",
3912 health_code_update();
3917 * Start tracing for the UST session.
3919 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
3922 struct lttng_ht_iter iter
;
3923 struct ust_app
*app
;
3925 DBG("Starting all UST traces");
3929 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3930 ret
= ust_app_start_trace(usess
, app
);
3932 /* Continue to next apps even on error */
3943 * Start tracing for the UST session.
3945 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
3948 struct lttng_ht_iter iter
;
3949 struct ust_app
*app
;
3951 DBG("Stopping all UST traces");
3955 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3956 ret
= ust_app_stop_trace(usess
, app
);
3958 /* Continue to next apps even on error */
3963 /* Flush buffers and push metadata (for UID buffers). */
3964 switch (usess
->buffer_type
) {
3965 case LTTNG_BUFFER_PER_UID
:
3967 struct buffer_reg_uid
*reg
;
3969 /* Flush all per UID buffers associated to that session. */
3970 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3971 struct ust_registry_session
*ust_session_reg
;
3972 struct buffer_reg_channel
*reg_chan
;
3973 struct consumer_socket
*socket
;
3975 /* Get consumer socket to use to push the metadata.*/
3976 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
3979 /* Ignore request if no consumer is found for the session. */
3983 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
3984 reg_chan
, node
.node
) {
3986 * The following call will print error values so the return
3987 * code is of little importance because whatever happens, we
3988 * have to try them all.
3990 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
3993 ust_session_reg
= reg
->registry
->reg
.ust
;
3994 if (!ust_session_reg
->metadata_closed
) {
3995 /* Push metadata. */
3996 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4002 case LTTNG_BUFFER_PER_PID
:
4003 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4004 ret
= ust_app_flush_trace(usess
, app
);
4006 /* Continue to next apps even on error */
4022 * Destroy app UST session.
4024 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4027 struct lttng_ht_iter iter
;
4028 struct ust_app
*app
;
4030 DBG("Destroy all UST traces");
4034 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4035 ret
= destroy_trace(usess
, app
);
4037 /* Continue to next apps even on error */
4048 * Add channels/events from UST global domain to registered apps at sock.
4050 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4053 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
4054 struct ust_app
*app
;
4055 struct ust_app_session
*ua_sess
= NULL
;
4056 struct ust_app_channel
*ua_chan
;
4057 struct ust_app_event
*ua_event
;
4058 struct ust_app_ctx
*ua_ctx
;
4063 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4068 app
= find_app_by_sock(sock
);
4071 * Application can be unregistered before so this is possible hence
4072 * simply stopping the update.
4074 DBG3("UST app update failed to find app sock %d", sock
);
4078 if (!app
->compatible
) {
4082 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4084 /* Tracer is probably gone or ENOMEM. */
4089 pthread_mutex_lock(&ua_sess
->lock
);
4092 * We can iterate safely here over all UST app session since the create ust
4093 * app session above made a shadow copy of the UST global domain from the
4096 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4099 * For a metadata channel, handle it differently.
4101 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4102 sizeof(ua_chan
->name
))) {
4103 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4108 /* Remove it from the hash table and continue!. */
4109 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4111 delete_ust_app_channel(-1, ua_chan
, app
);
4114 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4117 * Stop everything. On error, the application failed, no more
4118 * file descriptor are available or ENOMEM so stopping here is
4119 * the only thing we can do for now.
4125 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
4127 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4134 /* For each events */
4135 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4137 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4144 pthread_mutex_unlock(&ua_sess
->lock
);
4146 if (usess
->start_trace
) {
4147 ret
= ust_app_start_trace(usess
, app
);
4152 DBG2("UST trace started for app pid %d", app
->pid
);
4155 /* Everything went well at this point. */
4160 pthread_mutex_unlock(&ua_sess
->lock
);
4163 destroy_app_session(app
, ua_sess
);
4170 * Add context to a specific channel for global UST domain.
4172 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4173 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4176 struct lttng_ht_node_str
*ua_chan_node
;
4177 struct lttng_ht_iter iter
, uiter
;
4178 struct ust_app_channel
*ua_chan
= NULL
;
4179 struct ust_app_session
*ua_sess
;
4180 struct ust_app
*app
;
4184 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4185 if (!app
->compatible
) {
4187 * TODO: In time, we should notice the caller of this error by
4188 * telling him that this is a version error.
4192 ua_sess
= lookup_session_by_app(usess
, app
);
4193 if (ua_sess
== NULL
) {
4197 pthread_mutex_lock(&ua_sess
->lock
);
4198 /* Lookup channel in the ust app session */
4199 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4200 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4201 if (ua_chan_node
== NULL
) {
4204 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4206 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4211 pthread_mutex_unlock(&ua_sess
->lock
);
4219 * Enable event for a channel from a UST session for a specific PID.
4221 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4222 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4225 struct lttng_ht_iter iter
;
4226 struct lttng_ht_node_str
*ua_chan_node
;
4227 struct ust_app
*app
;
4228 struct ust_app_session
*ua_sess
;
4229 struct ust_app_channel
*ua_chan
;
4230 struct ust_app_event
*ua_event
;
4232 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4236 app
= ust_app_find_by_pid(pid
);
4238 ERR("UST app enable event per PID %d not found", pid
);
4243 if (!app
->compatible
) {
4248 ua_sess
= lookup_session_by_app(usess
, app
);
4250 /* The application has problem or is probably dead. */
4255 pthread_mutex_lock(&ua_sess
->lock
);
4256 /* Lookup channel in the ust app session */
4257 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4258 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4259 /* If the channel is not found, there is a code flow error */
4260 assert(ua_chan_node
);
4262 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4264 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4265 uevent
->filter
, uevent
->attr
.loglevel
);
4266 if (ua_event
== NULL
) {
4267 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4272 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4279 pthread_mutex_unlock(&ua_sess
->lock
);
4286 * Disable event for a channel from a UST session for a specific PID.
4288 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4289 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4292 struct lttng_ht_iter iter
;
4293 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4294 struct ust_app
*app
;
4295 struct ust_app_session
*ua_sess
;
4296 struct ust_app_channel
*ua_chan
;
4297 struct ust_app_event
*ua_event
;
4299 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4303 app
= ust_app_find_by_pid(pid
);
4305 ERR("UST app disable event per PID %d not found", pid
);
4310 if (!app
->compatible
) {
4315 ua_sess
= lookup_session_by_app(usess
, app
);
4317 /* The application has problem or is probably dead. */
4321 /* Lookup channel in the ust app session */
4322 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4323 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4324 if (ua_chan_node
== NULL
) {
4325 /* Channel does not exist, skip disabling */
4328 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4330 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4331 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4332 if (ua_event_node
== NULL
) {
4333 /* Event does not exist, skip disabling */
4336 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4338 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4349 * Calibrate registered applications.
4351 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4354 struct lttng_ht_iter iter
;
4355 struct ust_app
*app
;
4359 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4360 if (!app
->compatible
) {
4362 * TODO: In time, we should notice the caller of this error by
4363 * telling him that this is a version error.
4368 health_code_update();
4370 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4374 /* Means that it's not implemented on the tracer side. */
4378 DBG2("Calibrate app PID %d returned with error %d",
4385 DBG("UST app global domain calibration finished");
4389 health_code_update();
4395 * Receive registration and populate the given msg structure.
4397 * On success return 0 else a negative value returned by the ustctl call.
4399 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4402 uint32_t pid
, ppid
, uid
, gid
;
4406 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4407 &pid
, &ppid
, &uid
, &gid
,
4408 &msg
->bits_per_long
,
4409 &msg
->uint8_t_alignment
,
4410 &msg
->uint16_t_alignment
,
4411 &msg
->uint32_t_alignment
,
4412 &msg
->uint64_t_alignment
,
4413 &msg
->long_alignment
,
4420 case LTTNG_UST_ERR_EXITING
:
4421 DBG3("UST app recv reg message failed. Application died");
4423 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4424 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4425 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4426 LTTNG_UST_ABI_MINOR_VERSION
);
4429 ERR("UST app recv reg message failed with ret %d", ret
);
4434 msg
->pid
= (pid_t
) pid
;
4435 msg
->ppid
= (pid_t
) ppid
;
4436 msg
->uid
= (uid_t
) uid
;
4437 msg
->gid
= (gid_t
) gid
;
4444 * Return a ust app channel object using the application object and the channel
4445 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4446 * lock MUST be acquired before calling this function.
4448 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4451 struct lttng_ht_node_ulong
*node
;
4452 struct lttng_ht_iter iter
;
4453 struct ust_app_channel
*ua_chan
= NULL
;
4457 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4458 node
= lttng_ht_iter_get_node_ulong(&iter
);
4460 DBG2("UST app channel find by objd %d not found", objd
);
4464 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4471 * Reply to a register channel notification from an application on the notify
4472 * socket. The channel metadata is also created.
4474 * The session UST registry lock is acquired in this function.
4476 * On success 0 is returned else a negative value.
4478 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4479 size_t nr_fields
, struct ustctl_field
*fields
)
4481 int ret
, ret_code
= 0;
4482 uint32_t chan_id
, reg_count
;
4483 uint64_t chan_reg_key
;
4484 enum ustctl_channel_header type
;
4485 struct ust_app
*app
;
4486 struct ust_app_channel
*ua_chan
;
4487 struct ust_app_session
*ua_sess
;
4488 struct ust_registry_session
*registry
;
4489 struct ust_registry_channel
*chan_reg
;
4493 /* Lookup application. If not found, there is a code flow error. */
4494 app
= find_app_by_notify_sock(sock
);
4496 DBG("Application socket %d is being teardown. Abort event notify",
4500 goto error_rcu_unlock
;
4503 /* Lookup channel by UST object descriptor. */
4504 ua_chan
= find_channel_by_objd(app
, cobjd
);
4506 DBG("Application channel is being teardown. Abort event notify");
4509 goto error_rcu_unlock
;
4512 assert(ua_chan
->session
);
4513 ua_sess
= ua_chan
->session
;
4515 /* Get right session registry depending on the session buffer type. */
4516 registry
= get_session_registry(ua_sess
);
4519 /* Depending on the buffer type, a different channel key is used. */
4520 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4521 chan_reg_key
= ua_chan
->tracing_channel_id
;
4523 chan_reg_key
= ua_chan
->key
;
4526 pthread_mutex_lock(®istry
->lock
);
4528 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4531 if (!chan_reg
->register_done
) {
4532 reg_count
= ust_registry_get_event_count(chan_reg
);
4533 if (reg_count
< 31) {
4534 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4536 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4539 chan_reg
->nr_ctx_fields
= nr_fields
;
4540 chan_reg
->ctx_fields
= fields
;
4541 chan_reg
->header_type
= type
;
4543 /* Get current already assigned values. */
4544 type
= chan_reg
->header_type
;
4546 /* Set to NULL so the error path does not do a double free. */
4549 /* Channel id is set during the object creation. */
4550 chan_id
= chan_reg
->chan_id
;
4552 /* Append to metadata */
4553 if (!chan_reg
->metadata_dumped
) {
4554 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4556 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4562 DBG3("UST app replying to register channel key %" PRIu64
4563 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4566 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4568 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4569 ERR("UST app reply channel failed with ret %d", ret
);
4571 DBG3("UST app reply channel failed. Application died");
4576 /* This channel registry registration is completed. */
4577 chan_reg
->register_done
= 1;
4580 pthread_mutex_unlock(®istry
->lock
);
4590 * Add event to the UST channel registry. When the event is added to the
4591 * registry, the metadata is also created. Once done, this replies to the
4592 * application with the appropriate error code.
4594 * The session UST registry lock is acquired in the function.
4596 * On success 0 is returned else a negative value.
4598 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4599 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4600 char *model_emf_uri
)
4603 uint32_t event_id
= 0;
4604 uint64_t chan_reg_key
;
4605 struct ust_app
*app
;
4606 struct ust_app_channel
*ua_chan
;
4607 struct ust_app_session
*ua_sess
;
4608 struct ust_registry_session
*registry
;
4612 /* Lookup application. If not found, there is a code flow error. */
4613 app
= find_app_by_notify_sock(sock
);
4615 DBG("Application socket %d is being teardown. Abort event notify",
4620 free(model_emf_uri
);
4621 goto error_rcu_unlock
;
4624 /* Lookup channel by UST object descriptor. */
4625 ua_chan
= find_channel_by_objd(app
, cobjd
);
4627 DBG("Application channel is being teardown. Abort event notify");
4631 free(model_emf_uri
);
4632 goto error_rcu_unlock
;
4635 assert(ua_chan
->session
);
4636 ua_sess
= ua_chan
->session
;
4638 registry
= get_session_registry(ua_sess
);
4641 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4642 chan_reg_key
= ua_chan
->tracing_channel_id
;
4644 chan_reg_key
= ua_chan
->key
;
4647 pthread_mutex_lock(®istry
->lock
);
4650 * From this point on, this call acquires the ownership of the sig, fields
4651 * and model_emf_uri meaning any free are done inside it if needed. These
4652 * three variables MUST NOT be read/write after this.
4654 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4655 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4656 model_emf_uri
, ua_sess
->buffer_type
, &event_id
);
4659 * The return value is returned to ustctl so in case of an error, the
4660 * application can be notified. In case of an error, it's important not to
4661 * return a negative error or else the application will get closed.
4663 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4665 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4666 ERR("UST app reply event failed with ret %d", ret
);
4668 DBG3("UST app reply event failed. Application died");
4671 * No need to wipe the create event since the application socket will
4672 * get close on error hence cleaning up everything by itself.
4677 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4681 pthread_mutex_unlock(®istry
->lock
);
4688 * Handle application notification through the given notify socket.
4690 * Return 0 on success or else a negative value.
4692 int ust_app_recv_notify(int sock
)
4695 enum ustctl_notify_cmd cmd
;
4697 DBG3("UST app receiving notify from sock %d", sock
);
4699 ret
= ustctl_recv_notify(sock
, &cmd
);
4701 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4702 ERR("UST app recv notify failed with ret %d", ret
);
4704 DBG3("UST app recv notify failed. Application died");
4710 case USTCTL_NOTIFY_CMD_EVENT
:
4712 int sobjd
, cobjd
, loglevel
;
4713 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4715 struct ustctl_field
*fields
;
4717 DBG2("UST app ustctl register event received");
4719 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4720 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4722 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4723 ERR("UST app recv event failed with ret %d", ret
);
4725 DBG3("UST app recv event failed. Application died");
4731 * Add event to the UST registry coming from the notify socket. This
4732 * call will free if needed the sig, fields and model_emf_uri. This
4733 * code path loses the ownsership of these variables and transfer them
4734 * to the this function.
4736 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4737 fields
, loglevel
, model_emf_uri
);
4744 case USTCTL_NOTIFY_CMD_CHANNEL
:
4748 struct ustctl_field
*fields
;
4750 DBG2("UST app ustctl register channel received");
4752 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4755 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4756 ERR("UST app recv channel failed with ret %d", ret
);
4758 DBG3("UST app recv channel failed. Application died");
4764 * The fields ownership are transfered to this function call meaning
4765 * that if needed it will be freed. After this, it's invalid to access
4766 * fields or clean it up.
4768 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4777 /* Should NEVER happen. */
4786 * Once the notify socket hangs up, this is called. First, it tries to find the
4787 * corresponding application. On failure, the call_rcu to close the socket is
4788 * executed. If an application is found, it tries to delete it from the notify
4789 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4791 * Note that an object needs to be allocated here so on ENOMEM failure, the
4792 * call RCU is not done but the rest of the cleanup is.
4794 void ust_app_notify_sock_unregister(int sock
)
4797 struct lttng_ht_iter iter
;
4798 struct ust_app
*app
;
4799 struct ust_app_notify_sock_obj
*obj
;
4805 obj
= zmalloc(sizeof(*obj
));
4808 * An ENOMEM is kind of uncool. If this strikes we continue the
4809 * procedure but the call_rcu will not be called. In this case, we
4810 * accept the fd leak rather than possibly creating an unsynchronized
4811 * state between threads.
4813 * TODO: The notify object should be created once the notify socket is
4814 * registered and stored independantely from the ust app object. The
4815 * tricky part is to synchronize the teardown of the application and
4816 * this notify object. Let's keep that in mind so we can avoid this
4817 * kind of shenanigans with ENOMEM in the teardown path.
4824 DBG("UST app notify socket unregister %d", sock
);
4827 * Lookup application by notify socket. If this fails, this means that the
4828 * hash table delete has already been done by the application
4829 * unregistration process so we can safely close the notify socket in a
4832 app
= find_app_by_notify_sock(sock
);
4837 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4840 * Whatever happens here either we fail or succeed, in both cases we have
4841 * to close the socket after a grace period to continue to the call RCU
4842 * here. If the deletion is successful, the application is not visible
4843 * anymore by other threads and is it fails it means that it was already
4844 * deleted from the hash table so either way we just have to close the
4847 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4853 * Close socket after a grace period to avoid for the socket to be reused
4854 * before the application object is freed creating potential race between
4855 * threads trying to add unique in the global hash table.
4858 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4863 * Destroy a ust app data structure and free its memory.
4865 void ust_app_destroy(struct ust_app
*app
)
4871 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);