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"
42 /* Next available channel key. */
43 static unsigned long next_channel_key
;
44 static unsigned long next_session_id
;
47 * Return the atomically incremented value of next_channel_key.
49 static inline unsigned long get_next_channel_key(void)
51 return uatomic_add_return(&next_channel_key
, 1);
55 * Return the atomically incremented value of next_session_id.
57 static inline unsigned long get_next_session_id(void)
59 return uatomic_add_return(&next_session_id
, 1);
62 static void copy_channel_attr_to_ustctl(
63 struct ustctl_consumer_channel_attr
*attr
,
64 struct lttng_ust_channel_attr
*uattr
)
66 /* Copy event attributes since the layout is different. */
67 attr
->subbuf_size
= uattr
->subbuf_size
;
68 attr
->num_subbuf
= uattr
->num_subbuf
;
69 attr
->overwrite
= uattr
->overwrite
;
70 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
71 attr
->read_timer_interval
= uattr
->read_timer_interval
;
72 attr
->output
= uattr
->output
;
76 * Match function for the hash table lookup.
78 * It matches an ust app event based on three attributes which are the event
79 * name, the filter bytecode and the loglevel.
81 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
83 struct ust_app_event
*event
;
84 const struct ust_app_ht_key
*key
;
89 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
92 /* Match the 3 elements of the key: name, filter and loglevel. */
95 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
100 if (event
->attr
.loglevel
!= key
->loglevel
) {
101 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
102 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
104 * Match is accepted. This is because on event creation, the
105 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
106 * -1 are accepted for this loglevel type since 0 is the one set by
107 * the API when receiving an enable event.
114 /* One of the filters is NULL, fail. */
115 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
119 if (key
->filter
&& event
->filter
) {
120 /* Both filters exists, check length followed by the bytecode. */
121 if (event
->filter
->len
!= key
->filter
->len
||
122 memcmp(event
->filter
->data
, key
->filter
->data
,
123 event
->filter
->len
) != 0) {
136 * Unique add of an ust app event in the given ht. This uses the custom
137 * ht_match_ust_app_event match function and the event name as hash.
139 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
140 struct ust_app_event
*event
)
142 struct cds_lfht_node
*node_ptr
;
143 struct ust_app_ht_key key
;
147 assert(ua_chan
->events
);
150 ht
= ua_chan
->events
;
151 key
.name
= event
->attr
.name
;
152 key
.filter
= event
->filter
;
153 key
.loglevel
= event
->attr
.loglevel
;
155 node_ptr
= cds_lfht_add_unique(ht
->ht
,
156 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
157 ht_match_ust_app_event
, &key
, &event
->node
.node
);
158 assert(node_ptr
== &event
->node
.node
);
162 * Close the notify socket from the given RCU head object. This MUST be called
163 * through a call_rcu().
165 static void close_notify_sock_rcu(struct rcu_head
*head
)
168 struct ust_app_notify_sock_obj
*obj
=
169 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
171 /* Must have a valid fd here. */
172 assert(obj
->fd
>= 0);
174 ret
= close(obj
->fd
);
176 ERR("close notify sock %d RCU", obj
->fd
);
178 lttng_fd_put(LTTNG_FD_APPS
, 1);
184 * Return the session registry according to the buffer type of the given
187 * A registry per UID object MUST exists before calling this function or else
188 * it assert() if not found. RCU read side lock must be acquired.
190 static struct ust_registry_session
*get_session_registry(
191 struct ust_app_session
*ua_sess
)
193 struct ust_registry_session
*registry
= NULL
;
197 switch (ua_sess
->buffer_type
) {
198 case LTTNG_BUFFER_PER_PID
:
200 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
204 registry
= reg_pid
->registry
->reg
.ust
;
207 case LTTNG_BUFFER_PER_UID
:
209 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
210 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
214 registry
= reg_uid
->registry
->reg
.ust
;
226 * Delete ust context safely. RCU read lock must be held before calling
230 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
237 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
238 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
239 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
240 sock
, ua_ctx
->obj
->handle
, ret
);
248 * Delete ust app event safely. RCU read lock must be held before calling
252 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
258 free(ua_event
->filter
);
260 if (ua_event
->obj
!= NULL
) {
261 ret
= ustctl_release_object(sock
, ua_event
->obj
);
262 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
263 ERR("UST app sock %d release event obj failed with ret %d",
272 * Release ust data object of the given stream.
274 * Return 0 on success or else a negative value.
276 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
283 ret
= ustctl_release_object(sock
, stream
->obj
);
284 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
285 ERR("UST app sock %d release stream obj failed with ret %d",
288 lttng_fd_put(LTTNG_FD_APPS
, 2);
296 * Delete ust app stream safely. RCU read lock must be held before calling
300 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
304 (void) release_ust_app_stream(sock
, stream
);
309 * We need to execute ht_destroy outside of RCU read-side critical
310 * section, so we postpone its execution using call_rcu. It is simpler
311 * than to change the semantic of the many callers of
312 * delete_ust_app_channel().
315 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
317 struct ust_app_channel
*ua_chan
=
318 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
320 lttng_ht_destroy(ua_chan
->ctx
);
321 lttng_ht_destroy(ua_chan
->events
);
326 * Delete ust app channel safely. RCU read lock must be held before calling
330 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
334 struct lttng_ht_iter iter
;
335 struct ust_app_event
*ua_event
;
336 struct ust_app_ctx
*ua_ctx
;
337 struct ust_app_stream
*stream
, *stmp
;
338 struct ust_registry_session
*registry
;
342 DBG3("UST app deleting channel %s", ua_chan
->name
);
345 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
346 cds_list_del(&stream
->list
);
347 delete_ust_app_stream(sock
, stream
);
351 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
352 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
354 delete_ust_app_ctx(sock
, ua_ctx
);
358 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
360 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
362 delete_ust_app_event(sock
, ua_event
);
365 /* Wipe and free registry from session registry. */
366 registry
= get_session_registry(ua_chan
->session
);
368 ust_registry_channel_del_free(registry
, ua_chan
->key
);
371 if (ua_chan
->obj
!= NULL
) {
372 /* Remove channel from application UST object descriptor. */
373 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
374 lttng_ht_del(app
->ust_objd
, &iter
);
375 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
376 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
377 ERR("UST app sock %d release channel obj failed with ret %d",
380 lttng_fd_put(LTTNG_FD_APPS
, 1);
383 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
387 * Push metadata to consumer socket.
389 * The socket lock MUST be acquired.
390 * The ust app session lock MUST be acquired.
392 * On success, return the len of metadata pushed or else a negative value.
394 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
395 struct consumer_socket
*socket
, int send_zero_data
)
398 char *metadata_str
= NULL
;
406 * On a push metadata error either the consumer is dead or the metadata
407 * channel has been destroyed because its endpoint might have died (e.g:
408 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
409 * metadata again which is not valid anymore on the consumer side.
411 * The ust app session mutex locked allows us to make this check without
414 if (registry
->metadata_closed
) {
418 pthread_mutex_lock(®istry
->lock
);
420 offset
= registry
->metadata_len_sent
;
421 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
423 DBG3("No metadata to push for metadata key %" PRIu64
,
424 registry
->metadata_key
);
426 if (send_zero_data
) {
427 DBG("No metadata to push");
433 /* Allocate only what we have to send. */
434 metadata_str
= zmalloc(len
);
436 PERROR("zmalloc ust app metadata string");
440 /* Copy what we haven't send out. */
441 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
442 registry
->metadata_len_sent
+= len
;
445 pthread_mutex_unlock(®istry
->lock
);
446 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
447 metadata_str
, len
, offset
);
458 pthread_mutex_unlock(®istry
->lock
);
465 * For a given application and session, push metadata to consumer. The session
466 * lock MUST be acquired here before calling this.
467 * Either sock or consumer is required : if sock is NULL, the default
468 * socket to send the metadata is retrieved from consumer, if sock
469 * is not NULL we use it to send the metadata.
471 * Return 0 on success else a negative error.
473 static int push_metadata(struct ust_registry_session
*registry
,
474 struct consumer_output
*consumer
)
478 struct consumer_socket
*socket
;
486 * Means that no metadata was assigned to the session. This can happens if
487 * no start has been done previously.
489 if (!registry
->metadata_key
) {
494 /* Get consumer socket to use to push the metadata.*/
495 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
499 goto error_rcu_unlock
;
503 * TODO: Currently, we hold the socket lock around sampling of the next
504 * metadata segment to ensure we send metadata over the consumer socket in
505 * the correct order. This makes the registry lock nest inside the socket
508 * Please note that this is a temporary measure: we should move this lock
509 * back into ust_consumer_push_metadata() when the consumer gets the
510 * ability to reorder the metadata it receives.
512 pthread_mutex_lock(socket
->lock
);
513 ret
= ust_app_push_metadata(registry
, socket
, 0);
514 pthread_mutex_unlock(socket
->lock
);
517 goto error_rcu_unlock
;
525 * On error, flag the registry that the metadata is closed. We were unable
526 * to push anything and this means that either the consumer is not
527 * responding or the metadata cache has been destroyed on the consumer.
529 registry
->metadata_closed
= 1;
536 * Send to the consumer a close metadata command for the given session. Once
537 * done, the metadata channel is deleted and the session metadata pointer is
538 * nullified. The session lock MUST be acquired here unless the application is
539 * in the destroy path.
541 * Return 0 on success else a negative value.
543 static int close_metadata(struct ust_registry_session
*registry
,
544 struct consumer_output
*consumer
)
547 struct consumer_socket
*socket
;
554 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
559 /* Get consumer socket to use to push the metadata.*/
560 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
567 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
574 * Metadata closed. Even on error this means that the consumer is not
575 * responding or not found so either way a second close should NOT be emit
578 registry
->metadata_closed
= 1;
585 * We need to execute ht_destroy outside of RCU read-side critical
586 * section, so we postpone its execution using call_rcu. It is simpler
587 * than to change the semantic of the many callers of
588 * delete_ust_app_session().
591 void delete_ust_app_session_rcu(struct rcu_head
*head
)
593 struct ust_app_session
*ua_sess
=
594 caa_container_of(head
, struct ust_app_session
, rcu_head
);
596 lttng_ht_destroy(ua_sess
->channels
);
601 * Delete ust app session safely. RCU read lock must be held before calling
605 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
609 struct lttng_ht_iter iter
;
610 struct ust_app_channel
*ua_chan
;
611 struct ust_registry_session
*registry
;
615 pthread_mutex_lock(&ua_sess
->lock
);
617 registry
= get_session_registry(ua_sess
);
618 if (registry
&& !registry
->metadata_closed
) {
619 /* Push metadata for application before freeing the application. */
620 (void) push_metadata(registry
, ua_sess
->consumer
);
623 * Don't ask to close metadata for global per UID buffers. Close
624 * metadata only on destroy trace session in this case. Also, the
625 * previous push metadata could have flag the metadata registry to
626 * close so don't send a close command if closed.
628 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
629 !registry
->metadata_closed
) {
630 /* And ask to close it for this session registry. */
631 (void) close_metadata(registry
, ua_sess
->consumer
);
635 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
637 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
639 delete_ust_app_channel(sock
, ua_chan
, app
);
642 /* In case of per PID, the registry is kept in the session. */
643 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
644 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
646 buffer_reg_pid_remove(reg_pid
);
647 buffer_reg_pid_destroy(reg_pid
);
651 if (ua_sess
->handle
!= -1) {
652 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
653 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
654 ERR("UST app sock %d release session handle failed with ret %d",
658 pthread_mutex_unlock(&ua_sess
->lock
);
660 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
664 * Delete a traceable application structure from the global list. Never call
665 * this function outside of a call_rcu call.
667 * RCU read side lock should _NOT_ be held when calling this function.
670 void delete_ust_app(struct ust_app
*app
)
673 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
675 /* Delete ust app sessions info */
680 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
682 /* Free every object in the session and the session. */
684 delete_ust_app_session(sock
, ua_sess
, app
);
688 lttng_ht_destroy(app
->sessions
);
689 lttng_ht_destroy(app
->ust_objd
);
692 * Wait until we have deleted the application from the sock hash table
693 * before closing this socket, otherwise an application could re-use the
694 * socket ID and race with the teardown, using the same hash table entry.
696 * It's OK to leave the close in call_rcu. We want it to stay unique for
697 * all RCU readers that could run concurrently with unregister app,
698 * therefore we _need_ to only close that socket after a grace period. So
699 * it should stay in this RCU callback.
701 * This close() is a very important step of the synchronization model so
702 * every modification to this function must be carefully reviewed.
708 lttng_fd_put(LTTNG_FD_APPS
, 1);
710 DBG2("UST app pid %d deleted", app
->pid
);
715 * URCU intermediate call to delete an UST app.
718 void delete_ust_app_rcu(struct rcu_head
*head
)
720 struct lttng_ht_node_ulong
*node
=
721 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
722 struct ust_app
*app
=
723 caa_container_of(node
, struct ust_app
, pid_n
);
725 DBG3("Call RCU deleting app PID %d", app
->pid
);
730 * Delete the session from the application ht and delete the data structure by
731 * freeing every object inside and releasing them.
733 static void destroy_app_session(struct ust_app
*app
,
734 struct ust_app_session
*ua_sess
)
737 struct lttng_ht_iter iter
;
742 iter
.iter
.node
= &ua_sess
->node
.node
;
743 ret
= lttng_ht_del(app
->sessions
, &iter
);
745 /* Already scheduled for teardown. */
749 /* Once deleted, free the data structure. */
750 delete_ust_app_session(app
->sock
, ua_sess
, app
);
757 * Alloc new UST app session.
760 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
762 struct ust_app_session
*ua_sess
;
764 /* Init most of the default value by allocating and zeroing */
765 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
766 if (ua_sess
== NULL
) {
771 ua_sess
->handle
= -1;
772 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
773 pthread_mutex_init(&ua_sess
->lock
, NULL
);
782 * Alloc new UST app channel.
785 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
786 struct ust_app_session
*ua_sess
,
787 struct lttng_ust_channel_attr
*attr
)
789 struct ust_app_channel
*ua_chan
;
791 /* Init most of the default value by allocating and zeroing */
792 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
793 if (ua_chan
== NULL
) {
798 /* Setup channel name */
799 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
800 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
802 ua_chan
->enabled
= 1;
803 ua_chan
->handle
= -1;
804 ua_chan
->session
= ua_sess
;
805 ua_chan
->key
= get_next_channel_key();
806 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
807 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
808 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
810 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
812 /* Copy attributes */
814 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
815 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
816 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
817 ua_chan
->attr
.overwrite
= attr
->overwrite
;
818 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
819 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
820 ua_chan
->attr
.output
= attr
->output
;
822 /* By default, the channel is a per cpu channel. */
823 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
825 DBG3("UST app channel %s allocated", ua_chan
->name
);
834 * Allocate and initialize a UST app stream.
836 * Return newly allocated stream pointer or NULL on error.
838 struct ust_app_stream
*ust_app_alloc_stream(void)
840 struct ust_app_stream
*stream
= NULL
;
842 stream
= zmalloc(sizeof(*stream
));
843 if (stream
== NULL
) {
844 PERROR("zmalloc ust app stream");
848 /* Zero could be a valid value for a handle so flag it to -1. */
856 * Alloc new UST app event.
859 struct ust_app_event
*alloc_ust_app_event(char *name
,
860 struct lttng_ust_event
*attr
)
862 struct ust_app_event
*ua_event
;
864 /* Init most of the default value by allocating and zeroing */
865 ua_event
= zmalloc(sizeof(struct ust_app_event
));
866 if (ua_event
== NULL
) {
871 ua_event
->enabled
= 1;
872 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
873 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
874 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
876 /* Copy attributes */
878 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
881 DBG3("UST app event %s allocated", ua_event
->name
);
890 * Alloc new UST app context.
893 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
895 struct ust_app_ctx
*ua_ctx
;
897 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
898 if (ua_ctx
== NULL
) {
903 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
906 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
913 * Allocate a filter and copy the given original filter.
915 * Return allocated filter or NULL on error.
917 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
918 struct lttng_ust_filter_bytecode
*orig_f
)
920 struct lttng_ust_filter_bytecode
*filter
= NULL
;
922 /* Copy filter bytecode */
923 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
925 PERROR("zmalloc alloc ust app filter");
929 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
936 * Find an ust_app using the sock and return it. RCU read side lock must be
937 * held before calling this helper function.
940 struct ust_app
*find_app_by_sock(int sock
)
942 struct lttng_ht_node_ulong
*node
;
943 struct lttng_ht_iter iter
;
945 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
946 node
= lttng_ht_iter_get_node_ulong(&iter
);
948 DBG2("UST app find by sock %d not found", sock
);
952 return caa_container_of(node
, struct ust_app
, sock_n
);
959 * Find an ust_app using the notify sock and return it. RCU read side lock must
960 * be held before calling this helper function.
962 static struct ust_app
*find_app_by_notify_sock(int sock
)
964 struct lttng_ht_node_ulong
*node
;
965 struct lttng_ht_iter iter
;
967 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
969 node
= lttng_ht_iter_get_node_ulong(&iter
);
971 DBG2("UST app find by notify sock %d not found", sock
);
975 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
982 * Lookup for an ust app event based on event name, filter bytecode and the
985 * Return an ust_app_event object or NULL on error.
987 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
988 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
990 struct lttng_ht_iter iter
;
991 struct lttng_ht_node_str
*node
;
992 struct ust_app_event
*event
= NULL
;
993 struct ust_app_ht_key key
;
998 /* Setup key for event lookup. */
1000 key
.filter
= filter
;
1001 key
.loglevel
= loglevel
;
1003 /* Lookup using the event name as hash and a custom match fct. */
1004 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1005 ht_match_ust_app_event
, &key
, &iter
.iter
);
1006 node
= lttng_ht_iter_get_node_str(&iter
);
1011 event
= caa_container_of(node
, struct ust_app_event
, node
);
1018 * Create the channel context on the tracer.
1020 * Called with UST app session lock held.
1023 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1024 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1028 health_code_update();
1030 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1031 ua_chan
->obj
, &ua_ctx
->obj
);
1033 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1034 ERR("UST app create channel context failed for app (pid: %d) "
1035 "with ret %d", app
->pid
, ret
);
1037 DBG3("UST app disable event failed. Application is dead.");
1042 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1044 DBG2("UST app context handle %d created successfully for channel %s",
1045 ua_ctx
->handle
, ua_chan
->name
);
1048 health_code_update();
1053 * Set the filter on the tracer.
1056 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1057 struct ust_app
*app
)
1061 health_code_update();
1063 if (!ua_event
->filter
) {
1068 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1071 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1072 ERR("UST app event %s filter failed for app (pid: %d) "
1073 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1075 DBG3("UST app filter event failed. Application is dead.");
1080 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1083 health_code_update();
1088 * Disable the specified event on to UST tracer for the UST session.
1090 static int disable_ust_event(struct ust_app
*app
,
1091 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1095 health_code_update();
1097 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1099 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1100 ERR("UST app event %s disable failed for app (pid: %d) "
1101 "and session handle %d with ret %d",
1102 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1104 DBG3("UST app disable event failed. Application is dead.");
1109 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1110 ua_event
->attr
.name
, app
->pid
);
1113 health_code_update();
1118 * Disable the specified channel on to UST tracer for the UST session.
1120 static int disable_ust_channel(struct ust_app
*app
,
1121 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1125 health_code_update();
1127 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1129 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1130 ERR("UST app channel %s disable failed for app (pid: %d) "
1131 "and session handle %d with ret %d",
1132 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1134 DBG3("UST app disable channel failed. Application is dead.");
1139 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1140 ua_chan
->name
, app
->pid
);
1143 health_code_update();
1148 * Enable the specified channel on to UST tracer for the UST session.
1150 static int enable_ust_channel(struct ust_app
*app
,
1151 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1155 health_code_update();
1157 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1159 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1160 ERR("UST app channel %s enable failed for app (pid: %d) "
1161 "and session handle %d with ret %d",
1162 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1164 DBG3("UST app enable channel failed. Application is dead.");
1169 ua_chan
->enabled
= 1;
1171 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1172 ua_chan
->name
, app
->pid
);
1175 health_code_update();
1180 * Enable the specified event on to UST tracer for the UST session.
1182 static int enable_ust_event(struct ust_app
*app
,
1183 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1187 health_code_update();
1189 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1191 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1192 ERR("UST app event %s enable failed for app (pid: %d) "
1193 "and session handle %d with ret %d",
1194 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1196 DBG3("UST app enable event failed. Application is dead.");
1201 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1202 ua_event
->attr
.name
, app
->pid
);
1205 health_code_update();
1210 * Send channel and stream buffer to application.
1212 * Return 0 on success. On error, a negative value is returned.
1214 static int send_channel_pid_to_ust(struct ust_app
*app
,
1215 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1218 struct ust_app_stream
*stream
, *stmp
;
1224 health_code_update();
1226 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1229 /* Send channel to the application. */
1230 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1235 health_code_update();
1237 /* Send all streams to application. */
1238 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1239 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1243 /* We don't need the stream anymore once sent to the tracer. */
1244 cds_list_del(&stream
->list
);
1245 delete_ust_app_stream(-1, stream
);
1247 /* Flag the channel that it is sent to the application. */
1248 ua_chan
->is_sent
= 1;
1251 health_code_update();
1256 * Create the specified event onto the UST tracer for a UST session.
1258 * Should be called with session mutex held.
1261 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1262 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1266 health_code_update();
1268 /* Create UST event on tracer */
1269 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1272 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1273 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1274 ua_event
->attr
.name
, app
->pid
, ret
);
1276 DBG3("UST app create event failed. Application is dead.");
1281 ua_event
->handle
= ua_event
->obj
->handle
;
1283 DBG2("UST app event %s created successfully for pid:%d",
1284 ua_event
->attr
.name
, app
->pid
);
1286 health_code_update();
1288 /* Set filter if one is present. */
1289 if (ua_event
->filter
) {
1290 ret
= set_ust_event_filter(ua_event
, app
);
1296 /* If event not enabled, disable it on the tracer */
1297 if (ua_event
->enabled
== 0) {
1298 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1301 * If we hit an EPERM, something is wrong with our disable call. If
1302 * we get an EEXIST, there is a problem on the tracer side since we
1306 case -LTTNG_UST_ERR_PERM
:
1307 /* Code flow problem */
1309 case -LTTNG_UST_ERR_EXIST
:
1310 /* It's OK for our use case. */
1321 health_code_update();
1326 * Copy data between an UST app event and a LTT event.
1328 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1329 struct ltt_ust_event
*uevent
)
1331 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1332 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1334 ua_event
->enabled
= uevent
->enabled
;
1336 /* Copy event attributes */
1337 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1339 /* Copy filter bytecode */
1340 if (uevent
->filter
) {
1341 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1342 /* Filter might be NULL here in case of ENONEM. */
1347 * Copy data between an UST app channel and a LTT channel.
1349 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1350 struct ltt_ust_channel
*uchan
)
1352 struct lttng_ht_iter iter
;
1353 struct ltt_ust_event
*uevent
;
1354 struct ltt_ust_context
*uctx
;
1355 struct ust_app_event
*ua_event
;
1356 struct ust_app_ctx
*ua_ctx
;
1358 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1360 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1361 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1363 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1364 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1366 /* Copy event attributes since the layout is different. */
1367 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1368 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1369 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1370 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1371 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1372 ua_chan
->attr
.output
= uchan
->attr
.output
;
1374 * Note that the attribute channel type is not set since the channel on the
1375 * tracing registry side does not have this information.
1378 ua_chan
->enabled
= uchan
->enabled
;
1379 ua_chan
->tracing_channel_id
= uchan
->id
;
1381 cds_lfht_for_each_entry(uchan
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
1382 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1383 if (ua_ctx
== NULL
) {
1386 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1387 (unsigned long) ua_ctx
->ctx
.ctx
);
1388 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1391 /* Copy all events from ltt ust channel to ust app channel */
1392 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1393 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1394 uevent
->filter
, uevent
->attr
.loglevel
);
1395 if (ua_event
== NULL
) {
1396 DBG2("UST event %s not found on shadow copy channel",
1398 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1399 if (ua_event
== NULL
) {
1402 shadow_copy_event(ua_event
, uevent
);
1403 add_unique_ust_app_event(ua_chan
, ua_event
);
1407 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1411 * Copy data between a UST app session and a regular LTT session.
1413 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1414 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1416 struct lttng_ht_node_str
*ua_chan_node
;
1417 struct lttng_ht_iter iter
;
1418 struct ltt_ust_channel
*uchan
;
1419 struct ust_app_channel
*ua_chan
;
1421 struct tm
*timeinfo
;
1425 /* Get date and time for unique app path */
1427 timeinfo
= localtime(&rawtime
);
1428 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1430 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1432 ua_sess
->tracing_id
= usess
->id
;
1433 ua_sess
->id
= get_next_session_id();
1434 ua_sess
->uid
= app
->uid
;
1435 ua_sess
->gid
= app
->gid
;
1436 ua_sess
->euid
= usess
->uid
;
1437 ua_sess
->egid
= usess
->gid
;
1438 ua_sess
->buffer_type
= usess
->buffer_type
;
1439 ua_sess
->bits_per_long
= app
->bits_per_long
;
1440 /* There is only one consumer object per session possible. */
1441 ua_sess
->consumer
= usess
->consumer
;
1443 switch (ua_sess
->buffer_type
) {
1444 case LTTNG_BUFFER_PER_PID
:
1445 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1446 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1449 case LTTNG_BUFFER_PER_UID
:
1450 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1451 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1458 PERROR("asprintf UST shadow copy session");
1463 /* Iterate over all channels in global domain. */
1464 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1466 struct lttng_ht_iter uiter
;
1468 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1469 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1470 if (ua_chan_node
!= NULL
) {
1471 /* Session exist. Contiuing. */
1475 DBG2("Channel %s not found on shadow session copy, creating it",
1477 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1478 if (ua_chan
== NULL
) {
1479 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1482 shadow_copy_channel(ua_chan
, uchan
);
1484 * The concept of metadata channel does not exist on the tracing
1485 * registry side of the session daemon so this can only be a per CPU
1486 * channel and not metadata.
1488 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1490 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1498 * Lookup sesison wrapper.
1501 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1502 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1504 /* Get right UST app session from app */
1505 lttng_ht_lookup(app
->sessions
, (void *)((unsigned long) usess
->id
), iter
);
1509 * Return ust app session from the app session hashtable using the UST session
1512 static struct ust_app_session
*lookup_session_by_app(
1513 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1515 struct lttng_ht_iter iter
;
1516 struct lttng_ht_node_ulong
*node
;
1518 __lookup_session_by_app(usess
, app
, &iter
);
1519 node
= lttng_ht_iter_get_node_ulong(&iter
);
1524 return caa_container_of(node
, struct ust_app_session
, node
);
1531 * Setup buffer registry per PID for the given session and application. If none
1532 * is found, a new one is created, added to the global registry and
1533 * initialized. If regp is valid, it's set with the newly created object.
1535 * Return 0 on success or else a negative value.
1537 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1538 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1541 struct buffer_reg_pid
*reg_pid
;
1548 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1551 * This is the create channel path meaning that if there is NO
1552 * registry available, we have to create one for this session.
1554 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1558 buffer_reg_pid_add(reg_pid
);
1563 /* Initialize registry. */
1564 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1565 app
->bits_per_long
, app
->uint8_t_alignment
,
1566 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1567 app
->uint64_t_alignment
, app
->long_alignment
,
1568 app
->byte_order
, app
->version
.major
,
1569 app
->version
.minor
);
1574 DBG3("UST app buffer registry per PID created successfully");
1586 * Setup buffer registry per UID for the given session and application. If none
1587 * is found, a new one is created, added to the global registry and
1588 * initialized. If regp is valid, it's set with the newly created object.
1590 * Return 0 on success or else a negative value.
1592 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1593 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1596 struct buffer_reg_uid
*reg_uid
;
1603 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1606 * This is the create channel path meaning that if there is NO
1607 * registry available, we have to create one for this session.
1609 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1610 LTTNG_DOMAIN_UST
, ®_uid
);
1614 buffer_reg_uid_add(reg_uid
);
1619 /* Initialize registry. */
1620 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1621 app
->bits_per_long
, app
->uint8_t_alignment
,
1622 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1623 app
->uint64_t_alignment
, app
->long_alignment
,
1624 app
->byte_order
, app
->version
.major
,
1625 app
->version
.minor
);
1629 /* Add node to teardown list of the session. */
1630 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1632 DBG3("UST app buffer registry per UID created successfully");
1644 * Create a session on the tracer side for the given app.
1646 * On success, ua_sess_ptr is populated with the session pointer or else left
1647 * untouched. If the session was created, is_created is set to 1. On error,
1648 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1651 * Returns 0 on success or else a negative code which is either -ENOMEM or
1652 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1654 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1655 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1658 int ret
, created
= 0;
1659 struct ust_app_session
*ua_sess
;
1663 assert(ua_sess_ptr
);
1665 health_code_update();
1667 ua_sess
= lookup_session_by_app(usess
, app
);
1668 if (ua_sess
== NULL
) {
1669 DBG2("UST app pid: %d session id %d not found, creating it",
1670 app
->pid
, usess
->id
);
1671 ua_sess
= alloc_ust_app_session(app
);
1672 if (ua_sess
== NULL
) {
1673 /* Only malloc can failed so something is really wrong */
1677 shadow_copy_session(ua_sess
, usess
, app
);
1681 switch (usess
->buffer_type
) {
1682 case LTTNG_BUFFER_PER_PID
:
1683 /* Init local registry. */
1684 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1689 case LTTNG_BUFFER_PER_UID
:
1690 /* Look for a global registry. If none exists, create one. */
1691 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1702 health_code_update();
1704 if (ua_sess
->handle
== -1) {
1705 ret
= ustctl_create_session(app
->sock
);
1707 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1708 ERR("Creating session for app pid %d with ret %d",
1711 DBG("UST app creating session failed. Application is dead");
1713 delete_ust_app_session(-1, ua_sess
, app
);
1714 if (ret
!= -ENOMEM
) {
1716 * Tracer is probably gone or got an internal error so let's
1717 * behave like it will soon unregister or not usable.
1724 ua_sess
->handle
= ret
;
1726 /* Add ust app session to app's HT */
1727 lttng_ht_node_init_ulong(&ua_sess
->node
,
1728 (unsigned long) ua_sess
->tracing_id
);
1729 lttng_ht_add_unique_ulong(app
->sessions
, &ua_sess
->node
);
1731 DBG2("UST app session created successfully with handle %d", ret
);
1734 *ua_sess_ptr
= ua_sess
;
1736 *is_created
= created
;
1739 /* Everything went well. */
1743 health_code_update();
1748 * Create a context for the channel on the tracer.
1750 * Called with UST app session lock held and a RCU read side lock.
1753 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1754 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1755 struct ust_app
*app
)
1758 struct lttng_ht_iter iter
;
1759 struct lttng_ht_node_ulong
*node
;
1760 struct ust_app_ctx
*ua_ctx
;
1762 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1764 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1765 node
= lttng_ht_iter_get_node_ulong(&iter
);
1771 ua_ctx
= alloc_ust_app_ctx(uctx
);
1772 if (ua_ctx
== NULL
) {
1778 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1779 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1781 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1791 * Enable on the tracer side a ust app event for the session and channel.
1793 * Called with UST app session lock held.
1796 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1797 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1801 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1806 ua_event
->enabled
= 1;
1813 * Disable on the tracer side a ust app event for the session and channel.
1815 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1816 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1820 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1825 ua_event
->enabled
= 0;
1832 * Lookup ust app channel for session and disable it on the tracer side.
1835 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1836 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1840 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1845 ua_chan
->enabled
= 0;
1852 * Lookup ust app channel for session and enable it on the tracer side. This
1853 * MUST be called with a RCU read side lock acquired.
1855 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1856 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1859 struct lttng_ht_iter iter
;
1860 struct lttng_ht_node_str
*ua_chan_node
;
1861 struct ust_app_channel
*ua_chan
;
1863 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1864 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1865 if (ua_chan_node
== NULL
) {
1866 DBG2("Unable to find channel %s in ust session id %u",
1867 uchan
->name
, ua_sess
->tracing_id
);
1871 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1873 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1883 * Ask the consumer to create a channel and get it if successful.
1885 * Return 0 on success or else a negative value.
1887 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1888 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1889 int bitness
, struct ust_registry_session
*registry
)
1892 unsigned int nb_fd
= 0;
1893 struct consumer_socket
*socket
;
1901 health_code_update();
1903 /* Get the right consumer socket for the application. */
1904 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1910 health_code_update();
1912 /* Need one fd for the channel. */
1913 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1915 ERR("Exhausted number of available FD upon create channel");
1920 * Ask consumer to create channel. The consumer will return the number of
1921 * stream we have to expect.
1923 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
1930 * Compute the number of fd needed before receiving them. It must be 2 per
1931 * stream (2 being the default value here).
1933 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
1935 /* Reserve the amount of file descriptor we need. */
1936 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
1938 ERR("Exhausted number of available FD upon create channel");
1939 goto error_fd_get_stream
;
1942 health_code_update();
1945 * Now get the channel from the consumer. This call wil populate the stream
1946 * list of that channel and set the ust objects.
1948 ret
= ust_consumer_get_channel(socket
, ua_chan
);
1957 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
1958 error_fd_get_stream
:
1960 * Initiate a destroy channel on the consumer since we had an error
1961 * handling it on our side. The return value is of no importance since we
1962 * already have a ret value set by the previous error that we need to
1965 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
1967 lttng_fd_put(LTTNG_FD_APPS
, 1);
1969 health_code_update();
1975 * Duplicate the ust data object of the ust app stream and save it in the
1976 * buffer registry stream.
1978 * Return 0 on success or else a negative value.
1980 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
1981 struct ust_app_stream
*stream
)
1988 /* Reserve the amount of file descriptor we need. */
1989 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
1991 ERR("Exhausted number of available FD upon duplicate stream");
1995 /* Duplicate object for stream once the original is in the registry. */
1996 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
1997 reg_stream
->obj
.ust
);
1999 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2000 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2001 lttng_fd_put(LTTNG_FD_APPS
, 2);
2004 stream
->handle
= stream
->obj
->handle
;
2011 * Duplicate the ust data object of the ust app. channel and save it in the
2012 * buffer registry channel.
2014 * Return 0 on success or else a negative value.
2016 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2017 struct ust_app_channel
*ua_chan
)
2024 /* Need two fds for the channel. */
2025 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2027 ERR("Exhausted number of available FD upon duplicate channel");
2031 /* Duplicate object for stream once the original is in the registry. */
2032 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2034 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2035 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2038 ua_chan
->handle
= ua_chan
->obj
->handle
;
2043 lttng_fd_put(LTTNG_FD_APPS
, 1);
2049 * For a given channel buffer registry, setup all streams of the given ust
2050 * application channel.
2052 * Return 0 on success or else a negative value.
2054 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2055 struct ust_app_channel
*ua_chan
)
2058 struct ust_app_stream
*stream
, *stmp
;
2063 DBG2("UST app setup buffer registry stream");
2065 /* Send all streams to application. */
2066 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2067 struct buffer_reg_stream
*reg_stream
;
2069 ret
= buffer_reg_stream_create(®_stream
);
2075 * Keep original pointer and nullify it in the stream so the delete
2076 * stream call does not release the object.
2078 reg_stream
->obj
.ust
= stream
->obj
;
2080 buffer_reg_stream_add(reg_stream
, reg_chan
);
2082 /* We don't need the streams anymore. */
2083 cds_list_del(&stream
->list
);
2084 delete_ust_app_stream(-1, stream
);
2092 * Create a buffer registry channel for the given session registry and
2093 * application channel object. If regp pointer is valid, it's set with the
2094 * created object. Important, the created object is NOT added to the session
2095 * registry hash table.
2097 * Return 0 on success else a negative value.
2099 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2100 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2103 struct buffer_reg_channel
*reg_chan
= NULL
;
2108 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2110 /* Create buffer registry channel. */
2111 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2116 reg_chan
->consumer_key
= ua_chan
->key
;
2118 /* Create and add a channel registry to session. */
2119 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2120 ua_chan
->tracing_channel_id
);
2124 buffer_reg_channel_add(reg_sess
, reg_chan
);
2133 /* Safe because the registry channel object was not added to any HT. */
2134 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2140 * Setup buffer registry channel for the given session registry and application
2141 * channel object. If regp pointer is valid, it's set with the created object.
2143 * Return 0 on success else a negative value.
2145 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2146 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2153 assert(ua_chan
->obj
);
2155 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2157 /* Setup all streams for the registry. */
2158 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2163 reg_chan
->obj
.ust
= ua_chan
->obj
;
2164 ua_chan
->obj
= NULL
;
2169 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2170 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2175 * Send buffer registry channel to the application.
2177 * Return 0 on success else a negative value.
2179 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2180 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2181 struct ust_app_channel
*ua_chan
)
2184 struct buffer_reg_stream
*reg_stream
;
2191 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2193 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2198 /* Send channel to the application. */
2199 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2204 health_code_update();
2206 /* Send all streams to application. */
2207 pthread_mutex_lock(®_chan
->stream_list_lock
);
2208 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2209 struct ust_app_stream stream
;
2211 ret
= duplicate_stream_object(reg_stream
, &stream
);
2213 goto error_stream_unlock
;
2216 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2218 (void) release_ust_app_stream(-1, &stream
);
2219 goto error_stream_unlock
;
2223 * The return value is not important here. This function will output an
2226 (void) release_ust_app_stream(-1, &stream
);
2228 ua_chan
->is_sent
= 1;
2230 error_stream_unlock
:
2231 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2237 * Create and send to the application the created buffers with per UID buffers.
2239 * Return 0 on success else a negative value.
2241 static int create_channel_per_uid(struct ust_app
*app
,
2242 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2243 struct ust_app_channel
*ua_chan
)
2246 struct buffer_reg_uid
*reg_uid
;
2247 struct buffer_reg_channel
*reg_chan
;
2254 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2256 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2258 * The session creation handles the creation of this global registry
2259 * object. If none can be find, there is a code flow problem or a
2264 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2267 /* Create the buffer registry channel object. */
2268 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2275 * Create the buffers on the consumer side. This call populates the
2276 * ust app channel object with all streams and data object.
2278 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2279 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2282 * Let's remove the previously created buffer registry channel so
2283 * it's not visible anymore in the session registry.
2285 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2286 ua_chan
->tracing_channel_id
);
2287 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2288 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2293 * Setup the streams and add it to the session registry.
2295 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2302 /* Send buffers to the application. */
2303 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2313 * Create and send to the application the created buffers with per PID buffers.
2315 * Return 0 on success else a negative value.
2317 static int create_channel_per_pid(struct ust_app
*app
,
2318 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2319 struct ust_app_channel
*ua_chan
)
2322 struct ust_registry_session
*registry
;
2329 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2333 registry
= get_session_registry(ua_sess
);
2336 /* Create and add a new channel registry to session. */
2337 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2342 /* Create and get channel on the consumer side. */
2343 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2344 app
->bits_per_long
, registry
);
2349 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2360 * From an already allocated ust app channel, create the channel buffers if
2361 * need and send it to the application. This MUST be called with a RCU read
2362 * side lock acquired.
2364 * Return 0 on success or else a negative value.
2366 static int do_create_channel(struct ust_app
*app
,
2367 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2368 struct ust_app_channel
*ua_chan
)
2377 /* Handle buffer type before sending the channel to the application. */
2378 switch (usess
->buffer_type
) {
2379 case LTTNG_BUFFER_PER_UID
:
2381 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2387 case LTTNG_BUFFER_PER_PID
:
2389 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2401 /* Initialize ust objd object using the received handle and add it. */
2402 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2403 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2405 /* If channel is not enabled, disable it on the tracer */
2406 if (!ua_chan
->enabled
) {
2407 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2418 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2419 * newly created channel if not NULL.
2421 * Called with UST app session lock and RCU read-side lock held.
2423 * Return 0 on success or else a negative value.
2425 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2426 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2427 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2428 struct ust_app_channel
**ua_chanp
)
2431 struct lttng_ht_iter iter
;
2432 struct lttng_ht_node_str
*ua_chan_node
;
2433 struct ust_app_channel
*ua_chan
;
2435 /* Lookup channel in the ust app session */
2436 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2437 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2438 if (ua_chan_node
!= NULL
) {
2439 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2443 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2444 if (ua_chan
== NULL
) {
2445 /* Only malloc can fail here */
2449 shadow_copy_channel(ua_chan
, uchan
);
2451 /* Set channel type. */
2452 ua_chan
->attr
.type
= type
;
2454 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2459 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2462 /* Only add the channel if successful on the tracer side. */
2463 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2467 *ua_chanp
= ua_chan
;
2470 /* Everything went well. */
2474 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2480 * Create UST app event and create it on the tracer side.
2482 * Called with ust app session mutex held.
2485 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2486 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2487 struct ust_app
*app
)
2490 struct ust_app_event
*ua_event
;
2492 /* Get event node */
2493 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2494 uevent
->filter
, uevent
->attr
.loglevel
);
2495 if (ua_event
!= NULL
) {
2500 /* Does not exist so create one */
2501 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2502 if (ua_event
== NULL
) {
2503 /* Only malloc can failed so something is really wrong */
2507 shadow_copy_event(ua_event
, uevent
);
2509 /* Create it on the tracer side */
2510 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2512 /* Not found previously means that it does not exist on the tracer */
2513 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2517 add_unique_ust_app_event(ua_chan
, ua_event
);
2519 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2526 /* Valid. Calling here is already in a read side lock */
2527 delete_ust_app_event(-1, ua_event
);
2532 * Create UST metadata and open it on the tracer side.
2534 * Called with UST app session lock held and RCU read side lock.
2536 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2537 struct ust_app
*app
, struct consumer_output
*consumer
,
2538 struct ustctl_consumer_channel_attr
*attr
)
2541 struct ust_app_channel
*metadata
;
2542 struct consumer_socket
*socket
;
2543 struct ust_registry_session
*registry
;
2549 registry
= get_session_registry(ua_sess
);
2552 /* Metadata already exists for this registry or it was closed previously */
2553 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2558 /* Allocate UST metadata */
2559 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2561 /* malloc() failed */
2567 /* Set default attributes for metadata. */
2568 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2569 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2570 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2571 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2572 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2573 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2574 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2576 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2577 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2578 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2581 /* Need one fd for the channel. */
2582 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2584 ERR("Exhausted number of available FD upon create metadata");
2588 /* Get the right consumer socket for the application. */
2589 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2592 goto error_consumer
;
2596 * Keep metadata key so we can identify it on the consumer side. Assign it
2597 * to the registry *before* we ask the consumer so we avoid the race of the
2598 * consumer requesting the metadata and the ask_channel call on our side
2599 * did not returned yet.
2601 registry
->metadata_key
= metadata
->key
;
2604 * Ask the metadata channel creation to the consumer. The metadata object
2605 * will be created by the consumer and kept their. However, the stream is
2606 * never added or monitored until we do a first push metadata to the
2609 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2613 * Safe because the metadata obj pointer is not set so the delete below
2614 * will not put a FD back again.
2616 goto error_consumer
;
2620 * The setup command will make the metadata stream be sent to the relayd,
2621 * if applicable, and the thread managing the metadatas. This is important
2622 * because after this point, if an error occurs, the only way the stream
2623 * can be deleted is to be monitored in the consumer.
2625 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2628 * Safe because the metadata obj pointer is not set so the delete below
2629 * will not put a FD back again.
2631 goto error_consumer
;
2634 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2635 metadata
->key
, app
->pid
);
2638 lttng_fd_put(LTTNG_FD_APPS
, 1);
2639 delete_ust_app_channel(-1, metadata
, app
);
2645 * Return pointer to traceable apps list.
2647 struct lttng_ht
*ust_app_get_ht(void)
2653 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2654 * acquired before calling this function.
2656 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2658 struct ust_app
*app
= NULL
;
2659 struct lttng_ht_node_ulong
*node
;
2660 struct lttng_ht_iter iter
;
2662 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2663 node
= lttng_ht_iter_get_node_ulong(&iter
);
2665 DBG2("UST app no found with pid %d", pid
);
2669 DBG2("Found UST app by pid %d", pid
);
2671 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2678 * Allocate and init an UST app object using the registration information and
2679 * the command socket. This is called when the command socket connects to the
2682 * The object is returned on success or else NULL.
2684 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2686 struct ust_app
*lta
= NULL
;
2691 DBG3("UST app creating application for socket %d", sock
);
2693 if ((msg
->bits_per_long
== 64 &&
2694 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2695 || (msg
->bits_per_long
== 32 &&
2696 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2697 ERR("Registration failed: application \"%s\" (pid: %d) has "
2698 "%d-bit long, but no consumerd for this size is available.\n",
2699 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2703 lta
= zmalloc(sizeof(struct ust_app
));
2709 lta
->ppid
= msg
->ppid
;
2710 lta
->uid
= msg
->uid
;
2711 lta
->gid
= msg
->gid
;
2713 lta
->bits_per_long
= msg
->bits_per_long
;
2714 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2715 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2716 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2717 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2718 lta
->long_alignment
= msg
->long_alignment
;
2719 lta
->byte_order
= msg
->byte_order
;
2721 lta
->v_major
= msg
->major
;
2722 lta
->v_minor
= msg
->minor
;
2723 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2724 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2725 lta
->notify_sock
= -1;
2727 /* Copy name and make sure it's NULL terminated. */
2728 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2729 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2732 * Before this can be called, when receiving the registration information,
2733 * the application compatibility is checked. So, at this point, the
2734 * application can work with this session daemon.
2736 lta
->compatible
= 1;
2738 lta
->pid
= msg
->pid
;
2739 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2741 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2743 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2750 * For a given application object, add it to every hash table.
2752 void ust_app_add(struct ust_app
*app
)
2755 assert(app
->notify_sock
>= 0);
2760 * On a re-registration, we want to kick out the previous registration of
2763 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2766 * The socket _should_ be unique until _we_ call close. So, a add_unique
2767 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2768 * already in the table.
2770 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2772 /* Add application to the notify socket hash table. */
2773 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2774 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2776 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2777 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2778 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2785 * Set the application version into the object.
2787 * Return 0 on success else a negative value either an errno code or a
2788 * LTTng-UST error code.
2790 int ust_app_version(struct ust_app
*app
)
2796 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2798 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2799 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2801 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2809 * Unregister app by removing it from the global traceable app list and freeing
2812 * The socket is already closed at this point so no close to sock.
2814 void ust_app_unregister(int sock
)
2816 struct ust_app
*lta
;
2817 struct lttng_ht_node_ulong
*node
;
2818 struct lttng_ht_iter iter
;
2819 struct ust_app_session
*ua_sess
;
2824 /* Get the node reference for a call_rcu */
2825 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2826 node
= lttng_ht_iter_get_node_ulong(&iter
);
2829 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2830 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2832 /* Remove application from PID hash table */
2833 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2837 * Remove application from notify hash table. The thread handling the
2838 * notify socket could have deleted the node so ignore on error because
2839 * either way it's valid. The close of that socket is handled by the other
2842 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2843 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2846 * Ignore return value since the node might have been removed before by an
2847 * add replace during app registration because the PID can be reassigned by
2850 iter
.iter
.node
= <a
->pid_n
.node
;
2851 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2853 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2857 /* Remove sessions so they are not visible during deletion.*/
2858 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2860 struct ust_registry_session
*registry
;
2862 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2864 /* The session was already removed so scheduled for teardown. */
2869 * Add session to list for teardown. This is safe since at this point we
2870 * are the only one using this list.
2872 pthread_mutex_lock(&ua_sess
->lock
);
2875 * Normally, this is done in the delete session process which is
2876 * executed in the call rcu below. However, upon registration we can't
2877 * afford to wait for the grace period before pushing data or else the
2878 * data pending feature can race between the unregistration and stop
2879 * command where the data pending command is sent *before* the grace
2882 * The close metadata below nullifies the metadata pointer in the
2883 * session so the delete session will NOT push/close a second time.
2885 registry
= get_session_registry(ua_sess
);
2886 if (registry
&& !registry
->metadata_closed
) {
2887 /* Push metadata for application before freeing the application. */
2888 (void) push_metadata(registry
, ua_sess
->consumer
);
2891 * Don't ask to close metadata for global per UID buffers. Close
2892 * metadata only on destroy trace session in this case. Also, the
2893 * previous push metadata could have flag the metadata registry to
2894 * close so don't send a close command if closed.
2896 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
2897 !registry
->metadata_closed
) {
2898 /* And ask to close it for this session registry. */
2899 (void) close_metadata(registry
, ua_sess
->consumer
);
2903 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2904 pthread_mutex_unlock(&ua_sess
->lock
);
2908 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2915 * Return traceable_app_count
2917 unsigned long ust_app_list_count(void)
2919 unsigned long count
;
2922 count
= lttng_ht_get_count(ust_app_ht
);
2929 * Fill events array with all events name of all registered apps.
2931 int ust_app_list_events(struct lttng_event
**events
)
2934 size_t nbmem
, count
= 0;
2935 struct lttng_ht_iter iter
;
2936 struct ust_app
*app
;
2937 struct lttng_event
*tmp_event
;
2939 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2940 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
2941 if (tmp_event
== NULL
) {
2942 PERROR("zmalloc ust app events");
2949 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2950 struct lttng_ust_tracepoint_iter uiter
;
2952 health_code_update();
2954 if (!app
->compatible
) {
2956 * TODO: In time, we should notice the caller of this error by
2957 * telling him that this is a version error.
2961 handle
= ustctl_tracepoint_list(app
->sock
);
2963 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
2964 ERR("UST app list events getting handle failed for app pid %d",
2970 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
2971 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
2972 /* Handle ustctl error. */
2975 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
2976 ERR("UST app tp list get failed for app %d with ret %d",
2979 DBG3("UST app tp list get failed. Application is dead");
2984 health_code_update();
2985 if (count
>= nbmem
) {
2986 /* In case the realloc fails, we free the memory */
2989 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
2992 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
2994 PERROR("realloc ust app events");
3001 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3002 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3003 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3004 tmp_event
[count
].pid
= app
->pid
;
3005 tmp_event
[count
].enabled
= -1;
3011 *events
= tmp_event
;
3013 DBG2("UST app list events done (%zu events)", count
);
3018 health_code_update();
3023 * Fill events array with all events name of all registered apps.
3025 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3028 size_t nbmem
, count
= 0;
3029 struct lttng_ht_iter iter
;
3030 struct ust_app
*app
;
3031 struct lttng_event_field
*tmp_event
;
3033 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3034 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3035 if (tmp_event
== NULL
) {
3036 PERROR("zmalloc ust app event fields");
3043 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3044 struct lttng_ust_field_iter uiter
;
3046 health_code_update();
3048 if (!app
->compatible
) {
3050 * TODO: In time, we should notice the caller of this error by
3051 * telling him that this is a version error.
3055 handle
= ustctl_tracepoint_field_list(app
->sock
);
3057 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3058 ERR("UST app list field getting handle failed for app pid %d",
3064 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3065 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3066 /* Handle ustctl error. */
3069 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3070 ERR("UST app tp list field failed for app %d with ret %d",
3073 DBG3("UST app tp list field failed. Application is dead");
3078 health_code_update();
3079 if (count
>= nbmem
) {
3080 /* In case the realloc fails, we free the memory */
3083 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3086 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3088 PERROR("realloc ust app event fields");
3096 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3097 tmp_event
[count
].type
= uiter
.type
;
3098 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3100 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3101 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3102 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3103 tmp_event
[count
].event
.pid
= app
->pid
;
3104 tmp_event
[count
].event
.enabled
= -1;
3110 *fields
= tmp_event
;
3112 DBG2("UST app list event fields done (%zu events)", count
);
3117 health_code_update();
3122 * Free and clean all traceable apps of the global list.
3124 * Should _NOT_ be called with RCU read-side lock held.
3126 void ust_app_clean_list(void)
3129 struct ust_app
*app
;
3130 struct lttng_ht_iter iter
;
3132 DBG2("UST app cleaning registered apps hash table");
3136 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3137 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3139 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3142 /* Cleanup socket hash table */
3143 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3145 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3149 /* Cleanup notify socket hash table */
3150 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3151 notify_sock_n
.node
) {
3152 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3157 /* Destroy is done only when the ht is empty */
3158 lttng_ht_destroy(ust_app_ht
);
3159 lttng_ht_destroy(ust_app_ht_by_sock
);
3160 lttng_ht_destroy(ust_app_ht_by_notify_sock
);
3164 * Init UST app hash table.
3166 void ust_app_ht_alloc(void)
3168 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3169 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3170 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3174 * For a specific UST session, disable the channel for all registered apps.
3176 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3177 struct ltt_ust_channel
*uchan
)
3180 struct lttng_ht_iter iter
;
3181 struct lttng_ht_node_str
*ua_chan_node
;
3182 struct ust_app
*app
;
3183 struct ust_app_session
*ua_sess
;
3184 struct ust_app_channel
*ua_chan
;
3186 if (usess
== NULL
|| uchan
== NULL
) {
3187 ERR("Disabling UST global channel with NULL values");
3192 DBG2("UST app disabling channel %s from global domain for session id %d",
3193 uchan
->name
, usess
->id
);
3197 /* For every registered applications */
3198 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3199 struct lttng_ht_iter uiter
;
3200 if (!app
->compatible
) {
3202 * TODO: In time, we should notice the caller of this error by
3203 * telling him that this is a version error.
3207 ua_sess
= lookup_session_by_app(usess
, app
);
3208 if (ua_sess
== NULL
) {
3213 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3214 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3215 /* If the session if found for the app, the channel must be there */
3216 assert(ua_chan_node
);
3218 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3219 /* The channel must not be already disabled */
3220 assert(ua_chan
->enabled
== 1);
3222 /* Disable channel onto application */
3223 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3225 /* XXX: We might want to report this error at some point... */
3237 * For a specific UST session, enable the channel for all registered apps.
3239 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3240 struct ltt_ust_channel
*uchan
)
3243 struct lttng_ht_iter iter
;
3244 struct ust_app
*app
;
3245 struct ust_app_session
*ua_sess
;
3247 if (usess
== NULL
|| uchan
== NULL
) {
3248 ERR("Adding UST global channel to NULL values");
3253 DBG2("UST app enabling channel %s to global domain for session id %d",
3254 uchan
->name
, usess
->id
);
3258 /* For every registered applications */
3259 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3260 if (!app
->compatible
) {
3262 * TODO: In time, we should notice the caller of this error by
3263 * telling him that this is a version error.
3267 ua_sess
= lookup_session_by_app(usess
, app
);
3268 if (ua_sess
== NULL
) {
3272 /* Enable channel onto application */
3273 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3275 /* XXX: We might want to report this error at some point... */
3287 * Disable an event in a channel and for a specific session.
3289 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3290 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3293 struct lttng_ht_iter iter
, uiter
;
3294 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3295 struct ust_app
*app
;
3296 struct ust_app_session
*ua_sess
;
3297 struct ust_app_channel
*ua_chan
;
3298 struct ust_app_event
*ua_event
;
3300 DBG("UST app disabling event %s for all apps in channel "
3301 "%s for session id %d", uevent
->attr
.name
, uchan
->name
, usess
->id
);
3305 /* For all registered applications */
3306 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3307 if (!app
->compatible
) {
3309 * TODO: In time, we should notice the caller of this error by
3310 * telling him that this is a version error.
3314 ua_sess
= lookup_session_by_app(usess
, app
);
3315 if (ua_sess
== NULL
) {
3320 /* Lookup channel in the ust app session */
3321 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3322 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3323 if (ua_chan_node
== NULL
) {
3324 DBG2("Channel %s not found in session id %d for app pid %d."
3325 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3328 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3330 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3331 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3332 if (ua_event_node
== NULL
) {
3333 DBG2("Event %s not found in channel %s for app pid %d."
3334 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3337 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3339 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3341 /* XXX: Report error someday... */
3352 * For a specific UST session and UST channel, the event for all
3355 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3356 struct ltt_ust_channel
*uchan
)
3359 struct lttng_ht_iter iter
, uiter
;
3360 struct lttng_ht_node_str
*ua_chan_node
;
3361 struct ust_app
*app
;
3362 struct ust_app_session
*ua_sess
;
3363 struct ust_app_channel
*ua_chan
;
3364 struct ust_app_event
*ua_event
;
3366 DBG("UST app disabling all event for all apps in channel "
3367 "%s for session id %d", uchan
->name
, usess
->id
);
3371 /* For all registered applications */
3372 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3373 if (!app
->compatible
) {
3375 * TODO: In time, we should notice the caller of this error by
3376 * telling him that this is a version error.
3380 ua_sess
= lookup_session_by_app(usess
, app
);
3382 /* The application has problem or is probably dead. */
3386 /* Lookup channel in the ust app session */
3387 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3388 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3389 /* If the channel is not found, there is a code flow error */
3390 assert(ua_chan_node
);
3392 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3394 /* Disable each events of channel */
3395 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3397 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3399 /* XXX: Report error someday... */
3411 * For a specific UST session, create the channel for all registered apps.
3413 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3414 struct ltt_ust_channel
*uchan
)
3416 int ret
= 0, created
;
3417 struct lttng_ht_iter iter
;
3418 struct ust_app
*app
;
3419 struct ust_app_session
*ua_sess
= NULL
;
3421 /* Very wrong code flow */
3425 DBG2("UST app adding channel %s to UST domain for session id %d",
3426 uchan
->name
, usess
->id
);
3430 /* For every registered applications */
3431 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3432 if (!app
->compatible
) {
3434 * TODO: In time, we should notice the caller of this error by
3435 * telling him that this is a version error.
3440 * Create session on the tracer side and add it to app session HT. Note
3441 * that if session exist, it will simply return a pointer to the ust
3444 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3449 * The application's socket is not valid. Either a bad socket
3450 * or a timeout on it. We can't inform the caller that for a
3451 * specific app, the session failed so lets continue here.
3456 goto error_rcu_unlock
;
3461 pthread_mutex_lock(&ua_sess
->lock
);
3462 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3463 sizeof(uchan
->name
))) {
3464 struct ustctl_consumer_channel_attr attr
;
3465 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3466 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3469 /* Create channel onto application. We don't need the chan ref. */
3470 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3471 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3473 pthread_mutex_unlock(&ua_sess
->lock
);
3475 if (ret
== -ENOMEM
) {
3476 /* No more memory is a fatal error. Stop right now. */
3477 goto error_rcu_unlock
;
3479 /* Cleanup the created session if it's the case. */
3481 destroy_app_session(app
, ua_sess
);
3492 * Enable event for a specific session and channel on the tracer.
3494 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3495 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3498 struct lttng_ht_iter iter
, uiter
;
3499 struct lttng_ht_node_str
*ua_chan_node
;
3500 struct ust_app
*app
;
3501 struct ust_app_session
*ua_sess
;
3502 struct ust_app_channel
*ua_chan
;
3503 struct ust_app_event
*ua_event
;
3505 DBG("UST app enabling event %s for all apps for session id %d",
3506 uevent
->attr
.name
, usess
->id
);
3509 * NOTE: At this point, this function is called only if the session and
3510 * channel passed are already created for all apps. and enabled on the
3516 /* For all registered applications */
3517 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3518 if (!app
->compatible
) {
3520 * TODO: In time, we should notice the caller of this error by
3521 * telling him that this is a version error.
3525 ua_sess
= lookup_session_by_app(usess
, app
);
3527 /* The application has problem or is probably dead. */
3531 pthread_mutex_lock(&ua_sess
->lock
);
3533 /* Lookup channel in the ust app session */
3534 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3535 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3536 /* If the channel is not found, there is a code flow error */
3537 assert(ua_chan_node
);
3539 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3541 /* Get event node */
3542 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3543 uevent
->filter
, uevent
->attr
.loglevel
);
3544 if (ua_event
== NULL
) {
3545 DBG3("UST app enable event %s not found for app PID %d."
3546 "Skipping app", uevent
->attr
.name
, app
->pid
);
3550 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3552 pthread_mutex_unlock(&ua_sess
->lock
);
3556 pthread_mutex_unlock(&ua_sess
->lock
);
3565 * For a specific existing UST session and UST channel, creates the event for
3566 * all registered apps.
3568 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3569 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3572 struct lttng_ht_iter iter
, uiter
;
3573 struct lttng_ht_node_str
*ua_chan_node
;
3574 struct ust_app
*app
;
3575 struct ust_app_session
*ua_sess
;
3576 struct ust_app_channel
*ua_chan
;
3578 DBG("UST app creating event %s for all apps for session id %d",
3579 uevent
->attr
.name
, usess
->id
);
3583 /* For all registered applications */
3584 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3585 if (!app
->compatible
) {
3587 * TODO: In time, we should notice the caller of this error by
3588 * telling him that this is a version error.
3592 ua_sess
= lookup_session_by_app(usess
, app
);
3594 /* The application has problem or is probably dead. */
3598 pthread_mutex_lock(&ua_sess
->lock
);
3599 /* Lookup channel in the ust app session */
3600 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3601 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3602 /* If the channel is not found, there is a code flow error */
3603 assert(ua_chan_node
);
3605 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3607 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3608 pthread_mutex_unlock(&ua_sess
->lock
);
3610 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3611 /* Possible value at this point: -ENOMEM. If so, we stop! */
3614 DBG2("UST app event %s already exist on app PID %d",
3615 uevent
->attr
.name
, app
->pid
);
3626 * Start tracing for a specific UST session and app.
3629 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3632 struct ust_app_session
*ua_sess
;
3634 DBG("Starting tracing for ust app pid %d", app
->pid
);
3638 if (!app
->compatible
) {
3642 ua_sess
= lookup_session_by_app(usess
, app
);
3643 if (ua_sess
== NULL
) {
3644 /* The session is in teardown process. Ignore and continue. */
3648 pthread_mutex_lock(&ua_sess
->lock
);
3650 /* Upon restart, we skip the setup, already done */
3651 if (ua_sess
->started
) {
3655 /* Create directories if consumer is LOCAL and has a path defined. */
3656 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3657 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3658 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3659 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3661 if (ret
!= -EEXIST
) {
3662 ERR("Trace directory creation error");
3669 * Create the metadata for the application. This returns gracefully if a
3670 * metadata was already set for the session.
3672 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3677 health_code_update();
3680 /* This start the UST tracing */
3681 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3683 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3684 ERR("Error starting tracing for app pid: %d (ret: %d)",
3687 DBG("UST app start session failed. Application is dead.");
3692 /* Indicate that the session has been started once */
3693 ua_sess
->started
= 1;
3695 pthread_mutex_unlock(&ua_sess
->lock
);
3697 health_code_update();
3699 /* Quiescent wait after starting trace */
3700 ret
= ustctl_wait_quiescent(app
->sock
);
3701 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3702 ERR("UST app wait quiescent failed for app pid %d ret %d",
3708 health_code_update();
3712 pthread_mutex_unlock(&ua_sess
->lock
);
3714 health_code_update();
3719 * Stop tracing for a specific UST session and app.
3722 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3725 struct ust_app_session
*ua_sess
;
3726 struct ust_registry_session
*registry
;
3728 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3732 if (!app
->compatible
) {
3733 goto end_no_session
;
3736 ua_sess
= lookup_session_by_app(usess
, app
);
3737 if (ua_sess
== NULL
) {
3738 goto end_no_session
;
3741 pthread_mutex_lock(&ua_sess
->lock
);
3744 * If started = 0, it means that stop trace has been called for a session
3745 * that was never started. It's possible since we can have a fail start
3746 * from either the application manager thread or the command thread. Simply
3747 * indicate that this is a stop error.
3749 if (!ua_sess
->started
) {
3750 goto error_rcu_unlock
;
3753 health_code_update();
3755 /* This inhibits UST tracing */
3756 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3758 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3759 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3762 DBG("UST app stop session failed. Application is dead.");
3764 goto error_rcu_unlock
;
3767 health_code_update();
3769 /* Quiescent wait after stopping trace */
3770 ret
= ustctl_wait_quiescent(app
->sock
);
3771 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3772 ERR("UST app wait quiescent failed for app pid %d ret %d",
3776 health_code_update();
3778 registry
= get_session_registry(ua_sess
);
3781 if (!registry
->metadata_closed
) {
3782 /* Push metadata for application before freeing the application. */
3783 (void) push_metadata(registry
, ua_sess
->consumer
);
3786 pthread_mutex_unlock(&ua_sess
->lock
);
3789 health_code_update();
3793 pthread_mutex_unlock(&ua_sess
->lock
);
3795 health_code_update();
3800 * Flush buffers for a specific UST session and app.
3803 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3806 struct lttng_ht_iter iter
;
3807 struct ust_app_session
*ua_sess
;
3808 struct ust_app_channel
*ua_chan
;
3810 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3814 if (!app
->compatible
) {
3815 goto end_no_session
;
3818 ua_sess
= lookup_session_by_app(usess
, app
);
3819 if (ua_sess
== NULL
) {
3820 goto end_no_session
;
3823 pthread_mutex_lock(&ua_sess
->lock
);
3825 health_code_update();
3827 /* Flushing buffers */
3828 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3830 health_code_update();
3831 assert(ua_chan
->is_sent
);
3832 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3834 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3835 ERR("UST app PID %d channel %s flush failed with ret %d",
3836 app
->pid
, ua_chan
->name
, ret
);
3838 DBG3("UST app failed to flush %s. Application is dead.",
3840 /* No need to continue. */
3843 /* Continuing flushing all buffers */
3848 health_code_update();
3850 pthread_mutex_unlock(&ua_sess
->lock
);
3853 health_code_update();
3858 * Destroy a specific UST session in apps.
3860 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3863 struct ust_app_session
*ua_sess
;
3864 struct lttng_ht_iter iter
;
3865 struct lttng_ht_node_ulong
*node
;
3867 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3871 if (!app
->compatible
) {
3875 __lookup_session_by_app(usess
, app
, &iter
);
3876 node
= lttng_ht_iter_get_node_ulong(&iter
);
3878 /* Session is being or is deleted. */
3881 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3883 health_code_update();
3884 destroy_app_session(app
, ua_sess
);
3886 health_code_update();
3888 /* Quiescent wait after stopping trace */
3889 ret
= ustctl_wait_quiescent(app
->sock
);
3890 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3891 ERR("UST app wait quiescent failed for app pid %d ret %d",
3896 health_code_update();
3901 * Start tracing for the UST session.
3903 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
3906 struct lttng_ht_iter iter
;
3907 struct ust_app
*app
;
3909 DBG("Starting all UST traces");
3913 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3914 ret
= ust_app_start_trace(usess
, app
);
3916 /* Continue to next apps even on error */
3927 * Start tracing for the UST session.
3929 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
3932 struct lttng_ht_iter iter
;
3933 struct ust_app
*app
;
3935 DBG("Stopping all UST traces");
3939 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3940 ret
= ust_app_stop_trace(usess
, app
);
3942 /* Continue to next apps even on error */
3948 switch (usess
->buffer_type
) {
3949 case LTTNG_BUFFER_PER_UID
:
3951 struct buffer_reg_uid
*reg
;
3953 /* Flush all per UID buffers associated to that session. */
3954 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3955 struct buffer_reg_channel
*reg_chan
;
3956 struct consumer_socket
*socket
;
3958 /* Get consumer socket to use to push the metadata.*/
3959 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
3962 /* Ignore request if no consumer is found for the session. */
3966 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
3967 reg_chan
, node
.node
) {
3969 * The following call will print error values so the return
3970 * code is of little importance because whatever happens, we
3971 * have to try them all.
3973 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
3978 case LTTNG_BUFFER_PER_PID
:
3979 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3980 ret
= ust_app_flush_trace(usess
, app
);
3982 /* Continue to next apps even on error */
3998 * Destroy app UST session.
4000 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4003 struct lttng_ht_iter iter
;
4004 struct ust_app
*app
;
4006 DBG("Destroy all UST traces");
4010 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4011 ret
= destroy_trace(usess
, app
);
4013 /* Continue to next apps even on error */
4024 * Add channels/events from UST global domain to registered apps at sock.
4026 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4029 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
4030 struct ust_app
*app
;
4031 struct ust_app_session
*ua_sess
= NULL
;
4032 struct ust_app_channel
*ua_chan
;
4033 struct ust_app_event
*ua_event
;
4034 struct ust_app_ctx
*ua_ctx
;
4039 DBG2("UST app global update for app sock %d for session id %d", sock
,
4044 app
= find_app_by_sock(sock
);
4047 * Application can be unregistered before so this is possible hence
4048 * simply stopping the update.
4050 DBG3("UST app update failed to find app sock %d", sock
);
4054 if (!app
->compatible
) {
4058 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4060 /* Tracer is probably gone or ENOMEM. */
4065 pthread_mutex_lock(&ua_sess
->lock
);
4068 * We can iterate safely here over all UST app session since the create ust
4069 * app session above made a shadow copy of the UST global domain from the
4072 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4075 * For a metadata channel, handle it differently.
4077 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4078 sizeof(ua_chan
->name
))) {
4079 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4084 /* Remove it from the hash table and continue!. */
4085 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4087 delete_ust_app_channel(-1, ua_chan
, app
);
4090 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4093 * Stop everything. On error, the application failed, no more
4094 * file descriptor are available or ENOMEM so stopping here is
4095 * the only thing we can do for now.
4101 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
4103 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4110 /* For each events */
4111 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4113 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4120 pthread_mutex_unlock(&ua_sess
->lock
);
4122 if (usess
->start_trace
) {
4123 ret
= ust_app_start_trace(usess
, app
);
4128 DBG2("UST trace started for app pid %d", app
->pid
);
4131 /* Everything went well at this point. */
4136 pthread_mutex_unlock(&ua_sess
->lock
);
4139 destroy_app_session(app
, ua_sess
);
4146 * Add context to a specific channel for global UST domain.
4148 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4149 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4152 struct lttng_ht_node_str
*ua_chan_node
;
4153 struct lttng_ht_iter iter
, uiter
;
4154 struct ust_app_channel
*ua_chan
= NULL
;
4155 struct ust_app_session
*ua_sess
;
4156 struct ust_app
*app
;
4160 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4161 if (!app
->compatible
) {
4163 * TODO: In time, we should notice the caller of this error by
4164 * telling him that this is a version error.
4168 ua_sess
= lookup_session_by_app(usess
, app
);
4169 if (ua_sess
== NULL
) {
4173 pthread_mutex_lock(&ua_sess
->lock
);
4174 /* Lookup channel in the ust app session */
4175 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4176 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4177 if (ua_chan_node
== NULL
) {
4180 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4182 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4187 pthread_mutex_unlock(&ua_sess
->lock
);
4195 * Enable event for a channel from a UST session for a specific PID.
4197 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4198 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4201 struct lttng_ht_iter iter
;
4202 struct lttng_ht_node_str
*ua_chan_node
;
4203 struct ust_app
*app
;
4204 struct ust_app_session
*ua_sess
;
4205 struct ust_app_channel
*ua_chan
;
4206 struct ust_app_event
*ua_event
;
4208 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4212 app
= ust_app_find_by_pid(pid
);
4214 ERR("UST app enable event per PID %d not found", pid
);
4219 if (!app
->compatible
) {
4224 ua_sess
= lookup_session_by_app(usess
, app
);
4226 /* The application has problem or is probably dead. */
4231 pthread_mutex_lock(&ua_sess
->lock
);
4232 /* Lookup channel in the ust app session */
4233 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4234 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4235 /* If the channel is not found, there is a code flow error */
4236 assert(ua_chan_node
);
4238 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4240 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4241 uevent
->filter
, uevent
->attr
.loglevel
);
4242 if (ua_event
== NULL
) {
4243 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4248 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4255 pthread_mutex_unlock(&ua_sess
->lock
);
4262 * Disable event for a channel from a UST session for a specific PID.
4264 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4265 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4268 struct lttng_ht_iter iter
;
4269 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4270 struct ust_app
*app
;
4271 struct ust_app_session
*ua_sess
;
4272 struct ust_app_channel
*ua_chan
;
4273 struct ust_app_event
*ua_event
;
4275 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4279 app
= ust_app_find_by_pid(pid
);
4281 ERR("UST app disable event per PID %d not found", pid
);
4286 if (!app
->compatible
) {
4291 ua_sess
= lookup_session_by_app(usess
, app
);
4293 /* The application has problem or is probably dead. */
4297 /* Lookup channel in the ust app session */
4298 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4299 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4300 if (ua_chan_node
== NULL
) {
4301 /* Channel does not exist, skip disabling */
4304 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4306 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4307 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4308 if (ua_event_node
== NULL
) {
4309 /* Event does not exist, skip disabling */
4312 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4314 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4325 * Calibrate registered applications.
4327 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4330 struct lttng_ht_iter iter
;
4331 struct ust_app
*app
;
4335 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4336 if (!app
->compatible
) {
4338 * TODO: In time, we should notice the caller of this error by
4339 * telling him that this is a version error.
4344 health_code_update();
4346 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4350 /* Means that it's not implemented on the tracer side. */
4354 DBG2("Calibrate app PID %d returned with error %d",
4361 DBG("UST app global domain calibration finished");
4365 health_code_update();
4371 * Receive registration and populate the given msg structure.
4373 * On success return 0 else a negative value returned by the ustctl call.
4375 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4378 uint32_t pid
, ppid
, uid
, gid
;
4382 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4383 &pid
, &ppid
, &uid
, &gid
,
4384 &msg
->bits_per_long
,
4385 &msg
->uint8_t_alignment
,
4386 &msg
->uint16_t_alignment
,
4387 &msg
->uint32_t_alignment
,
4388 &msg
->uint64_t_alignment
,
4389 &msg
->long_alignment
,
4396 case LTTNG_UST_ERR_EXITING
:
4397 DBG3("UST app recv reg message failed. Application died");
4399 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4400 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4401 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4402 LTTNG_UST_ABI_MINOR_VERSION
);
4405 ERR("UST app recv reg message failed with ret %d", ret
);
4410 msg
->pid
= (pid_t
) pid
;
4411 msg
->ppid
= (pid_t
) ppid
;
4412 msg
->uid
= (uid_t
) uid
;
4413 msg
->gid
= (gid_t
) gid
;
4420 * Return a ust app channel object using the application object and the channel
4421 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4422 * lock MUST be acquired before calling this function.
4424 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4427 struct lttng_ht_node_ulong
*node
;
4428 struct lttng_ht_iter iter
;
4429 struct ust_app_channel
*ua_chan
= NULL
;
4433 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4434 node
= lttng_ht_iter_get_node_ulong(&iter
);
4436 DBG2("UST app channel find by objd %d not found", objd
);
4440 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4447 * Reply to a register channel notification from an application on the notify
4448 * socket. The channel metadata is also created.
4450 * The session UST registry lock is acquired in this function.
4452 * On success 0 is returned else a negative value.
4454 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4455 size_t nr_fields
, struct ustctl_field
*fields
)
4457 int ret
, ret_code
= 0;
4458 uint32_t chan_id
, reg_count
;
4459 uint64_t chan_reg_key
;
4460 enum ustctl_channel_header type
;
4461 struct ust_app
*app
;
4462 struct ust_app_channel
*ua_chan
;
4463 struct ust_app_session
*ua_sess
;
4464 struct ust_registry_session
*registry
;
4465 struct ust_registry_channel
*chan_reg
;
4469 /* Lookup application. If not found, there is a code flow error. */
4470 app
= find_app_by_notify_sock(sock
);
4472 DBG("Application socket %d is being teardown. Abort event notify",
4475 goto error_rcu_unlock
;
4478 /* Lookup channel by UST object descriptor. Should always be found. */
4479 ua_chan
= find_channel_by_objd(app
, cobjd
);
4481 assert(ua_chan
->session
);
4482 ua_sess
= ua_chan
->session
;
4484 /* Get right session registry depending on the session buffer type. */
4485 registry
= get_session_registry(ua_sess
);
4488 /* Depending on the buffer type, a different channel key is used. */
4489 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4490 chan_reg_key
= ua_chan
->tracing_channel_id
;
4492 chan_reg_key
= ua_chan
->key
;
4495 pthread_mutex_lock(®istry
->lock
);
4497 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4500 if (!chan_reg
->register_done
) {
4501 reg_count
= ust_registry_get_event_count(chan_reg
);
4502 if (reg_count
< 31) {
4503 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4505 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4508 chan_reg
->nr_ctx_fields
= nr_fields
;
4509 chan_reg
->ctx_fields
= fields
;
4510 chan_reg
->header_type
= type
;
4512 /* Get current already assigned values. */
4513 type
= chan_reg
->header_type
;
4515 /* Channel id is set during the object creation. */
4516 chan_id
= chan_reg
->chan_id
;
4518 /* Append to metadata */
4519 if (!chan_reg
->metadata_dumped
) {
4520 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4522 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4528 DBG3("UST app replying to register channel key %" PRIu64
4529 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4532 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4534 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4535 ERR("UST app reply channel failed with ret %d", ret
);
4537 DBG3("UST app reply channel failed. Application died");
4542 /* This channel registry registration is completed. */
4543 chan_reg
->register_done
= 1;
4546 pthread_mutex_unlock(®istry
->lock
);
4553 * Add event to the UST channel registry. When the event is added to the
4554 * registry, the metadata is also created. Once done, this replies to the
4555 * application with the appropriate error code.
4557 * The session UST registry lock is acquired in the function.
4559 * On success 0 is returned else a negative value.
4561 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4562 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4563 char *model_emf_uri
)
4566 uint32_t event_id
= 0;
4567 uint64_t chan_reg_key
;
4568 struct ust_app
*app
;
4569 struct ust_app_channel
*ua_chan
;
4570 struct ust_app_session
*ua_sess
;
4571 struct ust_registry_session
*registry
;
4575 /* Lookup application. If not found, there is a code flow error. */
4576 app
= find_app_by_notify_sock(sock
);
4578 DBG("Application socket %d is being teardown. Abort event notify",
4581 goto error_rcu_unlock
;
4584 /* Lookup channel by UST object descriptor. Should always be found. */
4585 ua_chan
= find_channel_by_objd(app
, cobjd
);
4587 assert(ua_chan
->session
);
4588 ua_sess
= ua_chan
->session
;
4590 registry
= get_session_registry(ua_sess
);
4593 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4594 chan_reg_key
= ua_chan
->tracing_channel_id
;
4596 chan_reg_key
= ua_chan
->key
;
4599 pthread_mutex_lock(®istry
->lock
);
4601 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4602 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4603 model_emf_uri
, ua_sess
->buffer_type
, &event_id
);
4606 * The return value is returned to ustctl so in case of an error, the
4607 * application can be notified. In case of an error, it's important not to
4608 * return a negative error or else the application will get closed.
4610 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4612 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4613 ERR("UST app reply event failed with ret %d", ret
);
4615 DBG3("UST app reply event failed. Application died");
4618 * No need to wipe the create event since the application socket will
4619 * get close on error hence cleaning up everything by itself.
4624 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4628 pthread_mutex_unlock(®istry
->lock
);
4635 * Handle application notification through the given notify socket.
4637 * Return 0 on success or else a negative value.
4639 int ust_app_recv_notify(int sock
)
4642 enum ustctl_notify_cmd cmd
;
4644 DBG3("UST app receiving notify from sock %d", sock
);
4646 ret
= ustctl_recv_notify(sock
, &cmd
);
4648 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4649 ERR("UST app recv notify failed with ret %d", ret
);
4651 DBG3("UST app recv notify failed. Application died");
4657 case USTCTL_NOTIFY_CMD_EVENT
:
4659 int sobjd
, cobjd
, loglevel
;
4660 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4662 struct ustctl_field
*fields
;
4664 DBG2("UST app ustctl register event received");
4666 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4667 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4669 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4670 ERR("UST app recv event failed with ret %d", ret
);
4672 DBG3("UST app recv event failed. Application died");
4677 /* Add event to the UST registry coming from the notify socket. */
4678 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4679 fields
, loglevel
, model_emf_uri
);
4686 case USTCTL_NOTIFY_CMD_CHANNEL
:
4690 struct ustctl_field
*fields
;
4692 DBG2("UST app ustctl register channel received");
4694 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4697 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4698 ERR("UST app recv channel failed with ret %d", ret
);
4700 DBG3("UST app recv channel failed. Application died");
4705 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4714 /* Should NEVER happen. */
4723 * Once the notify socket hangs up, this is called. First, it tries to find the
4724 * corresponding application. On failure, the call_rcu to close the socket is
4725 * executed. If an application is found, it tries to delete it from the notify
4726 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4728 * Note that an object needs to be allocated here so on ENOMEM failure, the
4729 * call RCU is not done but the rest of the cleanup is.
4731 void ust_app_notify_sock_unregister(int sock
)
4734 struct lttng_ht_iter iter
;
4735 struct ust_app
*app
;
4736 struct ust_app_notify_sock_obj
*obj
;
4742 obj
= zmalloc(sizeof(*obj
));
4745 * An ENOMEM is kind of uncool. If this strikes we continue the
4746 * procedure but the call_rcu will not be called. In this case, we
4747 * accept the fd leak rather than possibly creating an unsynchronized
4748 * state between threads.
4750 * TODO: The notify object should be created once the notify socket is
4751 * registered and stored independantely from the ust app object. The
4752 * tricky part is to synchronize the teardown of the application and
4753 * this notify object. Let's keep that in mind so we can avoid this
4754 * kind of shenanigans with ENOMEM in the teardown path.
4761 DBG("UST app notify socket unregister %d", sock
);
4764 * Lookup application by notify socket. If this fails, this means that the
4765 * hash table delete has already been done by the application
4766 * unregistration process so we can safely close the notify socket in a
4769 app
= find_app_by_notify_sock(sock
);
4774 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4777 * Whatever happens here either we fail or succeed, in both cases we have
4778 * to close the socket after a grace period to continue to the call RCU
4779 * here. If the deletion is successful, the application is not visible
4780 * anymore by other threads and is it fails it means that it was already
4781 * deleted from the hash table so either way we just have to close the
4784 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4790 * Close socket after a grace period to avoid for the socket to be reused
4791 * before the application object is freed creating potential race between
4792 * threads trying to add unique in the global hash table.
4795 call_rcu(&obj
->head
, close_notify_sock_rcu
);