2 * Copyright (C) 2011 David Goulet <david.goulet@polymtl.ca>
3 * Copyright (C) 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
5 * SPDX-License-Identifier: GPL-2.0-only
16 #include <sys/types.h>
18 #include <urcu/compiler.h>
21 #include <common/bytecode/bytecode.h>
22 #include <common/compat/errno.h>
23 #include <common/common.h>
24 #include <common/hashtable/utils.h>
25 #include <lttng/event-rule/event-rule.h>
26 #include <lttng/event-rule/event-rule-internal.h>
27 #include <lttng/event-rule/tracepoint.h>
28 #include <lttng/condition/condition.h>
29 #include <lttng/condition/event-rule-internal.h>
30 #include <lttng/condition/event-rule.h>
31 #include <common/sessiond-comm/sessiond-comm.h>
33 #include "buffer-registry.h"
35 #include "health-sessiond.h"
37 #include "ust-consumer.h"
38 #include "lttng-ust-ctl.h"
39 #include "lttng-ust-error.h"
42 #include "lttng-sessiond.h"
43 #include "notification-thread-commands.h"
47 struct lttng_ht
*ust_app_ht
;
48 struct lttng_ht
*ust_app_ht_by_sock
;
49 struct lttng_ht
*ust_app_ht_by_notify_sock
;
52 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
54 /* Next available channel key. Access under next_channel_key_lock. */
55 static uint64_t _next_channel_key
;
56 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
58 /* Next available session ID. Access under next_session_id_lock. */
59 static uint64_t _next_session_id
;
60 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
63 * Return the incremented value of next_channel_key.
65 static uint64_t get_next_channel_key(void)
69 pthread_mutex_lock(&next_channel_key_lock
);
70 ret
= ++_next_channel_key
;
71 pthread_mutex_unlock(&next_channel_key_lock
);
76 * Return the atomically incremented value of next_session_id.
78 static uint64_t get_next_session_id(void)
82 pthread_mutex_lock(&next_session_id_lock
);
83 ret
= ++_next_session_id
;
84 pthread_mutex_unlock(&next_session_id_lock
);
88 static void copy_channel_attr_to_ustctl(
89 struct ustctl_consumer_channel_attr
*attr
,
90 struct lttng_ust_channel_attr
*uattr
)
92 /* Copy event attributes since the layout is different. */
93 attr
->subbuf_size
= uattr
->subbuf_size
;
94 attr
->num_subbuf
= uattr
->num_subbuf
;
95 attr
->overwrite
= uattr
->overwrite
;
96 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
97 attr
->read_timer_interval
= uattr
->read_timer_interval
;
98 attr
->output
= uattr
->output
;
99 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
103 * Match function for the hash table lookup.
105 * It matches an ust app event based on three attributes which are the event
106 * name, the filter bytecode and the loglevel.
108 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
110 struct ust_app_event
*event
;
111 const struct ust_app_ht_key
*key
;
112 int ev_loglevel_value
;
117 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
119 ev_loglevel_value
= event
->attr
.loglevel
;
121 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
124 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
128 /* Event loglevel. */
129 if (ev_loglevel_value
!= key
->loglevel_type
) {
130 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
131 && key
->loglevel_type
== 0 &&
132 ev_loglevel_value
== -1) {
134 * Match is accepted. This is because on event creation, the
135 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
136 * -1 are accepted for this loglevel type since 0 is the one set by
137 * the API when receiving an enable event.
144 /* One of the filters is NULL, fail. */
145 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
149 if (key
->filter
&& event
->filter
) {
150 /* Both filters exists, check length followed by the bytecode. */
151 if (event
->filter
->len
!= key
->filter
->len
||
152 memcmp(event
->filter
->data
, key
->filter
->data
,
153 event
->filter
->len
) != 0) {
158 /* One of the exclusions is NULL, fail. */
159 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
163 if (key
->exclusion
&& event
->exclusion
) {
164 /* Both exclusions exists, check count followed by the names. */
165 if (event
->exclusion
->count
!= key
->exclusion
->count
||
166 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
167 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
181 * Unique add of an ust app event in the given ht. This uses the custom
182 * ht_match_ust_app_event match function and the event name as hash.
184 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
185 struct ust_app_event
*event
)
187 struct cds_lfht_node
*node_ptr
;
188 struct ust_app_ht_key key
;
192 assert(ua_chan
->events
);
195 ht
= ua_chan
->events
;
196 key
.name
= event
->attr
.name
;
197 key
.filter
= event
->filter
;
198 key
.loglevel_type
= event
->attr
.loglevel
;
199 key
.exclusion
= event
->exclusion
;
201 node_ptr
= cds_lfht_add_unique(ht
->ht
,
202 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
203 ht_match_ust_app_event
, &key
, &event
->node
.node
);
204 assert(node_ptr
== &event
->node
.node
);
208 * Close the notify socket from the given RCU head object. This MUST be called
209 * through a call_rcu().
211 static void close_notify_sock_rcu(struct rcu_head
*head
)
214 struct ust_app_notify_sock_obj
*obj
=
215 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
217 /* Must have a valid fd here. */
218 assert(obj
->fd
>= 0);
220 ret
= close(obj
->fd
);
222 ERR("close notify sock %d RCU", obj
->fd
);
224 lttng_fd_put(LTTNG_FD_APPS
, 1);
230 * Return the session registry according to the buffer type of the given
233 * A registry per UID object MUST exists before calling this function or else
234 * it assert() if not found. RCU read side lock must be acquired.
236 static struct ust_registry_session
*get_session_registry(
237 struct ust_app_session
*ua_sess
)
239 struct ust_registry_session
*registry
= NULL
;
243 switch (ua_sess
->buffer_type
) {
244 case LTTNG_BUFFER_PER_PID
:
246 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
250 registry
= reg_pid
->registry
->reg
.ust
;
253 case LTTNG_BUFFER_PER_UID
:
255 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
256 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
257 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
261 registry
= reg_uid
->registry
->reg
.ust
;
273 * Delete ust context safely. RCU read lock must be held before calling
277 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
285 pthread_mutex_lock(&app
->sock_lock
);
286 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
287 pthread_mutex_unlock(&app
->sock_lock
);
288 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
289 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
290 sock
, ua_ctx
->obj
->handle
, ret
);
298 * Delete ust app event safely. RCU read lock must be held before calling
302 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
309 free(ua_event
->filter
);
310 if (ua_event
->exclusion
!= NULL
)
311 free(ua_event
->exclusion
);
312 if (ua_event
->obj
!= NULL
) {
313 pthread_mutex_lock(&app
->sock_lock
);
314 ret
= ustctl_release_object(sock
, ua_event
->obj
);
315 pthread_mutex_unlock(&app
->sock_lock
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release event obj failed with ret %d",
326 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
327 * through a call_rcu().
330 void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
332 struct ust_app_event_notifier_rule
*obj
= caa_container_of(
333 head
, struct ust_app_event_notifier_rule
, rcu_head
);
339 * Delete ust app event notifier rule safely.
341 static void delete_ust_app_event_notifier_rule(int sock
,
342 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
,
347 assert(ua_event_notifier_rule
);
349 if (ua_event_notifier_rule
->exclusion
!= NULL
) {
350 free(ua_event_notifier_rule
->exclusion
);
353 if (ua_event_notifier_rule
->obj
!= NULL
) {
354 pthread_mutex_lock(&app
->sock_lock
);
355 ret
= ustctl_release_object(sock
, ua_event_notifier_rule
->obj
);
356 pthread_mutex_unlock(&app
->sock_lock
);
357 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
358 ERR("Failed to release event notifier object: app = '%s' (ppid %d), ret = %d",
359 app
->name
, (int) app
->ppid
, ret
);
362 free(ua_event_notifier_rule
->obj
);
365 lttng_event_rule_put(ua_event_notifier_rule
->event_rule
);
366 call_rcu(&ua_event_notifier_rule
->rcu_head
,
367 free_ust_app_event_notifier_rule_rcu
);
371 * Release ust data object of the given stream.
373 * Return 0 on success or else a negative value.
375 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
383 pthread_mutex_lock(&app
->sock_lock
);
384 ret
= ustctl_release_object(sock
, stream
->obj
);
385 pthread_mutex_unlock(&app
->sock_lock
);
386 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
387 ERR("UST app sock %d release stream obj failed with ret %d",
390 lttng_fd_put(LTTNG_FD_APPS
, 2);
398 * Delete ust app stream safely. RCU read lock must be held before calling
402 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
407 (void) release_ust_app_stream(sock
, stream
, app
);
412 * We need to execute ht_destroy outside of RCU read-side critical
413 * section and outside of call_rcu thread, so we postpone its execution
414 * using ht_cleanup_push. It is simpler than to change the semantic of
415 * the many callers of delete_ust_app_session().
418 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
420 struct ust_app_channel
*ua_chan
=
421 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
423 ht_cleanup_push(ua_chan
->ctx
);
424 ht_cleanup_push(ua_chan
->events
);
429 * Extract the lost packet or discarded events counter when the channel is
430 * being deleted and store the value in the parent channel so we can
431 * access it from lttng list and at stop/destroy.
433 * The session list lock must be held by the caller.
436 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
438 uint64_t discarded
= 0, lost
= 0;
439 struct ltt_session
*session
;
440 struct ltt_ust_channel
*uchan
;
442 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
447 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
448 if (!session
|| !session
->ust_session
) {
450 * Not finding the session is not an error because there are
451 * multiple ways the channels can be torn down.
453 * 1) The session daemon can initiate the destruction of the
454 * ust app session after receiving a destroy command or
455 * during its shutdown/teardown.
456 * 2) The application, since we are in per-pid tracing, is
457 * unregistering and tearing down its ust app session.
459 * Both paths are protected by the session list lock which
460 * ensures that the accounting of lost packets and discarded
461 * events is done exactly once. The session is then unpublished
462 * from the session list, resulting in this condition.
467 if (ua_chan
->attr
.overwrite
) {
468 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
469 ua_chan
->key
, session
->ust_session
->consumer
,
472 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
473 ua_chan
->key
, session
->ust_session
->consumer
,
476 uchan
= trace_ust_find_channel_by_name(
477 session
->ust_session
->domain_global
.channels
,
480 ERR("Missing UST channel to store discarded counters");
484 uchan
->per_pid_closed_app_discarded
+= discarded
;
485 uchan
->per_pid_closed_app_lost
+= lost
;
490 session_put(session
);
495 * Delete ust app channel safely. RCU read lock must be held before calling
498 * The session list lock must be held by the caller.
501 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
505 struct lttng_ht_iter iter
;
506 struct ust_app_event
*ua_event
;
507 struct ust_app_ctx
*ua_ctx
;
508 struct ust_app_stream
*stream
, *stmp
;
509 struct ust_registry_session
*registry
;
513 DBG3("UST app deleting channel %s", ua_chan
->name
);
516 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
517 cds_list_del(&stream
->list
);
518 delete_ust_app_stream(sock
, stream
, app
);
522 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
523 cds_list_del(&ua_ctx
->list
);
524 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
526 delete_ust_app_ctx(sock
, ua_ctx
, app
);
530 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
532 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
534 delete_ust_app_event(sock
, ua_event
, app
);
537 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
538 /* Wipe and free registry from session registry. */
539 registry
= get_session_registry(ua_chan
->session
);
541 ust_registry_channel_del_free(registry
, ua_chan
->key
,
545 * A negative socket can be used by the caller when
546 * cleaning-up a ua_chan in an error path. Skip the
547 * accounting in this case.
550 save_per_pid_lost_discarded_counters(ua_chan
);
554 if (ua_chan
->obj
!= NULL
) {
555 /* Remove channel from application UST object descriptor. */
556 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
557 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
559 pthread_mutex_lock(&app
->sock_lock
);
560 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
561 pthread_mutex_unlock(&app
->sock_lock
);
562 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
563 ERR("UST app sock %d release channel obj failed with ret %d",
566 lttng_fd_put(LTTNG_FD_APPS
, 1);
569 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
572 int ust_app_register_done(struct ust_app
*app
)
576 pthread_mutex_lock(&app
->sock_lock
);
577 ret
= ustctl_register_done(app
->sock
);
578 pthread_mutex_unlock(&app
->sock_lock
);
582 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
587 pthread_mutex_lock(&app
->sock_lock
);
592 ret
= ustctl_release_object(sock
, data
);
594 pthread_mutex_unlock(&app
->sock_lock
);
600 * Push metadata to consumer socket.
602 * RCU read-side lock must be held to guarantee existance of socket.
603 * Must be called with the ust app session lock held.
604 * Must be called with the registry lock held.
606 * On success, return the len of metadata pushed or else a negative value.
607 * Returning a -EPIPE return value means we could not send the metadata,
608 * but it can be caused by recoverable errors (e.g. the application has
609 * terminated concurrently).
611 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
612 struct consumer_socket
*socket
, int send_zero_data
)
615 char *metadata_str
= NULL
;
616 size_t len
, offset
, new_metadata_len_sent
;
618 uint64_t metadata_key
, metadata_version
;
623 metadata_key
= registry
->metadata_key
;
626 * Means that no metadata was assigned to the session. This can
627 * happens if no start has been done previously.
633 offset
= registry
->metadata_len_sent
;
634 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
635 new_metadata_len_sent
= registry
->metadata_len
;
636 metadata_version
= registry
->metadata_version
;
638 DBG3("No metadata to push for metadata key %" PRIu64
,
639 registry
->metadata_key
);
641 if (send_zero_data
) {
642 DBG("No metadata to push");
648 /* Allocate only what we have to send. */
649 metadata_str
= zmalloc(len
);
651 PERROR("zmalloc ust app metadata string");
655 /* Copy what we haven't sent out. */
656 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
659 pthread_mutex_unlock(®istry
->lock
);
661 * We need to unlock the registry while we push metadata to
662 * break a circular dependency between the consumerd metadata
663 * lock and the sessiond registry lock. Indeed, pushing metadata
664 * to the consumerd awaits that it gets pushed all the way to
665 * relayd, but doing so requires grabbing the metadata lock. If
666 * a concurrent metadata request is being performed by
667 * consumerd, this can try to grab the registry lock on the
668 * sessiond while holding the metadata lock on the consumer
669 * daemon. Those push and pull schemes are performed on two
670 * different bidirectionnal communication sockets.
672 ret
= consumer_push_metadata(socket
, metadata_key
,
673 metadata_str
, len
, offset
, metadata_version
);
674 pthread_mutex_lock(®istry
->lock
);
677 * There is an acceptable race here between the registry
678 * metadata key assignment and the creation on the
679 * consumer. The session daemon can concurrently push
680 * metadata for this registry while being created on the
681 * consumer since the metadata key of the registry is
682 * assigned *before* it is setup to avoid the consumer
683 * to ask for metadata that could possibly be not found
684 * in the session daemon.
686 * The metadata will get pushed either by the session
687 * being stopped or the consumer requesting metadata if
688 * that race is triggered.
690 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
693 ERR("Error pushing metadata to consumer");
699 * Metadata may have been concurrently pushed, since
700 * we're not holding the registry lock while pushing to
701 * consumer. This is handled by the fact that we send
702 * the metadata content, size, and the offset at which
703 * that metadata belongs. This may arrive out of order
704 * on the consumer side, and the consumer is able to
705 * deal with overlapping fragments. The consumer
706 * supports overlapping fragments, which must be
707 * contiguous starting from offset 0. We keep the
708 * largest metadata_len_sent value of the concurrent
711 registry
->metadata_len_sent
=
712 max_t(size_t, registry
->metadata_len_sent
,
713 new_metadata_len_sent
);
722 * On error, flag the registry that the metadata is
723 * closed. We were unable to push anything and this
724 * means that either the consumer is not responding or
725 * the metadata cache has been destroyed on the
728 registry
->metadata_closed
= 1;
736 * For a given application and session, push metadata to consumer.
737 * Either sock or consumer is required : if sock is NULL, the default
738 * socket to send the metadata is retrieved from consumer, if sock
739 * is not NULL we use it to send the metadata.
740 * RCU read-side lock must be held while calling this function,
741 * therefore ensuring existance of registry. It also ensures existance
742 * of socket throughout this function.
744 * Return 0 on success else a negative error.
745 * Returning a -EPIPE return value means we could not send the metadata,
746 * but it can be caused by recoverable errors (e.g. the application has
747 * terminated concurrently).
749 static int push_metadata(struct ust_registry_session
*registry
,
750 struct consumer_output
*consumer
)
754 struct consumer_socket
*socket
;
759 pthread_mutex_lock(®istry
->lock
);
760 if (registry
->metadata_closed
) {
765 /* Get consumer socket to use to push the metadata.*/
766 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
773 ret
= ust_app_push_metadata(registry
, socket
, 0);
778 pthread_mutex_unlock(®istry
->lock
);
782 pthread_mutex_unlock(®istry
->lock
);
787 * Send to the consumer a close metadata command for the given session. Once
788 * done, the metadata channel is deleted and the session metadata pointer is
789 * nullified. The session lock MUST be held unless the application is
790 * in the destroy path.
792 * Do not hold the registry lock while communicating with the consumerd, because
793 * doing so causes inter-process deadlocks between consumerd and sessiond with
794 * the metadata request notification.
796 * Return 0 on success else a negative value.
798 static int close_metadata(struct ust_registry_session
*registry
,
799 struct consumer_output
*consumer
)
802 struct consumer_socket
*socket
;
803 uint64_t metadata_key
;
804 bool registry_was_already_closed
;
811 pthread_mutex_lock(®istry
->lock
);
812 metadata_key
= registry
->metadata_key
;
813 registry_was_already_closed
= registry
->metadata_closed
;
814 if (metadata_key
!= 0) {
816 * Metadata closed. Even on error this means that the consumer
817 * is not responding or not found so either way a second close
818 * should NOT be emit for this registry.
820 registry
->metadata_closed
= 1;
822 pthread_mutex_unlock(®istry
->lock
);
824 if (metadata_key
== 0 || registry_was_already_closed
) {
829 /* Get consumer socket to use to push the metadata.*/
830 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
837 ret
= consumer_close_metadata(socket
, metadata_key
);
848 * We need to execute ht_destroy outside of RCU read-side critical
849 * section and outside of call_rcu thread, so we postpone its execution
850 * using ht_cleanup_push. It is simpler than to change the semantic of
851 * the many callers of delete_ust_app_session().
854 void delete_ust_app_session_rcu(struct rcu_head
*head
)
856 struct ust_app_session
*ua_sess
=
857 caa_container_of(head
, struct ust_app_session
, rcu_head
);
859 ht_cleanup_push(ua_sess
->channels
);
864 * Delete ust app session safely. RCU read lock must be held before calling
867 * The session list lock must be held by the caller.
870 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
874 struct lttng_ht_iter iter
;
875 struct ust_app_channel
*ua_chan
;
876 struct ust_registry_session
*registry
;
880 pthread_mutex_lock(&ua_sess
->lock
);
882 assert(!ua_sess
->deleted
);
883 ua_sess
->deleted
= true;
885 registry
= get_session_registry(ua_sess
);
886 /* Registry can be null on error path during initialization. */
888 /* Push metadata for application before freeing the application. */
889 (void) push_metadata(registry
, ua_sess
->consumer
);
892 * Don't ask to close metadata for global per UID buffers. Close
893 * metadata only on destroy trace session in this case. Also, the
894 * previous push metadata could have flag the metadata registry to
895 * close so don't send a close command if closed.
897 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
898 /* And ask to close it for this session registry. */
899 (void) close_metadata(registry
, ua_sess
->consumer
);
903 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
905 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
907 delete_ust_app_channel(sock
, ua_chan
, app
);
910 /* In case of per PID, the registry is kept in the session. */
911 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
912 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
915 * Registry can be null on error path during
918 buffer_reg_pid_remove(reg_pid
);
919 buffer_reg_pid_destroy(reg_pid
);
923 if (ua_sess
->handle
!= -1) {
924 pthread_mutex_lock(&app
->sock_lock
);
925 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
926 pthread_mutex_unlock(&app
->sock_lock
);
927 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
928 ERR("UST app sock %d release session handle failed with ret %d",
931 /* Remove session from application UST object descriptor. */
932 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
933 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
937 pthread_mutex_unlock(&ua_sess
->lock
);
939 consumer_output_put(ua_sess
->consumer
);
941 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
945 * Delete a traceable application structure from the global list. Never call
946 * this function outside of a call_rcu call.
948 * RCU read side lock should _NOT_ be held when calling this function.
951 void delete_ust_app(struct ust_app
*app
)
954 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
955 struct lttng_ht_iter iter
;
956 struct ust_app_event_notifier_rule
*event_notifier_rule
;
957 bool event_notifier_write_fd_is_open
;
960 * The session list lock must be held during this function to guarantee
961 * the existence of ua_sess.
964 /* Delete ust app sessions info */
969 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
971 /* Free every object in the session and the session. */
973 delete_ust_app_session(sock
, ua_sess
, app
);
977 /* Remove the event notifier rules associated with this app. */
979 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
980 &iter
.iter
, event_notifier_rule
, node
.node
) {
981 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
984 delete_ust_app_event_notifier_rule(
985 app
->sock
, event_notifier_rule
, app
);
990 ht_cleanup_push(app
->sessions
);
991 ht_cleanup_push(app
->ust_sessions_objd
);
992 ht_cleanup_push(app
->ust_objd
);
993 ht_cleanup_push(app
->token_to_event_notifier_rule_ht
);
996 * This could be NULL if the event notifier setup failed (e.g the app
997 * was killed or the tracer does not support this feature).
999 if (app
->event_notifier_group
.object
) {
1000 enum lttng_error_code ret_code
;
1001 const int event_notifier_read_fd
= lttng_pipe_get_readfd(
1002 app
->event_notifier_group
.event_pipe
);
1004 ret_code
= notification_thread_command_remove_tracer_event_source(
1005 notification_thread_handle
,
1006 event_notifier_read_fd
);
1007 if (ret_code
!= LTTNG_OK
) {
1008 ERR("Failed to remove application tracer event source from notification thread");
1011 ustctl_release_object(sock
, app
->event_notifier_group
.object
);
1012 free(app
->event_notifier_group
.object
);
1015 event_notifier_write_fd_is_open
= lttng_pipe_is_write_open(
1016 app
->event_notifier_group
.event_pipe
);
1017 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1019 * Release the file descriptors reserved for the event notifier pipe.
1020 * The app could be destroyed before the write end of the pipe could be
1021 * passed to the application (and closed). In that case, both file
1022 * descriptors must be released.
1024 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1027 * Wait until we have deleted the application from the sock hash table
1028 * before closing this socket, otherwise an application could re-use the
1029 * socket ID and race with the teardown, using the same hash table entry.
1031 * It's OK to leave the close in call_rcu. We want it to stay unique for
1032 * all RCU readers that could run concurrently with unregister app,
1033 * therefore we _need_ to only close that socket after a grace period. So
1034 * it should stay in this RCU callback.
1036 * This close() is a very important step of the synchronization model so
1037 * every modification to this function must be carefully reviewed.
1043 lttng_fd_put(LTTNG_FD_APPS
, 1);
1045 DBG2("UST app pid %d deleted", app
->pid
);
1047 session_unlock_list();
1051 * URCU intermediate call to delete an UST app.
1054 void delete_ust_app_rcu(struct rcu_head
*head
)
1056 struct lttng_ht_node_ulong
*node
=
1057 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1058 struct ust_app
*app
=
1059 caa_container_of(node
, struct ust_app
, pid_n
);
1061 DBG3("Call RCU deleting app PID %d", app
->pid
);
1062 delete_ust_app(app
);
1066 * Delete the session from the application ht and delete the data structure by
1067 * freeing every object inside and releasing them.
1069 * The session list lock must be held by the caller.
1071 static void destroy_app_session(struct ust_app
*app
,
1072 struct ust_app_session
*ua_sess
)
1075 struct lttng_ht_iter iter
;
1080 iter
.iter
.node
= &ua_sess
->node
.node
;
1081 ret
= lttng_ht_del(app
->sessions
, &iter
);
1083 /* Already scheduled for teardown. */
1087 /* Once deleted, free the data structure. */
1088 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1095 * Alloc new UST app session.
1098 struct ust_app_session
*alloc_ust_app_session(void)
1100 struct ust_app_session
*ua_sess
;
1102 /* Init most of the default value by allocating and zeroing */
1103 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1104 if (ua_sess
== NULL
) {
1109 ua_sess
->handle
= -1;
1110 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1111 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1112 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1121 * Alloc new UST app channel.
1124 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1125 struct ust_app_session
*ua_sess
,
1126 struct lttng_ust_channel_attr
*attr
)
1128 struct ust_app_channel
*ua_chan
;
1130 /* Init most of the default value by allocating and zeroing */
1131 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1132 if (ua_chan
== NULL
) {
1137 /* Setup channel name */
1138 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1139 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1141 ua_chan
->enabled
= 1;
1142 ua_chan
->handle
= -1;
1143 ua_chan
->session
= ua_sess
;
1144 ua_chan
->key
= get_next_channel_key();
1145 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1146 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1147 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1149 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1150 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1152 /* Copy attributes */
1154 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1155 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1156 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1157 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1158 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1159 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1160 ua_chan
->attr
.output
= attr
->output
;
1161 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1163 /* By default, the channel is a per cpu channel. */
1164 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1166 DBG3("UST app channel %s allocated", ua_chan
->name
);
1175 * Allocate and initialize a UST app stream.
1177 * Return newly allocated stream pointer or NULL on error.
1179 struct ust_app_stream
*ust_app_alloc_stream(void)
1181 struct ust_app_stream
*stream
= NULL
;
1183 stream
= zmalloc(sizeof(*stream
));
1184 if (stream
== NULL
) {
1185 PERROR("zmalloc ust app stream");
1189 /* Zero could be a valid value for a handle so flag it to -1. */
1190 stream
->handle
= -1;
1197 * Alloc new UST app event.
1200 struct ust_app_event
*alloc_ust_app_event(char *name
,
1201 struct lttng_ust_event
*attr
)
1203 struct ust_app_event
*ua_event
;
1205 /* Init most of the default value by allocating and zeroing */
1206 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1207 if (ua_event
== NULL
) {
1208 PERROR("Failed to allocate ust_app_event structure");
1212 ua_event
->enabled
= 1;
1213 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1214 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1215 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1217 /* Copy attributes */
1219 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1222 DBG3("UST app event %s allocated", ua_event
->name
);
1231 * Allocate a new UST app event notifier rule.
1233 static struct ust_app_event_notifier_rule
*alloc_ust_app_event_notifier_rule(
1234 struct lttng_event_rule
*event_rule
, uint64_t token
)
1236 enum lttng_event_rule_generate_exclusions_status
1237 generate_exclusion_status
;
1238 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1240 ua_event_notifier_rule
= zmalloc(sizeof(struct ust_app_event_notifier_rule
));
1241 if (ua_event_notifier_rule
== NULL
) {
1242 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1246 ua_event_notifier_rule
->enabled
= 1;
1247 ua_event_notifier_rule
->token
= token
;
1248 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
, token
);
1250 /* Get reference of the event rule. */
1251 if (!lttng_event_rule_get(event_rule
)) {
1255 ua_event_notifier_rule
->event_rule
= event_rule
;
1256 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1257 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1258 event_rule
, &ua_event_notifier_rule
->exclusion
);
1259 switch (generate_exclusion_status
) {
1260 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1261 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1264 /* Error occured. */
1265 ERR("Failed to generate exclusions from event rule while allocating an event notifier rule");
1266 goto error_put_event_rule
;
1269 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1270 ua_event_notifier_rule
->token
);
1272 return ua_event_notifier_rule
;
1274 error_put_event_rule
:
1275 lttng_event_rule_put(event_rule
);
1277 free(ua_event_notifier_rule
);
1282 * Alloc new UST app context.
1285 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1287 struct ust_app_ctx
*ua_ctx
;
1289 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1290 if (ua_ctx
== NULL
) {
1294 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1297 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1298 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1299 char *provider_name
= NULL
, *ctx_name
= NULL
;
1301 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1302 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1303 if (!provider_name
|| !ctx_name
) {
1304 free(provider_name
);
1309 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1310 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1314 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1322 * Create a liblttng-ust filter bytecode from given bytecode.
1324 * Return allocated filter or NULL on error.
1326 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1327 const struct lttng_filter_bytecode
*orig_f
)
1329 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1331 /* Copy filter bytecode */
1332 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1334 PERROR("zmalloc alloc ust filter bytecode");
1338 assert(sizeof(struct lttng_filter_bytecode
) ==
1339 sizeof(struct lttng_ust_filter_bytecode
));
1340 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1346 * Find an ust_app using the sock and return it. RCU read side lock must be
1347 * held before calling this helper function.
1349 struct ust_app
*ust_app_find_by_sock(int sock
)
1351 struct lttng_ht_node_ulong
*node
;
1352 struct lttng_ht_iter iter
;
1354 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1355 node
= lttng_ht_iter_get_node_ulong(&iter
);
1357 DBG2("UST app find by sock %d not found", sock
);
1361 return caa_container_of(node
, struct ust_app
, sock_n
);
1368 * Find an ust_app using the notify sock and return it. RCU read side lock must
1369 * be held before calling this helper function.
1371 static struct ust_app
*find_app_by_notify_sock(int sock
)
1373 struct lttng_ht_node_ulong
*node
;
1374 struct lttng_ht_iter iter
;
1376 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1378 node
= lttng_ht_iter_get_node_ulong(&iter
);
1380 DBG2("UST app find by notify sock %d not found", sock
);
1384 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1391 * Lookup for an ust app event based on event name, filter bytecode and the
1394 * Return an ust_app_event object or NULL on error.
1396 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1397 const char *name
, const struct lttng_filter_bytecode
*filter
,
1399 const struct lttng_event_exclusion
*exclusion
)
1401 struct lttng_ht_iter iter
;
1402 struct lttng_ht_node_str
*node
;
1403 struct ust_app_event
*event
= NULL
;
1404 struct ust_app_ht_key key
;
1409 /* Setup key for event lookup. */
1411 key
.filter
= filter
;
1412 key
.loglevel_type
= loglevel_value
;
1413 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1414 key
.exclusion
= exclusion
;
1416 /* Lookup using the event name as hash and a custom match fct. */
1417 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1418 ht_match_ust_app_event
, &key
, &iter
.iter
);
1419 node
= lttng_ht_iter_get_node_str(&iter
);
1424 event
= caa_container_of(node
, struct ust_app_event
, node
);
1431 * Look-up an event notifier rule based on its token id.
1433 * Must be called with the RCU read lock held.
1434 * Return an ust_app_event_notifier_rule object or NULL on error.
1436 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1437 struct lttng_ht
*ht
, uint64_t token
)
1439 struct lttng_ht_iter iter
;
1440 struct lttng_ht_node_u64
*node
;
1441 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1445 lttng_ht_lookup(ht
, &token
, &iter
);
1446 node
= lttng_ht_iter_get_node_u64(&iter
);
1448 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1453 event_notifier_rule
= caa_container_of(
1454 node
, struct ust_app_event_notifier_rule
, node
);
1456 return event_notifier_rule
;
1460 * Create the channel context on the tracer.
1462 * Called with UST app session lock held.
1465 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1466 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1470 health_code_update();
1472 pthread_mutex_lock(&app
->sock_lock
);
1473 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1474 ua_chan
->obj
, &ua_ctx
->obj
);
1475 pthread_mutex_unlock(&app
->sock_lock
);
1477 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1478 ERR("UST app create channel context failed for app (pid: %d) "
1479 "with ret %d", app
->pid
, ret
);
1482 * This is normal behavior, an application can die during the
1483 * creation process. Don't report an error so the execution can
1484 * continue normally.
1487 DBG3("UST app add context failed. Application is dead.");
1492 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1494 DBG2("UST app context handle %d created successfully for channel %s",
1495 ua_ctx
->handle
, ua_chan
->name
);
1498 health_code_update();
1503 * Set the filter on the tracer.
1505 static int set_ust_object_filter(struct ust_app
*app
,
1506 const struct lttng_filter_bytecode
*bytecode
,
1507 struct lttng_ust_object_data
*ust_object
)
1510 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1512 health_code_update();
1514 ust_bytecode
= create_ust_bytecode_from_bytecode(bytecode
);
1515 if (!ust_bytecode
) {
1516 ret
= -LTTNG_ERR_NOMEM
;
1519 pthread_mutex_lock(&app
->sock_lock
);
1520 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1522 pthread_mutex_unlock(&app
->sock_lock
);
1524 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1525 ERR("UST app set object filter failed for object %p of app (pid: %d) "
1526 "with ret %d", ust_object
, app
->pid
, ret
);
1529 * This is normal behavior, an application can die during the
1530 * creation process. Don't report an error so the execution can
1531 * continue normally.
1534 DBG3("Failed to set UST app object filter. Application is dead.");
1539 DBG2("UST filter successfully set for object %p", ust_object
);
1542 health_code_update();
1548 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1549 const struct lttng_event_exclusion
*exclusion
)
1551 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1552 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1553 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1555 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1556 if (!ust_exclusion
) {
1561 assert(sizeof(struct lttng_event_exclusion
) ==
1562 sizeof(struct lttng_ust_event_exclusion
));
1563 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1565 return ust_exclusion
;
1569 * Set event exclusions on the tracer.
1571 static int set_ust_object_exclusions(struct ust_app
*app
,
1572 const struct lttng_event_exclusion
*exclusions
,
1573 struct lttng_ust_object_data
*ust_object
)
1576 struct lttng_ust_event_exclusion
*ust_exclusions
= NULL
;
1578 assert(exclusions
&& exclusions
->count
> 0);
1580 health_code_update();
1582 ust_exclusions
= create_ust_exclusion_from_exclusion(
1584 if (!ust_exclusions
) {
1585 ret
= -LTTNG_ERR_NOMEM
;
1588 pthread_mutex_lock(&app
->sock_lock
);
1589 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1590 pthread_mutex_unlock(&app
->sock_lock
);
1592 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1593 ERR("Failed to set UST app exclusions for object %p of app (pid: %d) "
1594 "with ret %d", ust_object
, app
->pid
, ret
);
1597 * This is normal behavior, an application can die during the
1598 * creation process. Don't report an error so the execution can
1599 * continue normally.
1602 DBG3("Failed to set UST app object exclusions. Application is dead.");
1607 DBG2("UST exclusions set successfully for object %p", ust_object
);
1610 health_code_update();
1611 free(ust_exclusions
);
1616 * Disable the specified event on to UST tracer for the UST session.
1618 static int disable_ust_object(struct ust_app
*app
,
1619 struct lttng_ust_object_data
*object
)
1623 health_code_update();
1625 pthread_mutex_lock(&app
->sock_lock
);
1626 ret
= ustctl_disable(app
->sock
, object
);
1627 pthread_mutex_unlock(&app
->sock_lock
);
1629 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1630 ERR("Failed to disable UST app object %p app (pid: %d) with ret %d",
1631 object
, app
->pid
, ret
);
1634 * This is normal behavior, an application can die during the
1635 * creation process. Don't report an error so the execution can
1636 * continue normally.
1639 DBG3("Failed to disable UST app object. Application is dead.");
1644 DBG2("UST app object %p disabled successfully for app (pid: %d)",
1648 health_code_update();
1653 * Disable the specified channel on to UST tracer for the UST session.
1655 static int disable_ust_channel(struct ust_app
*app
,
1656 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1660 health_code_update();
1662 pthread_mutex_lock(&app
->sock_lock
);
1663 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1664 pthread_mutex_unlock(&app
->sock_lock
);
1666 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1667 ERR("UST app channel %s disable failed for app (pid: %d) "
1668 "and session handle %d with ret %d",
1669 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1672 * This is normal behavior, an application can die during the
1673 * creation process. Don't report an error so the execution can
1674 * continue normally.
1677 DBG3("UST app disable channel failed. Application is dead.");
1682 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1683 ua_chan
->name
, app
->pid
);
1686 health_code_update();
1691 * Enable the specified channel on to UST tracer for the UST session.
1693 static int enable_ust_channel(struct ust_app
*app
,
1694 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1698 health_code_update();
1700 pthread_mutex_lock(&app
->sock_lock
);
1701 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1702 pthread_mutex_unlock(&app
->sock_lock
);
1704 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1705 ERR("UST app channel %s enable failed for app (pid: %d) "
1706 "and session handle %d with ret %d",
1707 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1710 * This is normal behavior, an application can die during the
1711 * creation process. Don't report an error so the execution can
1712 * continue normally.
1715 DBG3("UST app enable channel failed. Application is dead.");
1720 ua_chan
->enabled
= 1;
1722 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1723 ua_chan
->name
, app
->pid
);
1726 health_code_update();
1731 * Enable the specified event on to UST tracer for the UST session.
1733 static int enable_ust_object(
1734 struct ust_app
*app
, struct lttng_ust_object_data
*ust_object
)
1738 health_code_update();
1740 pthread_mutex_lock(&app
->sock_lock
);
1741 ret
= ustctl_enable(app
->sock
, ust_object
);
1742 pthread_mutex_unlock(&app
->sock_lock
);
1744 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1745 ERR("UST app enable failed for object %p app (pid: %d) with ret %d",
1746 ust_object
, app
->pid
, ret
);
1749 * This is normal behavior, an application can die during the
1750 * creation process. Don't report an error so the execution can
1751 * continue normally.
1754 DBG3("Failed to enable UST app object. Application is dead.");
1759 DBG2("UST app object %p enabled successfully for app (pid: %d)",
1760 ust_object
, app
->pid
);
1763 health_code_update();
1768 * Send channel and stream buffer to application.
1770 * Return 0 on success. On error, a negative value is returned.
1772 static int send_channel_pid_to_ust(struct ust_app
*app
,
1773 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1776 struct ust_app_stream
*stream
, *stmp
;
1782 health_code_update();
1784 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1787 /* Send channel to the application. */
1788 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1789 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1790 ret
= -ENOTCONN
; /* Caused by app exiting. */
1792 } else if (ret
< 0) {
1796 health_code_update();
1798 /* Send all streams to application. */
1799 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1800 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1801 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1802 ret
= -ENOTCONN
; /* Caused by app exiting. */
1804 } else if (ret
< 0) {
1807 /* We don't need the stream anymore once sent to the tracer. */
1808 cds_list_del(&stream
->list
);
1809 delete_ust_app_stream(-1, stream
, app
);
1811 /* Flag the channel that it is sent to the application. */
1812 ua_chan
->is_sent
= 1;
1815 health_code_update();
1820 * Create the specified event onto the UST tracer for a UST session.
1822 * Should be called with session mutex held.
1825 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1826 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1830 health_code_update();
1832 /* Create UST event on tracer */
1833 pthread_mutex_lock(&app
->sock_lock
);
1834 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1836 pthread_mutex_unlock(&app
->sock_lock
);
1838 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1840 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1841 ua_event
->attr
.name
, app
->pid
, ret
);
1844 * This is normal behavior, an application can die during the
1845 * creation process. Don't report an error so the execution can
1846 * continue normally.
1849 DBG3("UST app create event failed. Application is dead.");
1854 ua_event
->handle
= ua_event
->obj
->handle
;
1856 DBG2("UST app event %s created successfully for pid:%d object: %p",
1857 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
1859 health_code_update();
1861 /* Set filter if one is present. */
1862 if (ua_event
->filter
) {
1863 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
1869 /* Set exclusions for the event */
1870 if (ua_event
->exclusion
) {
1871 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
1877 /* If event not enabled, disable it on the tracer */
1878 if (ua_event
->enabled
) {
1880 * We now need to explicitly enable the event, since it
1881 * is now disabled at creation.
1883 ret
= enable_ust_object(app
, ua_event
->obj
);
1886 * If we hit an EPERM, something is wrong with our enable call. If
1887 * we get an EEXIST, there is a problem on the tracer side since we
1891 case -LTTNG_UST_ERR_PERM
:
1892 /* Code flow problem */
1894 case -LTTNG_UST_ERR_EXIST
:
1895 /* It's OK for our use case. */
1906 health_code_update();
1910 static int init_ust_event_notifier_from_event_rule(
1911 const struct lttng_event_rule
*rule
,
1912 struct lttng_ust_event_notifier
*event_notifier
)
1914 enum lttng_event_rule_status status
;
1915 enum lttng_loglevel_type loglevel_type
;
1916 enum lttng_ust_loglevel_type ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1917 int loglevel
= -1, ret
= 0;
1918 const char *pattern
;
1920 /* For now only LTTNG_EVENT_RULE_TYPE_TRACEPOINT are supported. */
1921 assert(lttng_event_rule_get_type(rule
) ==
1922 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
1924 memset(event_notifier
, 0, sizeof(*event_notifier
));
1926 if (lttng_event_rule_targets_agent_domain(rule
)) {
1928 * Special event for agents
1929 * The actual meat of the event is in the filter that will be
1930 * attached later on.
1931 * Set the default values for the agent event.
1933 pattern
= event_get_default_agent_ust_name(
1934 lttng_event_rule_get_domain_type(rule
));
1936 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1938 status
= lttng_event_rule_tracepoint_get_pattern(
1940 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1941 /* At this point, this is a fatal error. */
1945 status
= lttng_event_rule_tracepoint_get_log_level_type(
1946 rule
, &loglevel_type
);
1947 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1948 /* At this point, this is a fatal error. */
1952 switch (loglevel_type
) {
1953 case LTTNG_EVENT_LOGLEVEL_ALL
:
1954 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1956 case LTTNG_EVENT_LOGLEVEL_RANGE
:
1957 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
1959 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
1960 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
1963 /* Unknown log level specification type. */
1967 if (loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1968 status
= lttng_event_rule_tracepoint_get_log_level(
1970 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
1974 event_notifier
->event
.instrumentation
= LTTNG_UST_TRACEPOINT
;
1975 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
1976 LTTNG_UST_SYM_NAME_LEN
- 1);
1978 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
1983 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
1984 event_notifier
->event
.loglevel
= loglevel
;
1990 * Create the specified event notifier against the user space tracer of a
1991 * given application.
1993 static int create_ust_event_notifier(struct ust_app
*app
,
1994 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
1997 struct lttng_ust_event_notifier event_notifier
;
1999 health_code_update();
2000 assert(app
->event_notifier_group
.object
);
2002 ret
= init_ust_event_notifier_from_event_rule(
2003 ua_event_notifier_rule
->event_rule
, &event_notifier
);
2005 ERR("Failed to initialize UST event notifier from event rule: app = '%s' (ppid: %d)",
2006 app
->name
, app
->ppid
);
2010 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2012 /* Create UST event notifier against the tracer. */
2013 pthread_mutex_lock(&app
->sock_lock
);
2014 ret
= ustctl_create_event_notifier(app
->sock
, &event_notifier
,
2015 app
->event_notifier_group
.object
,
2016 &ua_event_notifier_rule
->obj
);
2017 pthread_mutex_unlock(&app
->sock_lock
);
2019 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2020 ERR("Error ustctl create event notifier: name = '%s', app = '%s' (ppid: %d), ret = %d",
2021 event_notifier
.event
.name
, app
->name
,
2025 * This is normal behavior, an application can die
2026 * during the creation process. Don't report an error so
2027 * the execution can continue normally.
2030 DBG3("UST app create event notifier failed (application is dead): app = '%s' (ppid = %d)",
2031 app
->name
, app
->ppid
);
2037 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2039 DBG2("UST app event notifier %s created successfully: app = '%s' (ppid: %d), object: %p",
2040 event_notifier
.event
.name
, app
->name
, app
->ppid
,
2041 ua_event_notifier_rule
->obj
);
2043 health_code_update();
2045 /* Set filter if one is present. */
2046 if (ua_event_notifier_rule
->filter
) {
2047 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2048 ua_event_notifier_rule
->obj
);
2054 /* Set exclusions for the event. */
2055 if (ua_event_notifier_rule
->exclusion
) {
2056 ret
= set_ust_object_exclusions(app
,
2057 ua_event_notifier_rule
->exclusion
,
2058 ua_event_notifier_rule
->obj
);
2065 * We now need to explicitly enable the event, since it
2066 * is disabled at creation.
2068 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2071 * If we hit an EPERM, something is wrong with our enable call.
2072 * If we get an EEXIST, there is a problem on the tracer side
2073 * since we just created it.
2076 case -LTTNG_UST_ERR_PERM
:
2077 /* Code flow problem. */
2079 case -LTTNG_UST_ERR_EXIST
:
2080 /* It's OK for our use case. */
2090 ua_event_notifier_rule
->enabled
= true;
2093 health_code_update();
2098 * Copy data between an UST app event and a LTT event.
2100 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2101 struct ltt_ust_event
*uevent
)
2103 size_t exclusion_alloc_size
;
2105 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2106 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2108 ua_event
->enabled
= uevent
->enabled
;
2110 /* Copy event attributes */
2111 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2113 /* Copy filter bytecode */
2114 if (uevent
->filter
) {
2115 ua_event
->filter
= lttng_filter_bytecode_copy(uevent
->filter
);
2116 /* Filter might be NULL here in case of ENONEM. */
2119 /* Copy exclusion data */
2120 if (uevent
->exclusion
) {
2121 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2122 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2123 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2124 if (ua_event
->exclusion
== NULL
) {
2127 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2128 exclusion_alloc_size
);
2134 * Copy data between an UST app channel and a LTT channel.
2136 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2137 struct ltt_ust_channel
*uchan
)
2139 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2141 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2142 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2144 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2145 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2147 /* Copy event attributes since the layout is different. */
2148 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2149 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2150 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2151 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2152 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2153 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2154 ua_chan
->attr
.output
= uchan
->attr
.output
;
2155 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2158 * Note that the attribute channel type is not set since the channel on the
2159 * tracing registry side does not have this information.
2162 ua_chan
->enabled
= uchan
->enabled
;
2163 ua_chan
->tracing_channel_id
= uchan
->id
;
2165 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2169 * Copy data between a UST app session and a regular LTT session.
2171 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2172 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2174 struct tm
*timeinfo
;
2177 char tmp_shm_path
[PATH_MAX
];
2179 timeinfo
= localtime(&app
->registration_time
);
2180 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2182 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2184 ua_sess
->tracing_id
= usess
->id
;
2185 ua_sess
->id
= get_next_session_id();
2186 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2187 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2188 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2189 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2190 ua_sess
->buffer_type
= usess
->buffer_type
;
2191 ua_sess
->bits_per_long
= app
->bits_per_long
;
2193 /* There is only one consumer object per session possible. */
2194 consumer_output_get(usess
->consumer
);
2195 ua_sess
->consumer
= usess
->consumer
;
2197 ua_sess
->output_traces
= usess
->output_traces
;
2198 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2199 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2200 &usess
->metadata_attr
);
2202 switch (ua_sess
->buffer_type
) {
2203 case LTTNG_BUFFER_PER_PID
:
2204 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2205 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2208 case LTTNG_BUFFER_PER_UID
:
2209 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2210 DEFAULT_UST_TRACE_UID_PATH
,
2211 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2212 app
->bits_per_long
);
2219 PERROR("asprintf UST shadow copy session");
2224 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2225 sizeof(ua_sess
->root_shm_path
));
2226 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2227 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2228 sizeof(ua_sess
->shm_path
));
2229 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2230 if (ua_sess
->shm_path
[0]) {
2231 switch (ua_sess
->buffer_type
) {
2232 case LTTNG_BUFFER_PER_PID
:
2233 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2234 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2235 app
->name
, app
->pid
, datetime
);
2237 case LTTNG_BUFFER_PER_UID
:
2238 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2239 "/" DEFAULT_UST_TRACE_UID_PATH
,
2240 app
->uid
, app
->bits_per_long
);
2247 PERROR("sprintf UST shadow copy session");
2251 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2252 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2253 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2258 consumer_output_put(ua_sess
->consumer
);
2262 * Lookup sesison wrapper.
2265 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2266 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2268 /* Get right UST app session from app */
2269 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2273 * Return ust app session from the app session hashtable using the UST session
2276 static struct ust_app_session
*lookup_session_by_app(
2277 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2279 struct lttng_ht_iter iter
;
2280 struct lttng_ht_node_u64
*node
;
2282 __lookup_session_by_app(usess
, app
, &iter
);
2283 node
= lttng_ht_iter_get_node_u64(&iter
);
2288 return caa_container_of(node
, struct ust_app_session
, node
);
2295 * Setup buffer registry per PID for the given session and application. If none
2296 * is found, a new one is created, added to the global registry and
2297 * initialized. If regp is valid, it's set with the newly created object.
2299 * Return 0 on success or else a negative value.
2301 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2302 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2305 struct buffer_reg_pid
*reg_pid
;
2312 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2315 * This is the create channel path meaning that if there is NO
2316 * registry available, we have to create one for this session.
2318 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2319 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2327 /* Initialize registry. */
2328 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2329 app
->bits_per_long
, app
->uint8_t_alignment
,
2330 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2331 app
->uint64_t_alignment
, app
->long_alignment
,
2332 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2333 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2334 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2335 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2336 ua_sess
->tracing_id
,
2340 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2341 * destroy the buffer registry, because it is always expected
2342 * that if the buffer registry can be found, its ust registry is
2345 buffer_reg_pid_destroy(reg_pid
);
2349 buffer_reg_pid_add(reg_pid
);
2351 DBG3("UST app buffer registry per PID created successfully");
2363 * Setup buffer registry per UID for the given session and application. If none
2364 * is found, a new one is created, added to the global registry and
2365 * initialized. If regp is valid, it's set with the newly created object.
2367 * Return 0 on success or else a negative value.
2369 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2370 struct ust_app_session
*ua_sess
,
2371 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2374 struct buffer_reg_uid
*reg_uid
;
2381 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2384 * This is the create channel path meaning that if there is NO
2385 * registry available, we have to create one for this session.
2387 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2388 LTTNG_DOMAIN_UST
, ®_uid
,
2389 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2397 /* Initialize registry. */
2398 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2399 app
->bits_per_long
, app
->uint8_t_alignment
,
2400 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2401 app
->uint64_t_alignment
, app
->long_alignment
,
2402 app
->byte_order
, app
->version
.major
,
2403 app
->version
.minor
, reg_uid
->root_shm_path
,
2404 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2405 ua_sess
->tracing_id
, app
->uid
);
2408 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2409 * destroy the buffer registry, because it is always expected
2410 * that if the buffer registry can be found, its ust registry is
2413 buffer_reg_uid_destroy(reg_uid
, NULL
);
2416 /* Add node to teardown list of the session. */
2417 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2419 buffer_reg_uid_add(reg_uid
);
2421 DBG3("UST app buffer registry per UID created successfully");
2432 * Create a session on the tracer side for the given app.
2434 * On success, ua_sess_ptr is populated with the session pointer or else left
2435 * untouched. If the session was created, is_created is set to 1. On error,
2436 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2439 * Returns 0 on success or else a negative code which is either -ENOMEM or
2440 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2442 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2443 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2446 int ret
, created
= 0;
2447 struct ust_app_session
*ua_sess
;
2451 assert(ua_sess_ptr
);
2453 health_code_update();
2455 ua_sess
= lookup_session_by_app(usess
, app
);
2456 if (ua_sess
== NULL
) {
2457 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2458 app
->pid
, usess
->id
);
2459 ua_sess
= alloc_ust_app_session();
2460 if (ua_sess
== NULL
) {
2461 /* Only malloc can failed so something is really wrong */
2465 shadow_copy_session(ua_sess
, usess
, app
);
2469 switch (usess
->buffer_type
) {
2470 case LTTNG_BUFFER_PER_PID
:
2471 /* Init local registry. */
2472 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2474 delete_ust_app_session(-1, ua_sess
, app
);
2478 case LTTNG_BUFFER_PER_UID
:
2479 /* Look for a global registry. If none exists, create one. */
2480 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2482 delete_ust_app_session(-1, ua_sess
, app
);
2492 health_code_update();
2494 if (ua_sess
->handle
== -1) {
2495 pthread_mutex_lock(&app
->sock_lock
);
2496 ret
= ustctl_create_session(app
->sock
);
2497 pthread_mutex_unlock(&app
->sock_lock
);
2499 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2500 ERR("Creating session for app pid %d with ret %d",
2503 DBG("UST app creating session failed. Application is dead");
2505 * This is normal behavior, an application can die during the
2506 * creation process. Don't report an error so the execution can
2507 * continue normally. This will get flagged ENOTCONN and the
2508 * caller will handle it.
2512 delete_ust_app_session(-1, ua_sess
, app
);
2513 if (ret
!= -ENOMEM
) {
2515 * Tracer is probably gone or got an internal error so let's
2516 * behave like it will soon unregister or not usable.
2523 ua_sess
->handle
= ret
;
2525 /* Add ust app session to app's HT */
2526 lttng_ht_node_init_u64(&ua_sess
->node
,
2527 ua_sess
->tracing_id
);
2528 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2529 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2530 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2531 &ua_sess
->ust_objd_node
);
2533 DBG2("UST app session created successfully with handle %d", ret
);
2536 *ua_sess_ptr
= ua_sess
;
2538 *is_created
= created
;
2541 /* Everything went well. */
2545 health_code_update();
2550 * Match function for a hash table lookup of ust_app_ctx.
2552 * It matches an ust app context based on the context type and, in the case
2553 * of perf counters, their name.
2555 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2557 struct ust_app_ctx
*ctx
;
2558 const struct lttng_ust_context_attr
*key
;
2563 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2567 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2572 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2573 if (strncmp(key
->u
.perf_counter
.name
,
2574 ctx
->ctx
.u
.perf_counter
.name
,
2575 sizeof(key
->u
.perf_counter
.name
))) {
2579 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2580 if (strcmp(key
->u
.app_ctx
.provider_name
,
2581 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2582 strcmp(key
->u
.app_ctx
.ctx_name
,
2583 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2599 * Lookup for an ust app context from an lttng_ust_context.
2601 * Must be called while holding RCU read side lock.
2602 * Return an ust_app_ctx object or NULL on error.
2605 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2606 struct lttng_ust_context_attr
*uctx
)
2608 struct lttng_ht_iter iter
;
2609 struct lttng_ht_node_ulong
*node
;
2610 struct ust_app_ctx
*app_ctx
= NULL
;
2615 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2616 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2617 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2618 node
= lttng_ht_iter_get_node_ulong(&iter
);
2623 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2630 * Create a context for the channel on the tracer.
2632 * Called with UST app session lock held and a RCU read side lock.
2635 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2636 struct lttng_ust_context_attr
*uctx
,
2637 struct ust_app
*app
)
2640 struct ust_app_ctx
*ua_ctx
;
2642 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2644 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2650 ua_ctx
= alloc_ust_app_ctx(uctx
);
2651 if (ua_ctx
== NULL
) {
2657 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2658 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2659 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2661 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2671 * Enable on the tracer side a ust app event for the session and channel.
2673 * Called with UST app session lock held.
2676 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2677 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2681 ret
= enable_ust_object(app
, ua_event
->obj
);
2686 ua_event
->enabled
= 1;
2693 * Disable on the tracer side a ust app event for the session and channel.
2695 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2696 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2700 ret
= disable_ust_object(app
, ua_event
->obj
);
2705 ua_event
->enabled
= 0;
2712 * Lookup ust app channel for session and disable it on the tracer side.
2715 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2716 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2720 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2725 ua_chan
->enabled
= 0;
2732 * Lookup ust app channel for session and enable it on the tracer side. This
2733 * MUST be called with a RCU read side lock acquired.
2735 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2736 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2739 struct lttng_ht_iter iter
;
2740 struct lttng_ht_node_str
*ua_chan_node
;
2741 struct ust_app_channel
*ua_chan
;
2743 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2744 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2745 if (ua_chan_node
== NULL
) {
2746 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2747 uchan
->name
, ua_sess
->tracing_id
);
2751 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2753 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2763 * Ask the consumer to create a channel and get it if successful.
2765 * Called with UST app session lock held.
2767 * Return 0 on success or else a negative value.
2769 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2770 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2771 int bitness
, struct ust_registry_session
*registry
,
2772 uint64_t trace_archive_id
)
2775 unsigned int nb_fd
= 0;
2776 struct consumer_socket
*socket
;
2784 health_code_update();
2786 /* Get the right consumer socket for the application. */
2787 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2793 health_code_update();
2795 /* Need one fd for the channel. */
2796 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2798 ERR("Exhausted number of available FD upon create channel");
2803 * Ask consumer to create channel. The consumer will return the number of
2804 * stream we have to expect.
2806 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2807 registry
, usess
->current_trace_chunk
);
2813 * Compute the number of fd needed before receiving them. It must be 2 per
2814 * stream (2 being the default value here).
2816 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2818 /* Reserve the amount of file descriptor we need. */
2819 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2821 ERR("Exhausted number of available FD upon create channel");
2822 goto error_fd_get_stream
;
2825 health_code_update();
2828 * Now get the channel from the consumer. This call wil populate the stream
2829 * list of that channel and set the ust objects.
2831 if (usess
->consumer
->enabled
) {
2832 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2842 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2843 error_fd_get_stream
:
2845 * Initiate a destroy channel on the consumer since we had an error
2846 * handling it on our side. The return value is of no importance since we
2847 * already have a ret value set by the previous error that we need to
2850 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2852 lttng_fd_put(LTTNG_FD_APPS
, 1);
2854 health_code_update();
2860 * Duplicate the ust data object of the ust app stream and save it in the
2861 * buffer registry stream.
2863 * Return 0 on success or else a negative value.
2865 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2866 struct ust_app_stream
*stream
)
2873 /* Reserve the amount of file descriptor we need. */
2874 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2876 ERR("Exhausted number of available FD upon duplicate stream");
2880 /* Duplicate object for stream once the original is in the registry. */
2881 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2882 reg_stream
->obj
.ust
);
2884 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2885 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2886 lttng_fd_put(LTTNG_FD_APPS
, 2);
2889 stream
->handle
= stream
->obj
->handle
;
2896 * Duplicate the ust data object of the ust app. channel and save it in the
2897 * buffer registry channel.
2899 * Return 0 on success or else a negative value.
2901 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2902 struct ust_app_channel
*ua_chan
)
2909 /* Need two fds for the channel. */
2910 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2912 ERR("Exhausted number of available FD upon duplicate channel");
2916 /* Duplicate object for stream once the original is in the registry. */
2917 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2919 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2920 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2923 ua_chan
->handle
= ua_chan
->obj
->handle
;
2928 lttng_fd_put(LTTNG_FD_APPS
, 1);
2934 * For a given channel buffer registry, setup all streams of the given ust
2935 * application channel.
2937 * Return 0 on success or else a negative value.
2939 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2940 struct ust_app_channel
*ua_chan
,
2941 struct ust_app
*app
)
2944 struct ust_app_stream
*stream
, *stmp
;
2949 DBG2("UST app setup buffer registry stream");
2951 /* Send all streams to application. */
2952 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2953 struct buffer_reg_stream
*reg_stream
;
2955 ret
= buffer_reg_stream_create(®_stream
);
2961 * Keep original pointer and nullify it in the stream so the delete
2962 * stream call does not release the object.
2964 reg_stream
->obj
.ust
= stream
->obj
;
2966 buffer_reg_stream_add(reg_stream
, reg_chan
);
2968 /* We don't need the streams anymore. */
2969 cds_list_del(&stream
->list
);
2970 delete_ust_app_stream(-1, stream
, app
);
2978 * Create a buffer registry channel for the given session registry and
2979 * application channel object. If regp pointer is valid, it's set with the
2980 * created object. Important, the created object is NOT added to the session
2981 * registry hash table.
2983 * Return 0 on success else a negative value.
2985 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2986 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2989 struct buffer_reg_channel
*reg_chan
= NULL
;
2994 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2996 /* Create buffer registry channel. */
2997 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
3002 reg_chan
->consumer_key
= ua_chan
->key
;
3003 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3004 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3006 /* Create and add a channel registry to session. */
3007 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3008 ua_chan
->tracing_channel_id
);
3012 buffer_reg_channel_add(reg_sess
, reg_chan
);
3021 /* Safe because the registry channel object was not added to any HT. */
3022 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3028 * Setup buffer registry channel for the given session registry and application
3029 * channel object. If regp pointer is valid, it's set with the created object.
3031 * Return 0 on success else a negative value.
3033 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3034 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
3035 struct ust_app
*app
)
3042 assert(ua_chan
->obj
);
3044 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3046 /* Setup all streams for the registry. */
3047 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
3052 reg_chan
->obj
.ust
= ua_chan
->obj
;
3053 ua_chan
->obj
= NULL
;
3058 buffer_reg_channel_remove(reg_sess
, reg_chan
);
3059 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3064 * Send buffer registry channel to the application.
3066 * Return 0 on success else a negative value.
3068 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
3069 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3070 struct ust_app_channel
*ua_chan
)
3073 struct buffer_reg_stream
*reg_stream
;
3080 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3082 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
3087 /* Send channel to the application. */
3088 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3089 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3090 ret
= -ENOTCONN
; /* Caused by app exiting. */
3092 } else if (ret
< 0) {
3096 health_code_update();
3098 /* Send all streams to application. */
3099 pthread_mutex_lock(®_chan
->stream_list_lock
);
3100 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
3101 struct ust_app_stream stream
;
3103 ret
= duplicate_stream_object(reg_stream
, &stream
);
3105 goto error_stream_unlock
;
3108 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3110 (void) release_ust_app_stream(-1, &stream
, app
);
3111 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3112 ret
= -ENOTCONN
; /* Caused by app exiting. */
3114 goto error_stream_unlock
;
3118 * The return value is not important here. This function will output an
3121 (void) release_ust_app_stream(-1, &stream
, app
);
3123 ua_chan
->is_sent
= 1;
3125 error_stream_unlock
:
3126 pthread_mutex_unlock(®_chan
->stream_list_lock
);
3132 * Create and send to the application the created buffers with per UID buffers.
3134 * This MUST be called with a RCU read side lock acquired.
3135 * The session list lock and the session's lock must be acquired.
3137 * Return 0 on success else a negative value.
3139 static int create_channel_per_uid(struct ust_app
*app
,
3140 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3141 struct ust_app_channel
*ua_chan
)
3144 struct buffer_reg_uid
*reg_uid
;
3145 struct buffer_reg_channel
*reg_chan
;
3146 struct ltt_session
*session
= NULL
;
3147 enum lttng_error_code notification_ret
;
3148 struct ust_registry_channel
*chan_reg
;
3155 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3157 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3159 * The session creation handles the creation of this global registry
3160 * object. If none can be find, there is a code flow problem or a
3165 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3171 /* Create the buffer registry channel object. */
3172 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
3174 ERR("Error creating the UST channel \"%s\" registry instance",
3179 session
= session_find_by_id(ua_sess
->tracing_id
);
3181 assert(pthread_mutex_trylock(&session
->lock
));
3182 assert(session_trylock_list());
3185 * Create the buffers on the consumer side. This call populates the
3186 * ust app channel object with all streams and data object.
3188 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3189 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3190 session
->most_recent_chunk_id
.value
);
3192 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3196 * Let's remove the previously created buffer registry channel so
3197 * it's not visible anymore in the session registry.
3199 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3200 ua_chan
->tracing_channel_id
, false);
3201 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
3202 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3207 * Setup the streams and add it to the session registry.
3209 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3210 ua_chan
, reg_chan
, app
);
3212 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3216 /* Notify the notification subsystem of the channel's creation. */
3217 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3218 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3219 ua_chan
->tracing_channel_id
);
3221 chan_reg
->consumer_key
= ua_chan
->key
;
3223 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3225 notification_ret
= notification_thread_command_add_channel(
3226 notification_thread_handle
, session
->name
,
3227 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3228 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3230 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3231 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3232 if (notification_ret
!= LTTNG_OK
) {
3233 ret
= - (int) notification_ret
;
3234 ERR("Failed to add channel to notification thread");
3239 /* Send buffers to the application. */
3240 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
3242 if (ret
!= -ENOTCONN
) {
3243 ERR("Error sending channel to application");
3250 session_put(session
);
3256 * Create and send to the application the created buffers with per PID buffers.
3258 * Called with UST app session lock held.
3259 * The session list lock and the session's lock must be acquired.
3261 * Return 0 on success else a negative value.
3263 static int create_channel_per_pid(struct ust_app
*app
,
3264 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3265 struct ust_app_channel
*ua_chan
)
3268 struct ust_registry_session
*registry
;
3269 enum lttng_error_code cmd_ret
;
3270 struct ltt_session
*session
= NULL
;
3271 uint64_t chan_reg_key
;
3272 struct ust_registry_channel
*chan_reg
;
3279 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3283 registry
= get_session_registry(ua_sess
);
3284 /* The UST app session lock is held, registry shall not be null. */
3287 /* Create and add a new channel registry to session. */
3288 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3290 ERR("Error creating the UST channel \"%s\" registry instance",
3295 session
= session_find_by_id(ua_sess
->tracing_id
);
3298 assert(pthread_mutex_trylock(&session
->lock
));
3299 assert(session_trylock_list());
3301 /* Create and get channel on the consumer side. */
3302 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3303 app
->bits_per_long
, registry
,
3304 session
->most_recent_chunk_id
.value
);
3306 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3308 goto error_remove_from_registry
;
3311 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3313 if (ret
!= -ENOTCONN
) {
3314 ERR("Error sending channel to application");
3316 goto error_remove_from_registry
;
3319 chan_reg_key
= ua_chan
->key
;
3320 pthread_mutex_lock(®istry
->lock
);
3321 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3323 chan_reg
->consumer_key
= ua_chan
->key
;
3324 pthread_mutex_unlock(®istry
->lock
);
3326 cmd_ret
= notification_thread_command_add_channel(
3327 notification_thread_handle
, session
->name
,
3328 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3329 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3331 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3332 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3333 if (cmd_ret
!= LTTNG_OK
) {
3334 ret
= - (int) cmd_ret
;
3335 ERR("Failed to add channel to notification thread");
3336 goto error_remove_from_registry
;
3339 error_remove_from_registry
:
3341 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3346 session_put(session
);
3352 * From an already allocated ust app channel, create the channel buffers if
3353 * needed and send them to the application. This MUST be called with a RCU read
3354 * side lock acquired.
3356 * Called with UST app session lock held.
3358 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3359 * the application exited concurrently.
3361 static int ust_app_channel_send(struct ust_app
*app
,
3362 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3363 struct ust_app_channel
*ua_chan
)
3369 assert(usess
->active
);
3373 /* Handle buffer type before sending the channel to the application. */
3374 switch (usess
->buffer_type
) {
3375 case LTTNG_BUFFER_PER_UID
:
3377 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3383 case LTTNG_BUFFER_PER_PID
:
3385 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3397 /* Initialize ust objd object using the received handle and add it. */
3398 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3399 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3401 /* If channel is not enabled, disable it on the tracer */
3402 if (!ua_chan
->enabled
) {
3403 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3414 * Create UST app channel and return it through ua_chanp if not NULL.
3416 * Called with UST app session lock and RCU read-side lock held.
3418 * Return 0 on success or else a negative value.
3420 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3421 struct ltt_ust_channel
*uchan
,
3422 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3423 struct ust_app_channel
**ua_chanp
)
3426 struct lttng_ht_iter iter
;
3427 struct lttng_ht_node_str
*ua_chan_node
;
3428 struct ust_app_channel
*ua_chan
;
3430 /* Lookup channel in the ust app session */
3431 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3432 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3433 if (ua_chan_node
!= NULL
) {
3434 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3438 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3439 if (ua_chan
== NULL
) {
3440 /* Only malloc can fail here */
3444 shadow_copy_channel(ua_chan
, uchan
);
3446 /* Set channel type. */
3447 ua_chan
->attr
.type
= type
;
3449 /* Only add the channel if successful on the tracer side. */
3450 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3453 *ua_chanp
= ua_chan
;
3456 /* Everything went well. */
3464 * Create UST app event and create it on the tracer side.
3466 * Must be called with the RCU read side lock held.
3467 * Called with ust app session mutex held.
3470 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3471 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3472 struct ust_app
*app
)
3475 struct ust_app_event
*ua_event
;
3477 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3478 if (ua_event
== NULL
) {
3479 /* Only failure mode of alloc_ust_app_event(). */
3483 shadow_copy_event(ua_event
, uevent
);
3485 /* Create it on the tracer side */
3486 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3489 * Not found previously means that it does not exist on the
3490 * tracer. If the application reports that the event existed,
3491 * it means there is a bug in the sessiond or lttng-ust
3492 * (or corruption, etc.)
3494 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3495 ERR("Tracer for application reported that an event being created already existed: "
3496 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3498 app
->pid
, app
->ppid
, app
->uid
,
3504 add_unique_ust_app_event(ua_chan
, ua_event
);
3506 DBG2("UST app create event completed: app = '%s' (ppid: %d)",
3507 app
->name
, app
->ppid
);
3513 /* Valid. Calling here is already in a read side lock */
3514 delete_ust_app_event(-1, ua_event
, app
);
3519 * Create UST app event notifier rule and create it on the tracer side.
3521 * Must be called with the RCU read side lock held.
3522 * Called with ust app session mutex held.
3525 int create_ust_app_event_notifier_rule(struct lttng_event_rule
*rule
,
3526 struct ust_app
*app
, uint64_t token
)
3529 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3531 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(rule
, token
);
3532 if (ua_event_notifier_rule
== NULL
) {
3537 /* Create it on the tracer side. */
3538 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3541 * Not found previously means that it does not exist on the
3542 * tracer. If the application reports that the event existed,
3543 * it means there is a bug in the sessiond or lttng-ust
3544 * (or corruption, etc.)
3546 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3547 ERR("Tracer for application reported that an event notifier being created already exists: "
3548 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3550 app
->pid
, app
->ppid
, app
->uid
,
3556 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3557 &ua_event_notifier_rule
->node
);
3559 DBG2("UST app create token event rule completed: app = '%s' (ppid: %d), token = %" PRIu64
,
3560 app
->name
, app
->ppid
, token
);
3566 /* The RCU read side lock is already being held by the caller. */
3567 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3572 * Create UST metadata and open it on the tracer side.
3574 * Called with UST app session lock held and RCU read side lock.
3576 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3577 struct ust_app
*app
, struct consumer_output
*consumer
)
3580 struct ust_app_channel
*metadata
;
3581 struct consumer_socket
*socket
;
3582 struct ust_registry_session
*registry
;
3583 struct ltt_session
*session
= NULL
;
3589 registry
= get_session_registry(ua_sess
);
3590 /* The UST app session is held registry shall not be null. */
3593 pthread_mutex_lock(®istry
->lock
);
3595 /* Metadata already exists for this registry or it was closed previously */
3596 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3601 /* Allocate UST metadata */
3602 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3604 /* malloc() failed */
3609 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3611 /* Need one fd for the channel. */
3612 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3614 ERR("Exhausted number of available FD upon create metadata");
3618 /* Get the right consumer socket for the application. */
3619 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3622 goto error_consumer
;
3626 * Keep metadata key so we can identify it on the consumer side. Assign it
3627 * to the registry *before* we ask the consumer so we avoid the race of the
3628 * consumer requesting the metadata and the ask_channel call on our side
3629 * did not returned yet.
3631 registry
->metadata_key
= metadata
->key
;
3633 session
= session_find_by_id(ua_sess
->tracing_id
);
3636 assert(pthread_mutex_trylock(&session
->lock
));
3637 assert(session_trylock_list());
3640 * Ask the metadata channel creation to the consumer. The metadata object
3641 * will be created by the consumer and kept their. However, the stream is
3642 * never added or monitored until we do a first push metadata to the
3645 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3646 registry
, session
->current_trace_chunk
);
3648 /* Nullify the metadata key so we don't try to close it later on. */
3649 registry
->metadata_key
= 0;
3650 goto error_consumer
;
3654 * The setup command will make the metadata stream be sent to the relayd,
3655 * if applicable, and the thread managing the metadatas. This is important
3656 * because after this point, if an error occurs, the only way the stream
3657 * can be deleted is to be monitored in the consumer.
3659 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3661 /* Nullify the metadata key so we don't try to close it later on. */
3662 registry
->metadata_key
= 0;
3663 goto error_consumer
;
3666 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3667 metadata
->key
, app
->pid
);
3670 lttng_fd_put(LTTNG_FD_APPS
, 1);
3671 delete_ust_app_channel(-1, metadata
, app
);
3673 pthread_mutex_unlock(®istry
->lock
);
3675 session_put(session
);
3681 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3682 * acquired before calling this function.
3684 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3686 struct ust_app
*app
= NULL
;
3687 struct lttng_ht_node_ulong
*node
;
3688 struct lttng_ht_iter iter
;
3690 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3691 node
= lttng_ht_iter_get_node_ulong(&iter
);
3693 DBG2("UST app no found with pid %d", pid
);
3697 DBG2("Found UST app by pid %d", pid
);
3699 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3706 * Allocate and init an UST app object using the registration information and
3707 * the command socket. This is called when the command socket connects to the
3710 * The object is returned on success or else NULL.
3712 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3715 struct ust_app
*lta
= NULL
;
3716 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3721 DBG3("UST app creating application for socket %d", sock
);
3723 if ((msg
->bits_per_long
== 64 &&
3724 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3725 || (msg
->bits_per_long
== 32 &&
3726 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3727 ERR("Registration failed: application \"%s\" (pid: %d) has "
3728 "%d-bit long, but no consumerd for this size is available.\n",
3729 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3734 * Reserve the two file descriptors of the event source pipe. The write
3735 * end will be closed once it is passed to the application, at which
3736 * point a single 'put' will be performed.
3738 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3740 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s' (ppid: %d)",
3741 msg
->name
, (int) msg
->ppid
);
3745 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3746 if (!event_notifier_event_source_pipe
) {
3747 PERROR("Failed to open application event source pipe: '%s' (ppid = %d)",
3748 msg
->name
, msg
->ppid
);
3752 lta
= zmalloc(sizeof(struct ust_app
));
3755 goto error_free_pipe
;
3758 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3760 lta
->ppid
= msg
->ppid
;
3761 lta
->uid
= msg
->uid
;
3762 lta
->gid
= msg
->gid
;
3764 lta
->bits_per_long
= msg
->bits_per_long
;
3765 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3766 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3767 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3768 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3769 lta
->long_alignment
= msg
->long_alignment
;
3770 lta
->byte_order
= msg
->byte_order
;
3772 lta
->v_major
= msg
->major
;
3773 lta
->v_minor
= msg
->minor
;
3774 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3775 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3776 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3777 lta
->notify_sock
= -1;
3778 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3780 /* Copy name and make sure it's NULL terminated. */
3781 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3782 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3785 * Before this can be called, when receiving the registration information,
3786 * the application compatibility is checked. So, at this point, the
3787 * application can work with this session daemon.
3789 lta
->compatible
= 1;
3791 lta
->pid
= msg
->pid
;
3792 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3794 pthread_mutex_init(<a
->sock_lock
, NULL
);
3795 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3797 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3801 lttng_pipe_destroy(event_notifier_event_source_pipe
);
3802 lttng_fd_put(LTTNG_FD_APPS
, 2);
3808 * For a given application object, add it to every hash table.
3810 void ust_app_add(struct ust_app
*app
)
3813 assert(app
->notify_sock
>= 0);
3815 app
->registration_time
= time(NULL
);
3820 * On a re-registration, we want to kick out the previous registration of
3823 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3826 * The socket _should_ be unique until _we_ call close. So, a add_unique
3827 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3828 * already in the table.
3830 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3832 /* Add application to the notify socket hash table. */
3833 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3834 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3836 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3837 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3838 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3845 * Set the application version into the object.
3847 * Return 0 on success else a negative value either an errno code or a
3848 * LTTng-UST error code.
3850 int ust_app_version(struct ust_app
*app
)
3856 pthread_mutex_lock(&app
->sock_lock
);
3857 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3858 pthread_mutex_unlock(&app
->sock_lock
);
3860 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3861 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3863 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3871 * Setup the base event notifier group.
3873 * Return 0 on success else a negative value either an errno code or a
3874 * LTTng-UST error code.
3876 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
3879 int event_pipe_write_fd
;
3880 struct lttng_ust_object_data
*event_notifier_group
= NULL
;
3881 enum lttng_error_code lttng_ret
;
3885 /* Get the write side of the pipe. */
3886 event_pipe_write_fd
= lttng_pipe_get_writefd(
3887 app
->event_notifier_group
.event_pipe
);
3889 pthread_mutex_lock(&app
->sock_lock
);
3890 ret
= ustctl_create_event_notifier_group(app
->sock
,
3891 event_pipe_write_fd
, &event_notifier_group
);
3892 pthread_mutex_unlock(&app
->sock_lock
);
3894 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3895 ERR("Failed to create application event notifier group: ret = %d, app socket fd = %d, event_pipe_write_fd = %d",
3896 ret
, app
->sock
, event_pipe_write_fd
);
3898 DBG("Failed to create application event notifier group (application is dead): app socket fd = %d",
3905 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
3907 ERR("Failed to close write end of the application's event source pipe: app = '%s' (ppid = %d)",
3908 app
->name
, app
->ppid
);
3913 * Release the file descriptor that was reserved for the write-end of
3916 lttng_fd_put(LTTNG_FD_APPS
, 1);
3918 lttng_ret
= notification_thread_command_add_tracer_event_source(
3919 notification_thread_handle
,
3920 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
3922 if (lttng_ret
!= LTTNG_OK
) {
3923 ERR("Failed to add tracer event source to notification thread");
3928 /* Assign handle only when the complete setup is valid. */
3929 app
->event_notifier_group
.object
= event_notifier_group
;
3933 ustctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
3934 free(app
->event_notifier_group
.object
);
3939 * Unregister app by removing it from the global traceable app list and freeing
3942 * The socket is already closed at this point so no close to sock.
3944 void ust_app_unregister(int sock
)
3946 struct ust_app
*lta
;
3947 struct lttng_ht_node_ulong
*node
;
3948 struct lttng_ht_iter ust_app_sock_iter
;
3949 struct lttng_ht_iter iter
;
3950 struct ust_app_session
*ua_sess
;
3955 /* Get the node reference for a call_rcu */
3956 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3957 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3960 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3961 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3964 * For per-PID buffers, perform "push metadata" and flush all
3965 * application streams before removing app from hash tables,
3966 * ensuring proper behavior of data_pending check.
3967 * Remove sessions so they are not visible during deletion.
3969 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3971 struct ust_registry_session
*registry
;
3973 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3975 /* The session was already removed so scheduled for teardown. */
3979 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3980 (void) ust_app_flush_app_session(lta
, ua_sess
);
3984 * Add session to list for teardown. This is safe since at this point we
3985 * are the only one using this list.
3987 pthread_mutex_lock(&ua_sess
->lock
);
3989 if (ua_sess
->deleted
) {
3990 pthread_mutex_unlock(&ua_sess
->lock
);
3995 * Normally, this is done in the delete session process which is
3996 * executed in the call rcu below. However, upon registration we can't
3997 * afford to wait for the grace period before pushing data or else the
3998 * data pending feature can race between the unregistration and stop
3999 * command where the data pending command is sent *before* the grace
4002 * The close metadata below nullifies the metadata pointer in the
4003 * session so the delete session will NOT push/close a second time.
4005 registry
= get_session_registry(ua_sess
);
4007 /* Push metadata for application before freeing the application. */
4008 (void) push_metadata(registry
, ua_sess
->consumer
);
4011 * Don't ask to close metadata for global per UID buffers. Close
4012 * metadata only on destroy trace session in this case. Also, the
4013 * previous push metadata could have flag the metadata registry to
4014 * close so don't send a close command if closed.
4016 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4017 /* And ask to close it for this session registry. */
4018 (void) close_metadata(registry
, ua_sess
->consumer
);
4021 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4023 pthread_mutex_unlock(&ua_sess
->lock
);
4026 /* Remove application from PID hash table */
4027 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4031 * Remove application from notify hash table. The thread handling the
4032 * notify socket could have deleted the node so ignore on error because
4033 * either way it's valid. The close of that socket is handled by the
4034 * apps_notify_thread.
4036 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4037 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4040 * Ignore return value since the node might have been removed before by an
4041 * add replace during app registration because the PID can be reassigned by
4044 iter
.iter
.node
= <a
->pid_n
.node
;
4045 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4047 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4052 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4059 * Fill events array with all events name of all registered apps.
4061 int ust_app_list_events(struct lttng_event
**events
)
4064 size_t nbmem
, count
= 0;
4065 struct lttng_ht_iter iter
;
4066 struct ust_app
*app
;
4067 struct lttng_event
*tmp_event
;
4069 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4070 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4071 if (tmp_event
== NULL
) {
4072 PERROR("zmalloc ust app events");
4079 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4080 struct lttng_ust_tracepoint_iter uiter
;
4082 health_code_update();
4084 if (!app
->compatible
) {
4086 * TODO: In time, we should notice the caller of this error by
4087 * telling him that this is a version error.
4091 pthread_mutex_lock(&app
->sock_lock
);
4092 handle
= ustctl_tracepoint_list(app
->sock
);
4094 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4095 ERR("UST app list events getting handle failed for app pid %d",
4098 pthread_mutex_unlock(&app
->sock_lock
);
4102 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
4103 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4104 /* Handle ustctl error. */
4108 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4109 ERR("UST app tp list get failed for app %d with ret %d",
4112 DBG3("UST app tp list get failed. Application is dead");
4114 * This is normal behavior, an application can die during the
4115 * creation process. Don't report an error so the execution can
4116 * continue normally. Continue normal execution.
4121 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4122 if (release_ret
< 0 &&
4123 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4124 release_ret
!= -EPIPE
) {
4125 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4127 pthread_mutex_unlock(&app
->sock_lock
);
4131 health_code_update();
4132 if (count
>= nbmem
) {
4133 /* In case the realloc fails, we free the memory */
4134 struct lttng_event
*new_tmp_event
;
4137 new_nbmem
= nbmem
<< 1;
4138 DBG2("Reallocating event list from %zu to %zu entries",
4140 new_tmp_event
= realloc(tmp_event
,
4141 new_nbmem
* sizeof(struct lttng_event
));
4142 if (new_tmp_event
== NULL
) {
4145 PERROR("realloc ust app events");
4148 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4149 if (release_ret
< 0 &&
4150 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4151 release_ret
!= -EPIPE
) {
4152 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4154 pthread_mutex_unlock(&app
->sock_lock
);
4157 /* Zero the new memory */
4158 memset(new_tmp_event
+ nbmem
, 0,
4159 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4161 tmp_event
= new_tmp_event
;
4163 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
4164 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4165 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
4166 tmp_event
[count
].pid
= app
->pid
;
4167 tmp_event
[count
].enabled
= -1;
4170 ret
= ustctl_release_handle(app
->sock
, handle
);
4171 pthread_mutex_unlock(&app
->sock_lock
);
4172 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4173 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4178 *events
= tmp_event
;
4180 DBG2("UST app list events done (%zu events)", count
);
4185 health_code_update();
4190 * Fill events array with all events name of all registered apps.
4192 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4195 size_t nbmem
, count
= 0;
4196 struct lttng_ht_iter iter
;
4197 struct ust_app
*app
;
4198 struct lttng_event_field
*tmp_event
;
4200 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4201 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4202 if (tmp_event
== NULL
) {
4203 PERROR("zmalloc ust app event fields");
4210 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4211 struct lttng_ust_field_iter uiter
;
4213 health_code_update();
4215 if (!app
->compatible
) {
4217 * TODO: In time, we should notice the caller of this error by
4218 * telling him that this is a version error.
4222 pthread_mutex_lock(&app
->sock_lock
);
4223 handle
= ustctl_tracepoint_field_list(app
->sock
);
4225 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4226 ERR("UST app list field getting handle failed for app pid %d",
4229 pthread_mutex_unlock(&app
->sock_lock
);
4233 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
4234 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4235 /* Handle ustctl error. */
4239 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4240 ERR("UST app tp list field failed for app %d with ret %d",
4243 DBG3("UST app tp list field failed. Application is dead");
4245 * This is normal behavior, an application can die during the
4246 * creation process. Don't report an error so the execution can
4247 * continue normally. Reset list and count for next app.
4252 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4253 pthread_mutex_unlock(&app
->sock_lock
);
4254 if (release_ret
< 0 &&
4255 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4256 release_ret
!= -EPIPE
) {
4257 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4262 health_code_update();
4263 if (count
>= nbmem
) {
4264 /* In case the realloc fails, we free the memory */
4265 struct lttng_event_field
*new_tmp_event
;
4268 new_nbmem
= nbmem
<< 1;
4269 DBG2("Reallocating event field list from %zu to %zu entries",
4271 new_tmp_event
= realloc(tmp_event
,
4272 new_nbmem
* sizeof(struct lttng_event_field
));
4273 if (new_tmp_event
== NULL
) {
4276 PERROR("realloc ust app event fields");
4279 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4280 pthread_mutex_unlock(&app
->sock_lock
);
4282 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4283 release_ret
!= -EPIPE
) {
4284 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4288 /* Zero the new memory */
4289 memset(new_tmp_event
+ nbmem
, 0,
4290 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4292 tmp_event
= new_tmp_event
;
4295 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
4296 /* Mapping between these enums matches 1 to 1. */
4297 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4298 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4300 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
4301 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4302 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4303 tmp_event
[count
].event
.pid
= app
->pid
;
4304 tmp_event
[count
].event
.enabled
= -1;
4307 ret
= ustctl_release_handle(app
->sock
, handle
);
4308 pthread_mutex_unlock(&app
->sock_lock
);
4310 ret
!= -LTTNG_UST_ERR_EXITING
&&
4312 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4317 *fields
= tmp_event
;
4319 DBG2("UST app list event fields done (%zu events)", count
);
4324 health_code_update();
4329 * Free and clean all traceable apps of the global list.
4331 * Should _NOT_ be called with RCU read-side lock held.
4333 void ust_app_clean_list(void)
4336 struct ust_app
*app
;
4337 struct lttng_ht_iter iter
;
4339 DBG2("UST app cleaning registered apps hash table");
4343 /* Cleanup notify socket hash table */
4344 if (ust_app_ht_by_notify_sock
) {
4345 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4346 notify_sock_n
.node
) {
4348 * Assert that all notifiers are gone as all triggers
4349 * are unregistered prior to this clean-up.
4351 assert(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4353 ust_app_notify_sock_unregister(app
->notify_sock
);
4358 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4359 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4361 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4365 /* Cleanup socket hash table */
4366 if (ust_app_ht_by_sock
) {
4367 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4369 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4376 /* Destroy is done only when the ht is empty */
4378 ht_cleanup_push(ust_app_ht
);
4380 if (ust_app_ht_by_sock
) {
4381 ht_cleanup_push(ust_app_ht_by_sock
);
4383 if (ust_app_ht_by_notify_sock
) {
4384 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4389 * Init UST app hash table.
4391 int ust_app_ht_alloc(void)
4393 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4397 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4398 if (!ust_app_ht_by_sock
) {
4401 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4402 if (!ust_app_ht_by_notify_sock
) {
4409 * For a specific UST session, disable the channel for all registered apps.
4411 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4412 struct ltt_ust_channel
*uchan
)
4415 struct lttng_ht_iter iter
;
4416 struct lttng_ht_node_str
*ua_chan_node
;
4417 struct ust_app
*app
;
4418 struct ust_app_session
*ua_sess
;
4419 struct ust_app_channel
*ua_chan
;
4421 assert(usess
->active
);
4422 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4423 uchan
->name
, usess
->id
);
4427 /* For every registered applications */
4428 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4429 struct lttng_ht_iter uiter
;
4430 if (!app
->compatible
) {
4432 * TODO: In time, we should notice the caller of this error by
4433 * telling him that this is a version error.
4437 ua_sess
= lookup_session_by_app(usess
, app
);
4438 if (ua_sess
== NULL
) {
4443 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4444 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4445 /* If the session if found for the app, the channel must be there */
4446 assert(ua_chan_node
);
4448 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4449 /* The channel must not be already disabled */
4450 assert(ua_chan
->enabled
== 1);
4452 /* Disable channel onto application */
4453 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4455 /* XXX: We might want to report this error at some point... */
4465 * For a specific UST session, enable the channel for all registered apps.
4467 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4468 struct ltt_ust_channel
*uchan
)
4471 struct lttng_ht_iter iter
;
4472 struct ust_app
*app
;
4473 struct ust_app_session
*ua_sess
;
4475 assert(usess
->active
);
4476 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4477 uchan
->name
, usess
->id
);
4481 /* For every registered applications */
4482 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4483 if (!app
->compatible
) {
4485 * TODO: In time, we should notice the caller of this error by
4486 * telling him that this is a version error.
4490 ua_sess
= lookup_session_by_app(usess
, app
);
4491 if (ua_sess
== NULL
) {
4495 /* Enable channel onto application */
4496 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4498 /* XXX: We might want to report this error at some point... */
4508 * Disable an event in a channel and for a specific session.
4510 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4511 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4514 struct lttng_ht_iter iter
, uiter
;
4515 struct lttng_ht_node_str
*ua_chan_node
;
4516 struct ust_app
*app
;
4517 struct ust_app_session
*ua_sess
;
4518 struct ust_app_channel
*ua_chan
;
4519 struct ust_app_event
*ua_event
;
4521 assert(usess
->active
);
4522 DBG("UST app disabling event %s for all apps in channel "
4523 "%s for session id %" PRIu64
,
4524 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4528 /* For all registered applications */
4529 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4530 if (!app
->compatible
) {
4532 * TODO: In time, we should notice the caller of this error by
4533 * telling him that this is a version error.
4537 ua_sess
= lookup_session_by_app(usess
, app
);
4538 if (ua_sess
== NULL
) {
4543 /* Lookup channel in the ust app session */
4544 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4545 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4546 if (ua_chan_node
== NULL
) {
4547 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4548 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4551 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4553 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4554 uevent
->filter
, uevent
->attr
.loglevel
,
4556 if (ua_event
== NULL
) {
4557 DBG2("Event %s not found in channel %s for app pid %d."
4558 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4562 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4564 /* XXX: Report error someday... */
4573 /* The ua_sess lock must be held by the caller. */
4575 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4576 struct ust_app_session
*ua_sess
,
4577 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4578 struct ust_app_channel
**_ua_chan
)
4581 struct ust_app_channel
*ua_chan
= NULL
;
4584 ASSERT_LOCKED(ua_sess
->lock
);
4586 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4587 sizeof(uchan
->name
))) {
4588 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4592 struct ltt_ust_context
*uctx
= NULL
;
4595 * Create channel onto application and synchronize its
4598 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4599 LTTNG_UST_CHAN_PER_CPU
, usess
,
4605 ret
= ust_app_channel_send(app
, usess
,
4612 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4613 ret
= create_ust_app_channel_context(ua_chan
,
4626 * The application's socket is not valid. Either a bad socket
4627 * or a timeout on it. We can't inform the caller that for a
4628 * specific app, the session failed so lets continue here.
4630 ret
= 0; /* Not an error. */
4638 if (ret
== 0 && _ua_chan
) {
4640 * Only return the application's channel on success. Note
4641 * that the channel can still be part of the application's
4642 * channel hashtable on error.
4644 *_ua_chan
= ua_chan
;
4650 * Enable event for a specific session and channel on the tracer.
4652 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4653 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4656 struct lttng_ht_iter iter
, uiter
;
4657 struct lttng_ht_node_str
*ua_chan_node
;
4658 struct ust_app
*app
;
4659 struct ust_app_session
*ua_sess
;
4660 struct ust_app_channel
*ua_chan
;
4661 struct ust_app_event
*ua_event
;
4663 assert(usess
->active
);
4664 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4665 uevent
->attr
.name
, usess
->id
);
4668 * NOTE: At this point, this function is called only if the session and
4669 * channel passed are already created for all apps. and enabled on the
4675 /* For all registered applications */
4676 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4677 if (!app
->compatible
) {
4679 * TODO: In time, we should notice the caller of this error by
4680 * telling him that this is a version error.
4684 ua_sess
= lookup_session_by_app(usess
, app
);
4686 /* The application has problem or is probably dead. */
4690 pthread_mutex_lock(&ua_sess
->lock
);
4692 if (ua_sess
->deleted
) {
4693 pthread_mutex_unlock(&ua_sess
->lock
);
4697 /* Lookup channel in the ust app session */
4698 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4699 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4701 * It is possible that the channel cannot be found is
4702 * the channel/event creation occurs concurrently with
4703 * an application exit.
4705 if (!ua_chan_node
) {
4706 pthread_mutex_unlock(&ua_sess
->lock
);
4710 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4712 /* Get event node */
4713 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4714 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4715 if (ua_event
== NULL
) {
4716 DBG3("UST app enable event %s not found for app PID %d."
4717 "Skipping app", uevent
->attr
.name
, app
->pid
);
4721 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4723 pthread_mutex_unlock(&ua_sess
->lock
);
4727 pthread_mutex_unlock(&ua_sess
->lock
);
4736 * For a specific existing UST session and UST channel, creates the event for
4737 * all registered apps.
4739 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4740 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4743 struct lttng_ht_iter iter
, uiter
;
4744 struct lttng_ht_node_str
*ua_chan_node
;
4745 struct ust_app
*app
;
4746 struct ust_app_session
*ua_sess
;
4747 struct ust_app_channel
*ua_chan
;
4749 assert(usess
->active
);
4750 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4751 uevent
->attr
.name
, usess
->id
);
4755 /* For all registered applications */
4756 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4757 if (!app
->compatible
) {
4759 * TODO: In time, we should notice the caller of this error by
4760 * telling him that this is a version error.
4764 ua_sess
= lookup_session_by_app(usess
, app
);
4766 /* The application has problem or is probably dead. */
4770 pthread_mutex_lock(&ua_sess
->lock
);
4772 if (ua_sess
->deleted
) {
4773 pthread_mutex_unlock(&ua_sess
->lock
);
4777 /* Lookup channel in the ust app session */
4778 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4779 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4780 /* If the channel is not found, there is a code flow error */
4781 assert(ua_chan_node
);
4783 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4785 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4786 pthread_mutex_unlock(&ua_sess
->lock
);
4788 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4789 /* Possible value at this point: -ENOMEM. If so, we stop! */
4792 DBG2("UST app event %s already exist on app PID %d",
4793 uevent
->attr
.name
, app
->pid
);
4803 * Start tracing for a specific UST session and app.
4805 * Called with UST app session lock held.
4809 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4812 struct ust_app_session
*ua_sess
;
4814 DBG("Starting tracing for ust app pid %d", app
->pid
);
4818 if (!app
->compatible
) {
4822 ua_sess
= lookup_session_by_app(usess
, app
);
4823 if (ua_sess
== NULL
) {
4824 /* The session is in teardown process. Ignore and continue. */
4828 pthread_mutex_lock(&ua_sess
->lock
);
4830 if (ua_sess
->deleted
) {
4831 pthread_mutex_unlock(&ua_sess
->lock
);
4835 if (ua_sess
->enabled
) {
4836 pthread_mutex_unlock(&ua_sess
->lock
);
4840 /* Upon restart, we skip the setup, already done */
4841 if (ua_sess
->started
) {
4845 health_code_update();
4848 /* This starts the UST tracing */
4849 pthread_mutex_lock(&app
->sock_lock
);
4850 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4851 pthread_mutex_unlock(&app
->sock_lock
);
4853 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4854 ERR("Error starting tracing for app pid: %d (ret: %d)",
4857 DBG("UST app start session failed. Application is dead.");
4859 * This is normal behavior, an application can die during the
4860 * creation process. Don't report an error so the execution can
4861 * continue normally.
4863 pthread_mutex_unlock(&ua_sess
->lock
);
4869 /* Indicate that the session has been started once */
4870 ua_sess
->started
= 1;
4871 ua_sess
->enabled
= 1;
4873 pthread_mutex_unlock(&ua_sess
->lock
);
4875 health_code_update();
4877 /* Quiescent wait after starting trace */
4878 pthread_mutex_lock(&app
->sock_lock
);
4879 ret
= ustctl_wait_quiescent(app
->sock
);
4880 pthread_mutex_unlock(&app
->sock_lock
);
4881 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4882 ERR("UST app wait quiescent failed for app pid %d ret %d",
4888 health_code_update();
4892 pthread_mutex_unlock(&ua_sess
->lock
);
4894 health_code_update();
4899 * Stop tracing for a specific UST session and app.
4902 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4905 struct ust_app_session
*ua_sess
;
4906 struct ust_registry_session
*registry
;
4908 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4912 if (!app
->compatible
) {
4913 goto end_no_session
;
4916 ua_sess
= lookup_session_by_app(usess
, app
);
4917 if (ua_sess
== NULL
) {
4918 goto end_no_session
;
4921 pthread_mutex_lock(&ua_sess
->lock
);
4923 if (ua_sess
->deleted
) {
4924 pthread_mutex_unlock(&ua_sess
->lock
);
4925 goto end_no_session
;
4929 * If started = 0, it means that stop trace has been called for a session
4930 * that was never started. It's possible since we can have a fail start
4931 * from either the application manager thread or the command thread. Simply
4932 * indicate that this is a stop error.
4934 if (!ua_sess
->started
) {
4935 goto error_rcu_unlock
;
4938 health_code_update();
4940 /* This inhibits UST tracing */
4941 pthread_mutex_lock(&app
->sock_lock
);
4942 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4943 pthread_mutex_unlock(&app
->sock_lock
);
4945 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4946 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4949 DBG("UST app stop session failed. Application is dead.");
4951 * This is normal behavior, an application can die during the
4952 * creation process. Don't report an error so the execution can
4953 * continue normally.
4957 goto error_rcu_unlock
;
4960 health_code_update();
4961 ua_sess
->enabled
= 0;
4963 /* Quiescent wait after stopping trace */
4964 pthread_mutex_lock(&app
->sock_lock
);
4965 ret
= ustctl_wait_quiescent(app
->sock
);
4966 pthread_mutex_unlock(&app
->sock_lock
);
4967 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4968 ERR("UST app wait quiescent failed for app pid %d ret %d",
4972 health_code_update();
4974 registry
= get_session_registry(ua_sess
);
4976 /* The UST app session is held registry shall not be null. */
4979 /* Push metadata for application before freeing the application. */
4980 (void) push_metadata(registry
, ua_sess
->consumer
);
4983 pthread_mutex_unlock(&ua_sess
->lock
);
4986 health_code_update();
4990 pthread_mutex_unlock(&ua_sess
->lock
);
4992 health_code_update();
4997 int ust_app_flush_app_session(struct ust_app
*app
,
4998 struct ust_app_session
*ua_sess
)
5000 int ret
, retval
= 0;
5001 struct lttng_ht_iter iter
;
5002 struct ust_app_channel
*ua_chan
;
5003 struct consumer_socket
*socket
;
5005 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5009 if (!app
->compatible
) {
5010 goto end_not_compatible
;
5013 pthread_mutex_lock(&ua_sess
->lock
);
5015 if (ua_sess
->deleted
) {
5019 health_code_update();
5021 /* Flushing buffers */
5022 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5025 /* Flush buffers and push metadata. */
5026 switch (ua_sess
->buffer_type
) {
5027 case LTTNG_BUFFER_PER_PID
:
5028 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5030 health_code_update();
5031 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5033 ERR("Error flushing consumer channel");
5039 case LTTNG_BUFFER_PER_UID
:
5045 health_code_update();
5048 pthread_mutex_unlock(&ua_sess
->lock
);
5052 health_code_update();
5057 * Flush buffers for all applications for a specific UST session.
5058 * Called with UST session lock held.
5061 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5066 DBG("Flushing session buffers for all ust apps");
5070 /* Flush buffers and push metadata. */
5071 switch (usess
->buffer_type
) {
5072 case LTTNG_BUFFER_PER_UID
:
5074 struct buffer_reg_uid
*reg
;
5075 struct lttng_ht_iter iter
;
5077 /* Flush all per UID buffers associated to that session. */
5078 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5079 struct ust_registry_session
*ust_session_reg
;
5080 struct buffer_reg_channel
*reg_chan
;
5081 struct consumer_socket
*socket
;
5083 /* Get consumer socket to use to push the metadata.*/
5084 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5087 /* Ignore request if no consumer is found for the session. */
5091 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5092 reg_chan
, node
.node
) {
5094 * The following call will print error values so the return
5095 * code is of little importance because whatever happens, we
5096 * have to try them all.
5098 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
5101 ust_session_reg
= reg
->registry
->reg
.ust
;
5102 /* Push metadata. */
5103 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5107 case LTTNG_BUFFER_PER_PID
:
5109 struct ust_app_session
*ua_sess
;
5110 struct lttng_ht_iter iter
;
5111 struct ust_app
*app
;
5113 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5114 ua_sess
= lookup_session_by_app(usess
, app
);
5115 if (ua_sess
== NULL
) {
5118 (void) ust_app_flush_app_session(app
, ua_sess
);
5129 health_code_update();
5134 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5135 struct ust_app_session
*ua_sess
)
5138 struct lttng_ht_iter iter
;
5139 struct ust_app_channel
*ua_chan
;
5140 struct consumer_socket
*socket
;
5142 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5146 if (!app
->compatible
) {
5147 goto end_not_compatible
;
5150 pthread_mutex_lock(&ua_sess
->lock
);
5152 if (ua_sess
->deleted
) {
5156 health_code_update();
5158 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5161 ERR("Failed to find consumer (%" PRIu32
") socket",
5162 app
->bits_per_long
);
5167 /* Clear quiescent state. */
5168 switch (ua_sess
->buffer_type
) {
5169 case LTTNG_BUFFER_PER_PID
:
5170 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5171 ua_chan
, node
.node
) {
5172 health_code_update();
5173 ret
= consumer_clear_quiescent_channel(socket
,
5176 ERR("Error clearing quiescent state for consumer channel");
5182 case LTTNG_BUFFER_PER_UID
:
5189 health_code_update();
5192 pthread_mutex_unlock(&ua_sess
->lock
);
5196 health_code_update();
5201 * Clear quiescent state in each stream for all applications for a
5202 * specific UST session.
5203 * Called with UST session lock held.
5206 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5211 DBG("Clearing stream quiescent state for all ust apps");
5215 switch (usess
->buffer_type
) {
5216 case LTTNG_BUFFER_PER_UID
:
5218 struct lttng_ht_iter iter
;
5219 struct buffer_reg_uid
*reg
;
5222 * Clear quiescent for all per UID buffers associated to
5225 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5226 struct consumer_socket
*socket
;
5227 struct buffer_reg_channel
*reg_chan
;
5229 /* Get associated consumer socket.*/
5230 socket
= consumer_find_socket_by_bitness(
5231 reg
->bits_per_long
, usess
->consumer
);
5234 * Ignore request if no consumer is found for
5240 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5241 &iter
.iter
, reg_chan
, node
.node
) {
5243 * The following call will print error values so
5244 * the return code is of little importance
5245 * because whatever happens, we have to try them
5248 (void) consumer_clear_quiescent_channel(socket
,
5249 reg_chan
->consumer_key
);
5254 case LTTNG_BUFFER_PER_PID
:
5256 struct ust_app_session
*ua_sess
;
5257 struct lttng_ht_iter iter
;
5258 struct ust_app
*app
;
5260 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5262 ua_sess
= lookup_session_by_app(usess
, app
);
5263 if (ua_sess
== NULL
) {
5266 (void) ust_app_clear_quiescent_app_session(app
,
5278 health_code_update();
5283 * Destroy a specific UST session in apps.
5285 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5288 struct ust_app_session
*ua_sess
;
5289 struct lttng_ht_iter iter
;
5290 struct lttng_ht_node_u64
*node
;
5292 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5296 if (!app
->compatible
) {
5300 __lookup_session_by_app(usess
, app
, &iter
);
5301 node
= lttng_ht_iter_get_node_u64(&iter
);
5303 /* Session is being or is deleted. */
5306 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5308 health_code_update();
5309 destroy_app_session(app
, ua_sess
);
5311 health_code_update();
5313 /* Quiescent wait after stopping trace */
5314 pthread_mutex_lock(&app
->sock_lock
);
5315 ret
= ustctl_wait_quiescent(app
->sock
);
5316 pthread_mutex_unlock(&app
->sock_lock
);
5317 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5318 ERR("UST app wait quiescent failed for app pid %d ret %d",
5323 health_code_update();
5328 * Start tracing for the UST session.
5330 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5332 struct lttng_ht_iter iter
;
5333 struct ust_app
*app
;
5335 DBG("Starting all UST traces");
5338 * Even though the start trace might fail, flag this session active so
5339 * other application coming in are started by default.
5346 * In a start-stop-start use-case, we need to clear the quiescent state
5347 * of each channel set by the prior stop command, thus ensuring that a
5348 * following stop or destroy is sure to grab a timestamp_end near those
5349 * operations, even if the packet is empty.
5351 (void) ust_app_clear_quiescent_session(usess
);
5353 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5354 ust_app_global_update(usess
, app
);
5363 * Start tracing for the UST session.
5364 * Called with UST session lock held.
5366 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5369 struct lttng_ht_iter iter
;
5370 struct ust_app
*app
;
5372 DBG("Stopping all UST traces");
5375 * Even though the stop trace might fail, flag this session inactive so
5376 * other application coming in are not started by default.
5382 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5383 ret
= ust_app_stop_trace(usess
, app
);
5385 /* Continue to next apps even on error */
5390 (void) ust_app_flush_session(usess
);
5398 * Destroy app UST session.
5400 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5403 struct lttng_ht_iter iter
;
5404 struct ust_app
*app
;
5406 DBG("Destroy all UST traces");
5410 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5411 ret
= destroy_trace(usess
, app
);
5413 /* Continue to next apps even on error */
5423 /* The ua_sess lock must be held by the caller. */
5425 int find_or_create_ust_app_channel(
5426 struct ltt_ust_session
*usess
,
5427 struct ust_app_session
*ua_sess
,
5428 struct ust_app
*app
,
5429 struct ltt_ust_channel
*uchan
,
5430 struct ust_app_channel
**ua_chan
)
5433 struct lttng_ht_iter iter
;
5434 struct lttng_ht_node_str
*ua_chan_node
;
5436 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5437 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5439 *ua_chan
= caa_container_of(ua_chan_node
,
5440 struct ust_app_channel
, node
);
5444 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5453 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5454 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5455 struct ust_app
*app
)
5458 struct ust_app_event
*ua_event
= NULL
;
5460 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5461 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5463 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5468 if (ua_event
->enabled
!= uevent
->enabled
) {
5469 ret
= uevent
->enabled
?
5470 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5471 disable_ust_app_event(ua_sess
, ua_event
, app
);
5479 /* Called with RCU read-side lock held. */
5481 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5484 enum lttng_error_code ret_code
;
5485 enum lttng_trigger_status t_status
;
5486 struct lttng_ht_iter app_trigger_iter
;
5487 struct lttng_triggers
*triggers
= NULL
;
5488 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5489 unsigned int count
, i
;
5492 * Currrently, registering or unregistering a trigger with an
5493 * event rule condition causes a full synchronization of the event
5496 * The first step attempts to add an event notifier for all registered
5497 * triggers that apply to the user space tracers. Then, the
5498 * application's event notifiers rules are all checked against the list
5499 * of registered triggers. Any event notifier that doesn't have a
5500 * matching trigger can be assumed to have been disabled.
5502 * All of this is inefficient, but is put in place to get the feature
5503 * rolling as it is simpler at this moment. It will be optimized Soon™
5504 * to allow the state of enabled
5505 * event notifiers to be synchronized in a piece-wise way.
5508 /* Get all triggers using uid 0 (root) */
5509 ret_code
= notification_thread_command_list_triggers(
5510 notification_thread_handle
, 0, &triggers
);
5511 if (ret_code
!= LTTNG_OK
) {
5518 t_status
= lttng_triggers_get_count(triggers
, &count
);
5519 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5524 for (i
= 0; i
< count
; i
++) {
5525 struct lttng_condition
*condition
;
5526 struct lttng_event_rule
*event_rule
;
5527 struct lttng_trigger
*trigger
;
5528 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5529 enum lttng_condition_status condition_status
;
5532 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5535 token
= lttng_trigger_get_tracer_token(trigger
);
5536 condition
= lttng_trigger_get_condition(trigger
);
5538 if (lttng_condition_get_type(condition
) != LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
5539 /* Does not apply */
5543 condition_status
= lttng_condition_event_rule_borrow_rule_mutable(condition
, &event_rule
);
5544 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5546 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5547 /* Skip kernel related triggers. */
5552 * Find or create the associated token event rule. The caller
5553 * holds the RCU read lock, so this is safe to call without
5554 * explicitly acquiring it here.
5556 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5557 app
->token_to_event_notifier_rule_ht
, token
);
5558 if (!looked_up_event_notifier_rule
) {
5559 ret
= create_ust_app_event_notifier_rule(event_rule
, app
, token
);
5567 /* Remove all unknown event sources from the app. */
5568 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5569 &app_trigger_iter
.iter
, event_notifier_rule
,
5571 const uint64_t app_token
= event_notifier_rule
->token
;
5575 * Check if the app event trigger still exists on the
5576 * notification side.
5578 for (i
= 0; i
< count
; i
++) {
5579 uint64_t notification_thread_token
;
5580 const struct lttng_trigger
*trigger
=
5581 lttng_triggers_get_at_index(
5586 notification_thread_token
=
5587 lttng_trigger_get_tracer_token(trigger
);
5589 if (notification_thread_token
== app_token
) {
5601 * This trigger was unregistered, disable it on the tracer's
5604 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5608 /* Callee logs errors. */
5609 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5611 delete_ust_app_event_notifier_rule(
5612 app
->sock
, event_notifier_rule
, app
);
5618 lttng_triggers_destroy(triggers
);
5623 * The caller must ensure that the application is compatible and is tracked
5624 * by the process attribute trackers.
5627 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5628 struct ust_app
*app
)
5631 struct cds_lfht_iter uchan_iter
;
5632 struct ltt_ust_channel
*uchan
;
5633 struct ust_app_session
*ua_sess
= NULL
;
5636 * The application's configuration should only be synchronized for
5639 assert(usess
->active
);
5641 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5643 /* Tracer is probably gone or ENOMEM. */
5648 pthread_mutex_lock(&ua_sess
->lock
);
5649 if (ua_sess
->deleted
) {
5650 pthread_mutex_unlock(&ua_sess
->lock
);
5656 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5658 struct ust_app_channel
*ua_chan
;
5659 struct cds_lfht_iter uevent_iter
;
5660 struct ltt_ust_event
*uevent
;
5663 * Search for a matching ust_app_channel. If none is found,
5664 * create it. Creating the channel will cause the ua_chan
5665 * structure to be allocated, the channel buffers to be
5666 * allocated (if necessary) and sent to the application, and
5667 * all enabled contexts will be added to the channel.
5669 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5670 app
, uchan
, &ua_chan
);
5672 /* Tracer is probably gone or ENOMEM. */
5677 /* ua_chan will be NULL for the metadata channel */
5681 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5683 ret
= ust_app_channel_synchronize_event(ua_chan
,
5684 uevent
, ua_sess
, app
);
5690 if (ua_chan
->enabled
!= uchan
->enabled
) {
5691 ret
= uchan
->enabled
?
5692 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5693 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5701 * Create the metadata for the application. This returns gracefully if a
5702 * metadata was already set for the session.
5704 * The metadata channel must be created after the data channels as the
5705 * consumer daemon assumes this ordering. When interacting with a relay
5706 * daemon, the consumer will use this assumption to send the
5707 * "STREAMS_SENT" message to the relay daemon.
5709 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
5717 pthread_mutex_unlock(&ua_sess
->lock
);
5718 /* Everything went well at this point. */
5723 pthread_mutex_unlock(&ua_sess
->lock
);
5726 destroy_app_session(app
, ua_sess
);
5732 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5734 struct ust_app_session
*ua_sess
;
5736 ua_sess
= lookup_session_by_app(usess
, app
);
5737 if (ua_sess
== NULL
) {
5740 destroy_app_session(app
, ua_sess
);
5744 * Add channels/events from UST global domain to registered apps at sock.
5746 * Called with session lock held.
5747 * Called with RCU read-side lock held.
5749 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5752 assert(usess
->active
);
5754 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5755 app
->sock
, usess
->id
);
5757 if (!app
->compatible
) {
5760 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5762 trace_ust_id_tracker_lookup(
5763 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5765 trace_ust_id_tracker_lookup(
5766 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5769 * Synchronize the application's internal tracing configuration
5770 * and start tracing.
5772 ust_app_synchronize(usess
, app
);
5773 ust_app_start_trace(usess
, app
);
5775 ust_app_global_destroy(usess
, app
);
5780 * Add all event notifiers to an application.
5782 * Called with session lock held.
5783 * Called with RCU read-side lock held.
5785 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
5787 DBG2("UST application global event notifier rules update: app = '%s' (ppid: %d)",
5788 app
->name
, app
->ppid
);
5790 if (!app
->compatible
) {
5794 if (app
->event_notifier_group
.object
== NULL
) {
5795 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' (ppid: %d)",
5796 app
->name
, app
->ppid
);
5800 ust_app_synchronize_event_notifier_rules(app
);
5804 * Called with session lock held.
5806 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5808 struct lttng_ht_iter iter
;
5809 struct ust_app
*app
;
5812 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5813 ust_app_global_update(usess
, app
);
5818 void ust_app_global_update_all_event_notifier_rules(void)
5820 struct lttng_ht_iter iter
;
5821 struct ust_app
*app
;
5824 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5825 ust_app_global_update_event_notifier_rules(app
);
5832 * Add context to a specific channel for global UST domain.
5834 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5835 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5838 struct lttng_ht_node_str
*ua_chan_node
;
5839 struct lttng_ht_iter iter
, uiter
;
5840 struct ust_app_channel
*ua_chan
= NULL
;
5841 struct ust_app_session
*ua_sess
;
5842 struct ust_app
*app
;
5844 assert(usess
->active
);
5847 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5848 if (!app
->compatible
) {
5850 * TODO: In time, we should notice the caller of this error by
5851 * telling him that this is a version error.
5855 ua_sess
= lookup_session_by_app(usess
, app
);
5856 if (ua_sess
== NULL
) {
5860 pthread_mutex_lock(&ua_sess
->lock
);
5862 if (ua_sess
->deleted
) {
5863 pthread_mutex_unlock(&ua_sess
->lock
);
5867 /* Lookup channel in the ust app session */
5868 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5869 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5870 if (ua_chan_node
== NULL
) {
5873 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5875 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5880 pthread_mutex_unlock(&ua_sess
->lock
);
5888 * Receive registration and populate the given msg structure.
5890 * On success return 0 else a negative value returned by the ustctl call.
5892 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5895 uint32_t pid
, ppid
, uid
, gid
;
5899 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5900 &pid
, &ppid
, &uid
, &gid
,
5901 &msg
->bits_per_long
,
5902 &msg
->uint8_t_alignment
,
5903 &msg
->uint16_t_alignment
,
5904 &msg
->uint32_t_alignment
,
5905 &msg
->uint64_t_alignment
,
5906 &msg
->long_alignment
,
5913 case LTTNG_UST_ERR_EXITING
:
5914 DBG3("UST app recv reg message failed. Application died");
5916 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5917 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5918 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5919 LTTNG_UST_ABI_MINOR_VERSION
);
5922 ERR("UST app recv reg message failed with ret %d", ret
);
5927 msg
->pid
= (pid_t
) pid
;
5928 msg
->ppid
= (pid_t
) ppid
;
5929 msg
->uid
= (uid_t
) uid
;
5930 msg
->gid
= (gid_t
) gid
;
5937 * Return a ust app session object using the application object and the
5938 * session object descriptor has a key. If not found, NULL is returned.
5939 * A RCU read side lock MUST be acquired when calling this function.
5941 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5944 struct lttng_ht_node_ulong
*node
;
5945 struct lttng_ht_iter iter
;
5946 struct ust_app_session
*ua_sess
= NULL
;
5950 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5951 node
= lttng_ht_iter_get_node_ulong(&iter
);
5953 DBG2("UST app session find by objd %d not found", objd
);
5957 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5964 * Return a ust app channel object using the application object and the channel
5965 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5966 * lock MUST be acquired before calling this function.
5968 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5971 struct lttng_ht_node_ulong
*node
;
5972 struct lttng_ht_iter iter
;
5973 struct ust_app_channel
*ua_chan
= NULL
;
5977 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5978 node
= lttng_ht_iter_get_node_ulong(&iter
);
5980 DBG2("UST app channel find by objd %d not found", objd
);
5984 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5991 * Reply to a register channel notification from an application on the notify
5992 * socket. The channel metadata is also created.
5994 * The session UST registry lock is acquired in this function.
5996 * On success 0 is returned else a negative value.
5998 static int reply_ust_register_channel(int sock
, int cobjd
,
5999 size_t nr_fields
, struct ustctl_field
*fields
)
6001 int ret
, ret_code
= 0;
6003 uint64_t chan_reg_key
;
6004 enum ustctl_channel_header type
;
6005 struct ust_app
*app
;
6006 struct ust_app_channel
*ua_chan
;
6007 struct ust_app_session
*ua_sess
;
6008 struct ust_registry_session
*registry
;
6009 struct ust_registry_channel
*chan_reg
;
6013 /* Lookup application. If not found, there is a code flow error. */
6014 app
= find_app_by_notify_sock(sock
);
6016 DBG("Application socket %d is being torn down. Abort event notify",
6019 goto error_rcu_unlock
;
6022 /* Lookup channel by UST object descriptor. */
6023 ua_chan
= find_channel_by_objd(app
, cobjd
);
6025 DBG("Application channel is being torn down. Abort event notify");
6027 goto error_rcu_unlock
;
6030 assert(ua_chan
->session
);
6031 ua_sess
= ua_chan
->session
;
6033 /* Get right session registry depending on the session buffer type. */
6034 registry
= get_session_registry(ua_sess
);
6036 DBG("Application session is being torn down. Abort event notify");
6038 goto error_rcu_unlock
;
6041 /* Depending on the buffer type, a different channel key is used. */
6042 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6043 chan_reg_key
= ua_chan
->tracing_channel_id
;
6045 chan_reg_key
= ua_chan
->key
;
6048 pthread_mutex_lock(®istry
->lock
);
6050 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
6053 if (!chan_reg
->register_done
) {
6055 * TODO: eventually use the registry event count for
6056 * this channel to better guess header type for per-pid
6059 type
= USTCTL_CHANNEL_HEADER_LARGE
;
6060 chan_reg
->nr_ctx_fields
= nr_fields
;
6061 chan_reg
->ctx_fields
= fields
;
6063 chan_reg
->header_type
= type
;
6065 /* Get current already assigned values. */
6066 type
= chan_reg
->header_type
;
6068 /* Channel id is set during the object creation. */
6069 chan_id
= chan_reg
->chan_id
;
6071 /* Append to metadata */
6072 if (!chan_reg
->metadata_dumped
) {
6073 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
6075 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6081 DBG3("UST app replying to register channel key %" PRIu64
6082 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
6085 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6087 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6088 ERR("UST app reply channel failed with ret %d", ret
);
6090 DBG3("UST app reply channel failed. Application died");
6095 /* This channel registry registration is completed. */
6096 chan_reg
->register_done
= 1;
6099 pthread_mutex_unlock(®istry
->lock
);
6107 * Add event to the UST channel registry. When the event is added to the
6108 * registry, the metadata is also created. Once done, this replies to the
6109 * application with the appropriate error code.
6111 * The session UST registry lock is acquired in the function.
6113 * On success 0 is returned else a negative value.
6115 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6116 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
6117 int loglevel_value
, char *model_emf_uri
)
6120 uint32_t event_id
= 0;
6121 uint64_t chan_reg_key
;
6122 struct ust_app
*app
;
6123 struct ust_app_channel
*ua_chan
;
6124 struct ust_app_session
*ua_sess
;
6125 struct ust_registry_session
*registry
;
6129 /* Lookup application. If not found, there is a code flow error. */
6130 app
= find_app_by_notify_sock(sock
);
6132 DBG("Application socket %d is being torn down. Abort event notify",
6135 goto error_rcu_unlock
;
6138 /* Lookup channel by UST object descriptor. */
6139 ua_chan
= find_channel_by_objd(app
, cobjd
);
6141 DBG("Application channel is being torn down. Abort event notify");
6143 goto error_rcu_unlock
;
6146 assert(ua_chan
->session
);
6147 ua_sess
= ua_chan
->session
;
6149 registry
= get_session_registry(ua_sess
);
6151 DBG("Application session is being torn down. Abort event notify");
6153 goto error_rcu_unlock
;
6156 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6157 chan_reg_key
= ua_chan
->tracing_channel_id
;
6159 chan_reg_key
= ua_chan
->key
;
6162 pthread_mutex_lock(®istry
->lock
);
6165 * From this point on, this call acquires the ownership of the sig, fields
6166 * and model_emf_uri meaning any free are done inside it if needed. These
6167 * three variables MUST NOT be read/write after this.
6169 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6170 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6171 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6175 model_emf_uri
= NULL
;
6178 * The return value is returned to ustctl so in case of an error, the
6179 * application can be notified. In case of an error, it's important not to
6180 * return a negative error or else the application will get closed.
6182 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
6184 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6185 ERR("UST app reply event failed with ret %d", ret
);
6187 DBG3("UST app reply event failed. Application died");
6190 * No need to wipe the create event since the application socket will
6191 * get close on error hence cleaning up everything by itself.
6196 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6200 pthread_mutex_unlock(®istry
->lock
);
6205 free(model_emf_uri
);
6210 * Add enum to the UST session registry. Once done, this replies to the
6211 * application with the appropriate error code.
6213 * The session UST registry lock is acquired within this function.
6215 * On success 0 is returned else a negative value.
6217 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6218 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
6220 int ret
= 0, ret_code
;
6221 struct ust_app
*app
;
6222 struct ust_app_session
*ua_sess
;
6223 struct ust_registry_session
*registry
;
6224 uint64_t enum_id
= -1ULL;
6228 /* Lookup application. If not found, there is a code flow error. */
6229 app
= find_app_by_notify_sock(sock
);
6231 /* Return an error since this is not an error */
6232 DBG("Application socket %d is being torn down. Aborting enum registration",
6235 goto error_rcu_unlock
;
6238 /* Lookup session by UST object descriptor. */
6239 ua_sess
= find_session_by_objd(app
, sobjd
);
6241 /* Return an error since this is not an error */
6242 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6244 goto error_rcu_unlock
;
6247 registry
= get_session_registry(ua_sess
);
6249 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6251 goto error_rcu_unlock
;
6254 pthread_mutex_lock(®istry
->lock
);
6257 * From this point on, the callee acquires the ownership of
6258 * entries. The variable entries MUST NOT be read/written after
6261 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6262 entries
, nr_entries
, &enum_id
);
6266 * The return value is returned to ustctl so in case of an error, the
6267 * application can be notified. In case of an error, it's important not to
6268 * return a negative error or else the application will get closed.
6270 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
6272 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6273 ERR("UST app reply enum failed with ret %d", ret
);
6275 DBG3("UST app reply enum failed. Application died");
6278 * No need to wipe the create enum since the application socket will
6279 * get close on error hence cleaning up everything by itself.
6284 DBG3("UST registry enum %s added successfully or already found", name
);
6287 pthread_mutex_unlock(®istry
->lock
);
6294 * Handle application notification through the given notify socket.
6296 * Return 0 on success or else a negative value.
6298 int ust_app_recv_notify(int sock
)
6301 enum ustctl_notify_cmd cmd
;
6303 DBG3("UST app receiving notify from sock %d", sock
);
6305 ret
= ustctl_recv_notify(sock
, &cmd
);
6307 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6308 ERR("UST app recv notify failed with ret %d", ret
);
6310 DBG3("UST app recv notify failed. Application died");
6316 case USTCTL_NOTIFY_CMD_EVENT
:
6318 int sobjd
, cobjd
, loglevel_value
;
6319 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6321 struct ustctl_field
*fields
;
6323 DBG2("UST app ustctl register event received");
6325 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6326 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6329 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6330 ERR("UST app recv event failed with ret %d", ret
);
6332 DBG3("UST app recv event failed. Application died");
6338 * Add event to the UST registry coming from the notify socket. This
6339 * call will free if needed the sig, fields and model_emf_uri. This
6340 * code path loses the ownsership of these variables and transfer them
6341 * to the this function.
6343 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6344 fields
, loglevel_value
, model_emf_uri
);
6351 case USTCTL_NOTIFY_CMD_CHANNEL
:
6355 struct ustctl_field
*fields
;
6357 DBG2("UST app ustctl register channel received");
6359 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6362 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6363 ERR("UST app recv channel failed with ret %d", ret
);
6365 DBG3("UST app recv channel failed. Application died");
6371 * The fields ownership are transfered to this function call meaning
6372 * that if needed it will be freed. After this, it's invalid to access
6373 * fields or clean it up.
6375 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6383 case USTCTL_NOTIFY_CMD_ENUM
:
6386 char name
[LTTNG_UST_SYM_NAME_LEN
];
6388 struct ustctl_enum_entry
*entries
;
6390 DBG2("UST app ustctl register enum received");
6392 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
6393 &entries
, &nr_entries
);
6395 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6396 ERR("UST app recv enum failed with ret %d", ret
);
6398 DBG3("UST app recv enum failed. Application died");
6403 /* Callee assumes ownership of entries */
6404 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6405 entries
, nr_entries
);
6413 /* Should NEVER happen. */
6422 * Once the notify socket hangs up, this is called. First, it tries to find the
6423 * corresponding application. On failure, the call_rcu to close the socket is
6424 * executed. If an application is found, it tries to delete it from the notify
6425 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6427 * Note that an object needs to be allocated here so on ENOMEM failure, the
6428 * call RCU is not done but the rest of the cleanup is.
6430 void ust_app_notify_sock_unregister(int sock
)
6433 struct lttng_ht_iter iter
;
6434 struct ust_app
*app
;
6435 struct ust_app_notify_sock_obj
*obj
;
6441 obj
= zmalloc(sizeof(*obj
));
6444 * An ENOMEM is kind of uncool. If this strikes we continue the
6445 * procedure but the call_rcu will not be called. In this case, we
6446 * accept the fd leak rather than possibly creating an unsynchronized
6447 * state between threads.
6449 * TODO: The notify object should be created once the notify socket is
6450 * registered and stored independantely from the ust app object. The
6451 * tricky part is to synchronize the teardown of the application and
6452 * this notify object. Let's keep that in mind so we can avoid this
6453 * kind of shenanigans with ENOMEM in the teardown path.
6460 DBG("UST app notify socket unregister %d", sock
);
6463 * Lookup application by notify socket. If this fails, this means that the
6464 * hash table delete has already been done by the application
6465 * unregistration process so we can safely close the notify socket in a
6468 app
= find_app_by_notify_sock(sock
);
6473 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6476 * Whatever happens here either we fail or succeed, in both cases we have
6477 * to close the socket after a grace period to continue to the call RCU
6478 * here. If the deletion is successful, the application is not visible
6479 * anymore by other threads and is it fails it means that it was already
6480 * deleted from the hash table so either way we just have to close the
6483 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6489 * Close socket after a grace period to avoid for the socket to be reused
6490 * before the application object is freed creating potential race between
6491 * threads trying to add unique in the global hash table.
6494 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6499 * Destroy a ust app data structure and free its memory.
6501 void ust_app_destroy(struct ust_app
*app
)
6507 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6511 * Take a snapshot for a given UST session. The snapshot is sent to the given
6514 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6516 enum lttng_error_code
ust_app_snapshot_record(
6517 const struct ltt_ust_session
*usess
,
6518 const struct consumer_output
*output
, int wait
,
6519 uint64_t nb_packets_per_stream
)
6522 enum lttng_error_code status
= LTTNG_OK
;
6523 struct lttng_ht_iter iter
;
6524 struct ust_app
*app
;
6525 char *trace_path
= NULL
;
6532 switch (usess
->buffer_type
) {
6533 case LTTNG_BUFFER_PER_UID
:
6535 struct buffer_reg_uid
*reg
;
6537 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6538 struct buffer_reg_channel
*reg_chan
;
6539 struct consumer_socket
*socket
;
6540 char pathname
[PATH_MAX
];
6541 size_t consumer_path_offset
= 0;
6543 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6544 /* Skip since no metadata is present */
6548 /* Get consumer socket to use to push the metadata.*/
6549 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6552 status
= LTTNG_ERR_INVALID
;
6556 memset(pathname
, 0, sizeof(pathname
));
6557 ret
= snprintf(pathname
, sizeof(pathname
),
6558 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6559 reg
->uid
, reg
->bits_per_long
);
6561 PERROR("snprintf snapshot path");
6562 status
= LTTNG_ERR_INVALID
;
6565 /* Free path allowed on previous iteration. */
6567 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6568 &consumer_path_offset
);
6570 status
= LTTNG_ERR_INVALID
;
6573 /* Add the UST default trace dir to path. */
6574 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6575 reg_chan
, node
.node
) {
6576 status
= consumer_snapshot_channel(socket
,
6577 reg_chan
->consumer_key
,
6578 output
, 0, usess
->uid
,
6579 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6580 nb_packets_per_stream
);
6581 if (status
!= LTTNG_OK
) {
6585 status
= consumer_snapshot_channel(socket
,
6586 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6587 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6589 if (status
!= LTTNG_OK
) {
6595 case LTTNG_BUFFER_PER_PID
:
6597 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6598 struct consumer_socket
*socket
;
6599 struct lttng_ht_iter chan_iter
;
6600 struct ust_app_channel
*ua_chan
;
6601 struct ust_app_session
*ua_sess
;
6602 struct ust_registry_session
*registry
;
6603 char pathname
[PATH_MAX
];
6604 size_t consumer_path_offset
= 0;
6606 ua_sess
= lookup_session_by_app(usess
, app
);
6608 /* Session not associated with this app. */
6612 /* Get the right consumer socket for the application. */
6613 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6616 status
= LTTNG_ERR_INVALID
;
6620 /* Add the UST default trace dir to path. */
6621 memset(pathname
, 0, sizeof(pathname
));
6622 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6625 status
= LTTNG_ERR_INVALID
;
6626 PERROR("snprintf snapshot path");
6629 /* Free path allowed on previous iteration. */
6631 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6632 &consumer_path_offset
);
6634 status
= LTTNG_ERR_INVALID
;
6637 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6638 ua_chan
, node
.node
) {
6639 status
= consumer_snapshot_channel(socket
,
6640 ua_chan
->key
, output
, 0,
6641 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6642 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6643 &trace_path
[consumer_path_offset
], wait
,
6644 nb_packets_per_stream
);
6648 case LTTNG_ERR_CHAN_NOT_FOUND
:
6655 registry
= get_session_registry(ua_sess
);
6657 DBG("Application session is being torn down. Skip application.");
6660 status
= consumer_snapshot_channel(socket
,
6661 registry
->metadata_key
, output
, 1,
6662 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6663 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6664 &trace_path
[consumer_path_offset
], wait
, 0);
6668 case LTTNG_ERR_CHAN_NOT_FOUND
:
6688 * Return the size taken by one more packet per stream.
6690 uint64_t ust_app_get_size_one_more_packet_per_stream(
6691 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6693 uint64_t tot_size
= 0;
6694 struct ust_app
*app
;
6695 struct lttng_ht_iter iter
;
6699 switch (usess
->buffer_type
) {
6700 case LTTNG_BUFFER_PER_UID
:
6702 struct buffer_reg_uid
*reg
;
6704 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6705 struct buffer_reg_channel
*reg_chan
;
6708 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6709 reg_chan
, node
.node
) {
6710 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6712 * Don't take channel into account if we
6713 * already grab all its packets.
6717 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6723 case LTTNG_BUFFER_PER_PID
:
6726 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6727 struct ust_app_channel
*ua_chan
;
6728 struct ust_app_session
*ua_sess
;
6729 struct lttng_ht_iter chan_iter
;
6731 ua_sess
= lookup_session_by_app(usess
, app
);
6733 /* Session not associated with this app. */
6737 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6738 ua_chan
, node
.node
) {
6739 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6741 * Don't take channel into account if we
6742 * already grab all its packets.
6746 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6760 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6761 struct cds_list_head
*buffer_reg_uid_list
,
6762 struct consumer_output
*consumer
, uint64_t uchan_id
,
6763 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6766 uint64_t consumer_chan_key
;
6771 ret
= buffer_reg_uid_consumer_channel_key(
6772 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6780 ret
= consumer_get_lost_packets(ust_session_id
,
6781 consumer_chan_key
, consumer
, lost
);
6783 ret
= consumer_get_discarded_events(ust_session_id
,
6784 consumer_chan_key
, consumer
, discarded
);
6791 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6792 struct ltt_ust_channel
*uchan
,
6793 struct consumer_output
*consumer
, int overwrite
,
6794 uint64_t *discarded
, uint64_t *lost
)
6797 struct lttng_ht_iter iter
;
6798 struct lttng_ht_node_str
*ua_chan_node
;
6799 struct ust_app
*app
;
6800 struct ust_app_session
*ua_sess
;
6801 struct ust_app_channel
*ua_chan
;
6808 * Iterate over every registered applications. Sum counters for
6809 * all applications containing requested session and channel.
6811 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6812 struct lttng_ht_iter uiter
;
6814 ua_sess
= lookup_session_by_app(usess
, app
);
6815 if (ua_sess
== NULL
) {
6820 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6821 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6822 /* If the session is found for the app, the channel must be there */
6823 assert(ua_chan_node
);
6825 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6830 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6837 uint64_t _discarded
;
6839 ret
= consumer_get_discarded_events(usess
->id
,
6840 ua_chan
->key
, consumer
, &_discarded
);
6844 (*discarded
) += _discarded
;
6853 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6854 struct ust_app
*app
)
6857 struct ust_app_session
*ua_sess
;
6859 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6863 ua_sess
= lookup_session_by_app(usess
, app
);
6864 if (ua_sess
== NULL
) {
6865 /* The session is in teardown process. Ignore and continue. */
6869 pthread_mutex_lock(&ua_sess
->lock
);
6871 if (ua_sess
->deleted
) {
6875 pthread_mutex_lock(&app
->sock_lock
);
6876 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6877 pthread_mutex_unlock(&app
->sock_lock
);
6880 pthread_mutex_unlock(&ua_sess
->lock
);
6884 health_code_update();
6889 * Regenerate the statedump for each app in the session.
6891 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6894 struct lttng_ht_iter iter
;
6895 struct ust_app
*app
;
6897 DBG("Regenerating the metadata for all UST apps");
6901 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6902 if (!app
->compatible
) {
6906 ret
= ust_app_regenerate_statedump(usess
, app
);
6908 /* Continue to the next app even on error */
6919 * Rotate all the channels of a session.
6921 * Return LTTNG_OK on success or else an LTTng error code.
6923 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6926 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6927 struct lttng_ht_iter iter
;
6928 struct ust_app
*app
;
6929 struct ltt_ust_session
*usess
= session
->ust_session
;
6935 switch (usess
->buffer_type
) {
6936 case LTTNG_BUFFER_PER_UID
:
6938 struct buffer_reg_uid
*reg
;
6940 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6941 struct buffer_reg_channel
*reg_chan
;
6942 struct consumer_socket
*socket
;
6944 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6945 /* Skip since no metadata is present */
6949 /* Get consumer socket to use to push the metadata.*/
6950 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6953 cmd_ret
= LTTNG_ERR_INVALID
;
6957 /* Rotate the data channels. */
6958 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6959 reg_chan
, node
.node
) {
6960 ret
= consumer_rotate_channel(socket
,
6961 reg_chan
->consumer_key
,
6962 usess
->uid
, usess
->gid
,
6964 /* is_metadata_channel */ false);
6966 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6971 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6973 ret
= consumer_rotate_channel(socket
,
6974 reg
->registry
->reg
.ust
->metadata_key
,
6975 usess
->uid
, usess
->gid
,
6977 /* is_metadata_channel */ true);
6979 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6985 case LTTNG_BUFFER_PER_PID
:
6987 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6988 struct consumer_socket
*socket
;
6989 struct lttng_ht_iter chan_iter
;
6990 struct ust_app_channel
*ua_chan
;
6991 struct ust_app_session
*ua_sess
;
6992 struct ust_registry_session
*registry
;
6994 ua_sess
= lookup_session_by_app(usess
, app
);
6996 /* Session not associated with this app. */
7000 /* Get the right consumer socket for the application. */
7001 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7004 cmd_ret
= LTTNG_ERR_INVALID
;
7008 registry
= get_session_registry(ua_sess
);
7010 DBG("Application session is being torn down. Skip application.");
7014 /* Rotate the data channels. */
7015 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7016 ua_chan
, node
.node
) {
7017 ret
= consumer_rotate_channel(socket
,
7019 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7020 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7022 /* is_metadata_channel */ false);
7024 /* Per-PID buffer and application going away. */
7025 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7027 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7032 /* Rotate the metadata channel. */
7033 (void) push_metadata(registry
, usess
->consumer
);
7034 ret
= consumer_rotate_channel(socket
,
7035 registry
->metadata_key
,
7036 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7037 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7039 /* is_metadata_channel */ true);
7041 /* Per-PID buffer and application going away. */
7042 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7044 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7062 enum lttng_error_code
ust_app_create_channel_subdirectories(
7063 const struct ltt_ust_session
*usess
)
7065 enum lttng_error_code ret
= LTTNG_OK
;
7066 struct lttng_ht_iter iter
;
7067 enum lttng_trace_chunk_status chunk_status
;
7068 char *pathname_index
;
7071 assert(usess
->current_trace_chunk
);
7074 switch (usess
->buffer_type
) {
7075 case LTTNG_BUFFER_PER_UID
:
7077 struct buffer_reg_uid
*reg
;
7079 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7080 fmt_ret
= asprintf(&pathname_index
,
7081 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7082 reg
->uid
, reg
->bits_per_long
);
7084 ERR("Failed to format channel index directory");
7085 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7090 * Create the index subdirectory which will take care
7091 * of implicitly creating the channel's path.
7093 chunk_status
= lttng_trace_chunk_create_subdirectory(
7094 usess
->current_trace_chunk
,
7096 free(pathname_index
);
7097 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7098 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7104 case LTTNG_BUFFER_PER_PID
:
7106 struct ust_app
*app
;
7109 * Create the toplevel ust/ directory in case no apps are running.
7111 chunk_status
= lttng_trace_chunk_create_subdirectory(
7112 usess
->current_trace_chunk
,
7113 DEFAULT_UST_TRACE_DIR
);
7114 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7115 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7119 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7121 struct ust_app_session
*ua_sess
;
7122 struct ust_registry_session
*registry
;
7124 ua_sess
= lookup_session_by_app(usess
, app
);
7126 /* Session not associated with this app. */
7130 registry
= get_session_registry(ua_sess
);
7132 DBG("Application session is being torn down. Skip application.");
7136 fmt_ret
= asprintf(&pathname_index
,
7137 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7140 ERR("Failed to format channel index directory");
7141 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7145 * Create the index subdirectory which will take care
7146 * of implicitly creating the channel's path.
7148 chunk_status
= lttng_trace_chunk_create_subdirectory(
7149 usess
->current_trace_chunk
,
7151 free(pathname_index
);
7152 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7153 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7170 * Clear all the channels of a session.
7172 * Return LTTNG_OK on success or else an LTTng error code.
7174 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7177 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7178 struct lttng_ht_iter iter
;
7179 struct ust_app
*app
;
7180 struct ltt_ust_session
*usess
= session
->ust_session
;
7186 if (usess
->active
) {
7187 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7188 cmd_ret
= LTTNG_ERR_FATAL
;
7192 switch (usess
->buffer_type
) {
7193 case LTTNG_BUFFER_PER_UID
:
7195 struct buffer_reg_uid
*reg
;
7197 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7198 struct buffer_reg_channel
*reg_chan
;
7199 struct consumer_socket
*socket
;
7201 /* Get consumer socket to use to push the metadata.*/
7202 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7205 cmd_ret
= LTTNG_ERR_INVALID
;
7209 /* Clear the data channels. */
7210 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7211 reg_chan
, node
.node
) {
7212 ret
= consumer_clear_channel(socket
,
7213 reg_chan
->consumer_key
);
7219 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7222 * Clear the metadata channel.
7223 * Metadata channel is not cleared per se but we still need to
7224 * perform a rotation operation on it behind the scene.
7226 ret
= consumer_clear_channel(socket
,
7227 reg
->registry
->reg
.ust
->metadata_key
);
7234 case LTTNG_BUFFER_PER_PID
:
7236 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7237 struct consumer_socket
*socket
;
7238 struct lttng_ht_iter chan_iter
;
7239 struct ust_app_channel
*ua_chan
;
7240 struct ust_app_session
*ua_sess
;
7241 struct ust_registry_session
*registry
;
7243 ua_sess
= lookup_session_by_app(usess
, app
);
7245 /* Session not associated with this app. */
7249 /* Get the right consumer socket for the application. */
7250 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7253 cmd_ret
= LTTNG_ERR_INVALID
;
7257 registry
= get_session_registry(ua_sess
);
7259 DBG("Application session is being torn down. Skip application.");
7263 /* Clear the data channels. */
7264 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7265 ua_chan
, node
.node
) {
7266 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7268 /* Per-PID buffer and application going away. */
7269 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7276 (void) push_metadata(registry
, usess
->consumer
);
7279 * Clear the metadata channel.
7280 * Metadata channel is not cleared per se but we still need to
7281 * perform rotation operation on it behind the scene.
7283 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7285 /* Per-PID buffer and application going away. */
7286 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7304 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7305 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7308 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7318 * This function skips the metadata channel as the begin/end timestamps of a
7319 * metadata packet are useless.
7321 * Moreover, opening a packet after a "clear" will cause problems for live
7322 * sessions as it will introduce padding that was not part of the first trace
7323 * chunk. The relay daemon expects the content of the metadata stream of
7324 * successive metadata trace chunks to be strict supersets of one another.
7326 * For example, flushing a packet at the beginning of the metadata stream of
7327 * a trace chunk resulting from a "clear" session command will cause the
7328 * size of the metadata stream of the new trace chunk to not match the size of
7329 * the metadata stream of the original chunk. This will confuse the relay
7330 * daemon as the same "offset" in a metadata stream will no longer point
7331 * to the same content.
7333 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7335 enum lttng_error_code ret
= LTTNG_OK
;
7336 struct lttng_ht_iter iter
;
7337 struct ltt_ust_session
*usess
= session
->ust_session
;
7343 switch (usess
->buffer_type
) {
7344 case LTTNG_BUFFER_PER_UID
:
7346 struct buffer_reg_uid
*reg
;
7348 cds_list_for_each_entry (
7349 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7350 struct buffer_reg_channel
*reg_chan
;
7351 struct consumer_socket
*socket
;
7353 socket
= consumer_find_socket_by_bitness(
7354 reg
->bits_per_long
, usess
->consumer
);
7356 ret
= LTTNG_ERR_FATAL
;
7360 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7361 &iter
.iter
, reg_chan
, node
.node
) {
7362 const int open_ret
=
7363 consumer_open_channel_packets(
7365 reg_chan
->consumer_key
);
7368 ret
= LTTNG_ERR_UNK
;
7375 case LTTNG_BUFFER_PER_PID
:
7377 struct ust_app
*app
;
7379 cds_lfht_for_each_entry (
7380 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7381 struct consumer_socket
*socket
;
7382 struct lttng_ht_iter chan_iter
;
7383 struct ust_app_channel
*ua_chan
;
7384 struct ust_app_session
*ua_sess
;
7385 struct ust_registry_session
*registry
;
7387 ua_sess
= lookup_session_by_app(usess
, app
);
7389 /* Session not associated with this app. */
7393 /* Get the right consumer socket for the application. */
7394 socket
= consumer_find_socket_by_bitness(
7395 app
->bits_per_long
, usess
->consumer
);
7397 ret
= LTTNG_ERR_FATAL
;
7401 registry
= get_session_registry(ua_sess
);
7403 DBG("Application session is being torn down. Skip application.");
7407 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7408 &chan_iter
.iter
, ua_chan
, node
.node
) {
7409 const int open_ret
=
7410 consumer_open_channel_packets(
7416 * Per-PID buffer and application going
7419 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7423 ret
= LTTNG_ERR_UNK
;