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/compat/errno.h>
22 #include <common/common.h>
23 #include <common/hashtable/utils.h>
24 #include <lttng/event-rule/event-rule.h>
25 #include <lttng/event-rule/event-rule-internal.h>
26 #include <lttng/event-rule/tracepoint.h>
27 #include <lttng/condition/condition.h>
28 #include <lttng/condition/event-rule-internal.h>
29 #include <lttng/condition/event-rule.h>
30 #include <common/sessiond-comm/sessiond-comm.h>
32 #include "buffer-registry.h"
34 #include "health-sessiond.h"
36 #include "ust-consumer.h"
37 #include "lttng-ust-ctl.h"
38 #include "lttng-ust-error.h"
41 #include "lttng-sessiond.h"
42 #include "notification-thread-commands.h"
45 struct lttng_ht
*ust_app_ht
;
46 struct lttng_ht
*ust_app_ht_by_sock
;
47 struct lttng_ht
*ust_app_ht_by_notify_sock
;
50 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
52 /* Next available channel key. Access under next_channel_key_lock. */
53 static uint64_t _next_channel_key
;
54 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
56 /* Next available session ID. Access under next_session_id_lock. */
57 static uint64_t _next_session_id
;
58 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
61 * Return the incremented value of next_channel_key.
63 static uint64_t get_next_channel_key(void)
67 pthread_mutex_lock(&next_channel_key_lock
);
68 ret
= ++_next_channel_key
;
69 pthread_mutex_unlock(&next_channel_key_lock
);
74 * Return the atomically incremented value of next_session_id.
76 static uint64_t get_next_session_id(void)
80 pthread_mutex_lock(&next_session_id_lock
);
81 ret
= ++_next_session_id
;
82 pthread_mutex_unlock(&next_session_id_lock
);
86 static void copy_channel_attr_to_ustctl(
87 struct ustctl_consumer_channel_attr
*attr
,
88 struct lttng_ust_channel_attr
*uattr
)
90 /* Copy event attributes since the layout is different. */
91 attr
->subbuf_size
= uattr
->subbuf_size
;
92 attr
->num_subbuf
= uattr
->num_subbuf
;
93 attr
->overwrite
= uattr
->overwrite
;
94 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
95 attr
->read_timer_interval
= uattr
->read_timer_interval
;
96 attr
->output
= uattr
->output
;
97 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
101 * Match function for the hash table lookup.
103 * It matches an ust app event based on three attributes which are the event
104 * name, the filter bytecode and the loglevel.
106 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
108 struct ust_app_event
*event
;
109 const struct ust_app_ht_key
*key
;
110 int ev_loglevel_value
;
115 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
117 ev_loglevel_value
= event
->attr
.loglevel
;
119 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
122 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
126 /* Event loglevel. */
127 if (ev_loglevel_value
!= key
->loglevel_type
) {
128 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
129 && key
->loglevel_type
== 0 &&
130 ev_loglevel_value
== -1) {
132 * Match is accepted. This is because on event creation, the
133 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
134 * -1 are accepted for this loglevel type since 0 is the one set by
135 * the API when receiving an enable event.
142 /* One of the filters is NULL, fail. */
143 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
147 if (key
->filter
&& event
->filter
) {
148 /* Both filters exists, check length followed by the bytecode. */
149 if (event
->filter
->len
!= key
->filter
->len
||
150 memcmp(event
->filter
->data
, key
->filter
->data
,
151 event
->filter
->len
) != 0) {
156 /* One of the exclusions is NULL, fail. */
157 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
161 if (key
->exclusion
&& event
->exclusion
) {
162 /* Both exclusions exists, check count followed by the names. */
163 if (event
->exclusion
->count
!= key
->exclusion
->count
||
164 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
165 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
179 * Unique add of an ust app event in the given ht. This uses the custom
180 * ht_match_ust_app_event match function and the event name as hash.
182 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
183 struct ust_app_event
*event
)
185 struct cds_lfht_node
*node_ptr
;
186 struct ust_app_ht_key key
;
190 assert(ua_chan
->events
);
193 ht
= ua_chan
->events
;
194 key
.name
= event
->attr
.name
;
195 key
.filter
= event
->filter
;
196 key
.loglevel_type
= event
->attr
.loglevel
;
197 key
.exclusion
= event
->exclusion
;
199 node_ptr
= cds_lfht_add_unique(ht
->ht
,
200 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
201 ht_match_ust_app_event
, &key
, &event
->node
.node
);
202 assert(node_ptr
== &event
->node
.node
);
206 * Close the notify socket from the given RCU head object. This MUST be called
207 * through a call_rcu().
209 static void close_notify_sock_rcu(struct rcu_head
*head
)
212 struct ust_app_notify_sock_obj
*obj
=
213 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
215 /* Must have a valid fd here. */
216 assert(obj
->fd
>= 0);
218 ret
= close(obj
->fd
);
220 ERR("close notify sock %d RCU", obj
->fd
);
222 lttng_fd_put(LTTNG_FD_APPS
, 1);
228 * Return the session registry according to the buffer type of the given
231 * A registry per UID object MUST exists before calling this function or else
232 * it assert() if not found. RCU read side lock must be acquired.
234 static struct ust_registry_session
*get_session_registry(
235 struct ust_app_session
*ua_sess
)
237 struct ust_registry_session
*registry
= NULL
;
241 switch (ua_sess
->buffer_type
) {
242 case LTTNG_BUFFER_PER_PID
:
244 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
248 registry
= reg_pid
->registry
->reg
.ust
;
251 case LTTNG_BUFFER_PER_UID
:
253 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
254 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
255 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
259 registry
= reg_uid
->registry
->reg
.ust
;
271 * Delete ust context safely. RCU read lock must be held before calling
275 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
283 pthread_mutex_lock(&app
->sock_lock
);
284 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
285 pthread_mutex_unlock(&app
->sock_lock
);
286 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
287 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
288 sock
, ua_ctx
->obj
->handle
, ret
);
296 * Delete ust app event safely. RCU read lock must be held before calling
300 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
307 free(ua_event
->filter
);
308 if (ua_event
->exclusion
!= NULL
)
309 free(ua_event
->exclusion
);
310 if (ua_event
->obj
!= NULL
) {
311 pthread_mutex_lock(&app
->sock_lock
);
312 ret
= ustctl_release_object(sock
, ua_event
->obj
);
313 pthread_mutex_unlock(&app
->sock_lock
);
314 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
315 ERR("UST app sock %d release event obj failed with ret %d",
324 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
325 * through a call_rcu().
328 void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
330 struct ust_app_event_notifier_rule
*obj
= caa_container_of(
331 head
, struct ust_app_event_notifier_rule
, rcu_head
);
337 * Delete ust app event notifier rule safely.
339 static void delete_ust_app_event_notifier_rule(int sock
,
340 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
,
345 assert(ua_event_notifier_rule
);
347 if (ua_event_notifier_rule
->exclusion
!= NULL
) {
348 free(ua_event_notifier_rule
->exclusion
);
351 if (ua_event_notifier_rule
->obj
!= NULL
) {
352 pthread_mutex_lock(&app
->sock_lock
);
353 ret
= ustctl_release_object(sock
, ua_event_notifier_rule
->obj
);
354 pthread_mutex_unlock(&app
->sock_lock
);
355 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
356 ERR("Failed to release event notifier object: app = '%s' (ppid %d), ret = %d",
357 app
->name
, (int) app
->ppid
, ret
);
360 free(ua_event_notifier_rule
->obj
);
363 lttng_event_rule_put(ua_event_notifier_rule
->event_rule
);
364 call_rcu(&ua_event_notifier_rule
->rcu_head
,
365 free_ust_app_event_notifier_rule_rcu
);
369 * Release ust data object of the given stream.
371 * Return 0 on success or else a negative value.
373 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
381 pthread_mutex_lock(&app
->sock_lock
);
382 ret
= ustctl_release_object(sock
, stream
->obj
);
383 pthread_mutex_unlock(&app
->sock_lock
);
384 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
385 ERR("UST app sock %d release stream obj failed with ret %d",
388 lttng_fd_put(LTTNG_FD_APPS
, 2);
396 * Delete ust app stream safely. RCU read lock must be held before calling
400 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
405 (void) release_ust_app_stream(sock
, stream
, app
);
410 * We need to execute ht_destroy outside of RCU read-side critical
411 * section and outside of call_rcu thread, so we postpone its execution
412 * using ht_cleanup_push. It is simpler than to change the semantic of
413 * the many callers of delete_ust_app_session().
416 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
418 struct ust_app_channel
*ua_chan
=
419 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
421 ht_cleanup_push(ua_chan
->ctx
);
422 ht_cleanup_push(ua_chan
->events
);
427 * Extract the lost packet or discarded events counter when the channel is
428 * being deleted and store the value in the parent channel so we can
429 * access it from lttng list and at stop/destroy.
431 * The session list lock must be held by the caller.
434 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
436 uint64_t discarded
= 0, lost
= 0;
437 struct ltt_session
*session
;
438 struct ltt_ust_channel
*uchan
;
440 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
445 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
446 if (!session
|| !session
->ust_session
) {
448 * Not finding the session is not an error because there are
449 * multiple ways the channels can be torn down.
451 * 1) The session daemon can initiate the destruction of the
452 * ust app session after receiving a destroy command or
453 * during its shutdown/teardown.
454 * 2) The application, since we are in per-pid tracing, is
455 * unregistering and tearing down its ust app session.
457 * Both paths are protected by the session list lock which
458 * ensures that the accounting of lost packets and discarded
459 * events is done exactly once. The session is then unpublished
460 * from the session list, resulting in this condition.
465 if (ua_chan
->attr
.overwrite
) {
466 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
467 ua_chan
->key
, session
->ust_session
->consumer
,
470 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
471 ua_chan
->key
, session
->ust_session
->consumer
,
474 uchan
= trace_ust_find_channel_by_name(
475 session
->ust_session
->domain_global
.channels
,
478 ERR("Missing UST channel to store discarded counters");
482 uchan
->per_pid_closed_app_discarded
+= discarded
;
483 uchan
->per_pid_closed_app_lost
+= lost
;
488 session_put(session
);
493 * Delete ust app channel safely. RCU read lock must be held before calling
496 * The session list lock must be held by the caller.
499 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
503 struct lttng_ht_iter iter
;
504 struct ust_app_event
*ua_event
;
505 struct ust_app_ctx
*ua_ctx
;
506 struct ust_app_stream
*stream
, *stmp
;
507 struct ust_registry_session
*registry
;
511 DBG3("UST app deleting channel %s", ua_chan
->name
);
514 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
515 cds_list_del(&stream
->list
);
516 delete_ust_app_stream(sock
, stream
, app
);
520 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
521 cds_list_del(&ua_ctx
->list
);
522 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
524 delete_ust_app_ctx(sock
, ua_ctx
, app
);
528 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
530 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
532 delete_ust_app_event(sock
, ua_event
, app
);
535 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
536 /* Wipe and free registry from session registry. */
537 registry
= get_session_registry(ua_chan
->session
);
539 ust_registry_channel_del_free(registry
, ua_chan
->key
,
543 * A negative socket can be used by the caller when
544 * cleaning-up a ua_chan in an error path. Skip the
545 * accounting in this case.
548 save_per_pid_lost_discarded_counters(ua_chan
);
552 if (ua_chan
->obj
!= NULL
) {
553 /* Remove channel from application UST object descriptor. */
554 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
555 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
557 pthread_mutex_lock(&app
->sock_lock
);
558 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
559 pthread_mutex_unlock(&app
->sock_lock
);
560 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
561 ERR("UST app sock %d release channel obj failed with ret %d",
564 lttng_fd_put(LTTNG_FD_APPS
, 1);
567 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
570 int ust_app_register_done(struct ust_app
*app
)
574 pthread_mutex_lock(&app
->sock_lock
);
575 ret
= ustctl_register_done(app
->sock
);
576 pthread_mutex_unlock(&app
->sock_lock
);
580 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
585 pthread_mutex_lock(&app
->sock_lock
);
590 ret
= ustctl_release_object(sock
, data
);
592 pthread_mutex_unlock(&app
->sock_lock
);
598 * Push metadata to consumer socket.
600 * RCU read-side lock must be held to guarantee existance of socket.
601 * Must be called with the ust app session lock held.
602 * Must be called with the registry lock held.
604 * On success, return the len of metadata pushed or else a negative value.
605 * Returning a -EPIPE return value means we could not send the metadata,
606 * but it can be caused by recoverable errors (e.g. the application has
607 * terminated concurrently).
609 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
610 struct consumer_socket
*socket
, int send_zero_data
)
613 char *metadata_str
= NULL
;
614 size_t len
, offset
, new_metadata_len_sent
;
616 uint64_t metadata_key
, metadata_version
;
621 metadata_key
= registry
->metadata_key
;
624 * Means that no metadata was assigned to the session. This can
625 * happens if no start has been done previously.
631 offset
= registry
->metadata_len_sent
;
632 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
633 new_metadata_len_sent
= registry
->metadata_len
;
634 metadata_version
= registry
->metadata_version
;
636 DBG3("No metadata to push for metadata key %" PRIu64
,
637 registry
->metadata_key
);
639 if (send_zero_data
) {
640 DBG("No metadata to push");
646 /* Allocate only what we have to send. */
647 metadata_str
= zmalloc(len
);
649 PERROR("zmalloc ust app metadata string");
653 /* Copy what we haven't sent out. */
654 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
657 pthread_mutex_unlock(®istry
->lock
);
659 * We need to unlock the registry while we push metadata to
660 * break a circular dependency between the consumerd metadata
661 * lock and the sessiond registry lock. Indeed, pushing metadata
662 * to the consumerd awaits that it gets pushed all the way to
663 * relayd, but doing so requires grabbing the metadata lock. If
664 * a concurrent metadata request is being performed by
665 * consumerd, this can try to grab the registry lock on the
666 * sessiond while holding the metadata lock on the consumer
667 * daemon. Those push and pull schemes are performed on two
668 * different bidirectionnal communication sockets.
670 ret
= consumer_push_metadata(socket
, metadata_key
,
671 metadata_str
, len
, offset
, metadata_version
);
672 pthread_mutex_lock(®istry
->lock
);
675 * There is an acceptable race here between the registry
676 * metadata key assignment and the creation on the
677 * consumer. The session daemon can concurrently push
678 * metadata for this registry while being created on the
679 * consumer since the metadata key of the registry is
680 * assigned *before* it is setup to avoid the consumer
681 * to ask for metadata that could possibly be not found
682 * in the session daemon.
684 * The metadata will get pushed either by the session
685 * being stopped or the consumer requesting metadata if
686 * that race is triggered.
688 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
691 ERR("Error pushing metadata to consumer");
697 * Metadata may have been concurrently pushed, since
698 * we're not holding the registry lock while pushing to
699 * consumer. This is handled by the fact that we send
700 * the metadata content, size, and the offset at which
701 * that metadata belongs. This may arrive out of order
702 * on the consumer side, and the consumer is able to
703 * deal with overlapping fragments. The consumer
704 * supports overlapping fragments, which must be
705 * contiguous starting from offset 0. We keep the
706 * largest metadata_len_sent value of the concurrent
709 registry
->metadata_len_sent
=
710 max_t(size_t, registry
->metadata_len_sent
,
711 new_metadata_len_sent
);
720 * On error, flag the registry that the metadata is
721 * closed. We were unable to push anything and this
722 * means that either the consumer is not responding or
723 * the metadata cache has been destroyed on the
726 registry
->metadata_closed
= 1;
734 * For a given application and session, push metadata to consumer.
735 * Either sock or consumer is required : if sock is NULL, the default
736 * socket to send the metadata is retrieved from consumer, if sock
737 * is not NULL we use it to send the metadata.
738 * RCU read-side lock must be held while calling this function,
739 * therefore ensuring existance of registry. It also ensures existance
740 * of socket throughout this function.
742 * Return 0 on success else a negative error.
743 * Returning a -EPIPE return value means we could not send the metadata,
744 * but it can be caused by recoverable errors (e.g. the application has
745 * terminated concurrently).
747 static int push_metadata(struct ust_registry_session
*registry
,
748 struct consumer_output
*consumer
)
752 struct consumer_socket
*socket
;
757 pthread_mutex_lock(®istry
->lock
);
758 if (registry
->metadata_closed
) {
763 /* Get consumer socket to use to push the metadata.*/
764 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
771 ret
= ust_app_push_metadata(registry
, socket
, 0);
776 pthread_mutex_unlock(®istry
->lock
);
780 pthread_mutex_unlock(®istry
->lock
);
785 * Send to the consumer a close metadata command for the given session. Once
786 * done, the metadata channel is deleted and the session metadata pointer is
787 * nullified. The session lock MUST be held unless the application is
788 * in the destroy path.
790 * Do not hold the registry lock while communicating with the consumerd, because
791 * doing so causes inter-process deadlocks between consumerd and sessiond with
792 * the metadata request notification.
794 * Return 0 on success else a negative value.
796 static int close_metadata(struct ust_registry_session
*registry
,
797 struct consumer_output
*consumer
)
800 struct consumer_socket
*socket
;
801 uint64_t metadata_key
;
802 bool registry_was_already_closed
;
809 pthread_mutex_lock(®istry
->lock
);
810 metadata_key
= registry
->metadata_key
;
811 registry_was_already_closed
= registry
->metadata_closed
;
812 if (metadata_key
!= 0) {
814 * Metadata closed. Even on error this means that the consumer
815 * is not responding or not found so either way a second close
816 * should NOT be emit for this registry.
818 registry
->metadata_closed
= 1;
820 pthread_mutex_unlock(®istry
->lock
);
822 if (metadata_key
== 0 || registry_was_already_closed
) {
827 /* Get consumer socket to use to push the metadata.*/
828 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
835 ret
= consumer_close_metadata(socket
, metadata_key
);
846 * We need to execute ht_destroy outside of RCU read-side critical
847 * section and outside of call_rcu thread, so we postpone its execution
848 * using ht_cleanup_push. It is simpler than to change the semantic of
849 * the many callers of delete_ust_app_session().
852 void delete_ust_app_session_rcu(struct rcu_head
*head
)
854 struct ust_app_session
*ua_sess
=
855 caa_container_of(head
, struct ust_app_session
, rcu_head
);
857 ht_cleanup_push(ua_sess
->channels
);
862 * Delete ust app session safely. RCU read lock must be held before calling
865 * The session list lock must be held by the caller.
868 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
872 struct lttng_ht_iter iter
;
873 struct ust_app_channel
*ua_chan
;
874 struct ust_registry_session
*registry
;
878 pthread_mutex_lock(&ua_sess
->lock
);
880 assert(!ua_sess
->deleted
);
881 ua_sess
->deleted
= true;
883 registry
= get_session_registry(ua_sess
);
884 /* Registry can be null on error path during initialization. */
886 /* Push metadata for application before freeing the application. */
887 (void) push_metadata(registry
, ua_sess
->consumer
);
890 * Don't ask to close metadata for global per UID buffers. Close
891 * metadata only on destroy trace session in this case. Also, the
892 * previous push metadata could have flag the metadata registry to
893 * close so don't send a close command if closed.
895 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
896 /* And ask to close it for this session registry. */
897 (void) close_metadata(registry
, ua_sess
->consumer
);
901 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
903 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
905 delete_ust_app_channel(sock
, ua_chan
, app
);
908 /* In case of per PID, the registry is kept in the session. */
909 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
910 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
913 * Registry can be null on error path during
916 buffer_reg_pid_remove(reg_pid
);
917 buffer_reg_pid_destroy(reg_pid
);
921 if (ua_sess
->handle
!= -1) {
922 pthread_mutex_lock(&app
->sock_lock
);
923 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
924 pthread_mutex_unlock(&app
->sock_lock
);
925 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
926 ERR("UST app sock %d release session handle failed with ret %d",
929 /* Remove session from application UST object descriptor. */
930 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
931 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
935 pthread_mutex_unlock(&ua_sess
->lock
);
937 consumer_output_put(ua_sess
->consumer
);
939 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
943 * Delete a traceable application structure from the global list. Never call
944 * this function outside of a call_rcu call.
946 * RCU read side lock should _NOT_ be held when calling this function.
949 void delete_ust_app(struct ust_app
*app
)
952 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
953 struct lttng_ht_iter iter
;
954 struct ust_app_event_notifier_rule
*event_notifier_rule
;
957 * The session list lock must be held during this function to guarantee
958 * the existence of ua_sess.
961 /* Delete ust app sessions info */
966 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
968 /* Free every object in the session and the session. */
970 delete_ust_app_session(sock
, ua_sess
, app
);
974 /* Remove the event notifier rules associated with this app. */
976 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
977 &iter
.iter
, event_notifier_rule
, node
.node
) {
978 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
981 delete_ust_app_event_notifier_rule(
982 app
->sock
, event_notifier_rule
, app
);
987 ht_cleanup_push(app
->sessions
);
988 ht_cleanup_push(app
->ust_sessions_objd
);
989 ht_cleanup_push(app
->ust_objd
);
990 ht_cleanup_push(app
->token_to_event_notifier_rule_ht
);
993 * This could be NULL if the event notifier setup failed (e.g the app
994 * was killed or the tracer does not support this feature).
996 if (app
->event_notifier_group
.object
) {
997 enum lttng_error_code ret_code
;
998 const int event_notifier_read_fd
= lttng_pipe_get_readfd(
999 app
->event_notifier_group
.event_pipe
);
1001 ret_code
= notification_thread_command_remove_tracer_event_source(
1002 notification_thread_handle
,
1003 event_notifier_read_fd
);
1004 if (ret_code
!= LTTNG_OK
) {
1005 ERR("Failed to remove application tracer event source from notification thread");
1008 ustctl_release_object(sock
, app
->event_notifier_group
.object
);
1009 free(app
->event_notifier_group
.object
);
1012 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1015 * Wait until we have deleted the application from the sock hash table
1016 * before closing this socket, otherwise an application could re-use the
1017 * socket ID and race with the teardown, using the same hash table entry.
1019 * It's OK to leave the close in call_rcu. We want it to stay unique for
1020 * all RCU readers that could run concurrently with unregister app,
1021 * therefore we _need_ to only close that socket after a grace period. So
1022 * it should stay in this RCU callback.
1024 * This close() is a very important step of the synchronization model so
1025 * every modification to this function must be carefully reviewed.
1031 lttng_fd_put(LTTNG_FD_APPS
, 1);
1033 DBG2("UST app pid %d deleted", app
->pid
);
1035 session_unlock_list();
1039 * URCU intermediate call to delete an UST app.
1042 void delete_ust_app_rcu(struct rcu_head
*head
)
1044 struct lttng_ht_node_ulong
*node
=
1045 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1046 struct ust_app
*app
=
1047 caa_container_of(node
, struct ust_app
, pid_n
);
1049 DBG3("Call RCU deleting app PID %d", app
->pid
);
1050 delete_ust_app(app
);
1054 * Delete the session from the application ht and delete the data structure by
1055 * freeing every object inside and releasing them.
1057 * The session list lock must be held by the caller.
1059 static void destroy_app_session(struct ust_app
*app
,
1060 struct ust_app_session
*ua_sess
)
1063 struct lttng_ht_iter iter
;
1068 iter
.iter
.node
= &ua_sess
->node
.node
;
1069 ret
= lttng_ht_del(app
->sessions
, &iter
);
1071 /* Already scheduled for teardown. */
1075 /* Once deleted, free the data structure. */
1076 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1083 * Alloc new UST app session.
1086 struct ust_app_session
*alloc_ust_app_session(void)
1088 struct ust_app_session
*ua_sess
;
1090 /* Init most of the default value by allocating and zeroing */
1091 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1092 if (ua_sess
== NULL
) {
1097 ua_sess
->handle
= -1;
1098 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1099 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1100 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1109 * Alloc new UST app channel.
1112 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1113 struct ust_app_session
*ua_sess
,
1114 struct lttng_ust_channel_attr
*attr
)
1116 struct ust_app_channel
*ua_chan
;
1118 /* Init most of the default value by allocating and zeroing */
1119 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1120 if (ua_chan
== NULL
) {
1125 /* Setup channel name */
1126 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1127 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1129 ua_chan
->enabled
= 1;
1130 ua_chan
->handle
= -1;
1131 ua_chan
->session
= ua_sess
;
1132 ua_chan
->key
= get_next_channel_key();
1133 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1134 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1135 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1137 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1138 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1140 /* Copy attributes */
1142 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1143 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1144 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1145 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1146 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1147 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1148 ua_chan
->attr
.output
= attr
->output
;
1149 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1151 /* By default, the channel is a per cpu channel. */
1152 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1154 DBG3("UST app channel %s allocated", ua_chan
->name
);
1163 * Allocate and initialize a UST app stream.
1165 * Return newly allocated stream pointer or NULL on error.
1167 struct ust_app_stream
*ust_app_alloc_stream(void)
1169 struct ust_app_stream
*stream
= NULL
;
1171 stream
= zmalloc(sizeof(*stream
));
1172 if (stream
== NULL
) {
1173 PERROR("zmalloc ust app stream");
1177 /* Zero could be a valid value for a handle so flag it to -1. */
1178 stream
->handle
= -1;
1185 * Alloc new UST app event.
1188 struct ust_app_event
*alloc_ust_app_event(char *name
,
1189 struct lttng_ust_event
*attr
)
1191 struct ust_app_event
*ua_event
;
1193 /* Init most of the default value by allocating and zeroing */
1194 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1195 if (ua_event
== NULL
) {
1196 PERROR("Failed to allocate ust_app_event structure");
1200 ua_event
->enabled
= 1;
1201 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1202 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1203 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1205 /* Copy attributes */
1207 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1210 DBG3("UST app event %s allocated", ua_event
->name
);
1219 * Allocate a new UST app event notifier rule.
1221 static struct ust_app_event_notifier_rule
*alloc_ust_app_event_notifier_rule(
1222 struct lttng_event_rule
*event_rule
, uint64_t token
)
1224 enum lttng_event_rule_generate_exclusions_status
1225 generate_exclusion_status
;
1226 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1228 ua_event_notifier_rule
= zmalloc(sizeof(struct ust_app_event_notifier_rule
));
1229 if (ua_event_notifier_rule
== NULL
) {
1230 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1234 ua_event_notifier_rule
->enabled
= 1;
1235 ua_event_notifier_rule
->token
= token
;
1236 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
, token
);
1238 /* Get reference of the event rule. */
1239 if (!lttng_event_rule_get(event_rule
)) {
1243 ua_event_notifier_rule
->event_rule
= event_rule
;
1244 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1245 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1246 event_rule
, &ua_event_notifier_rule
->exclusion
);
1247 switch (generate_exclusion_status
) {
1248 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1249 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1252 /* Error occured. */
1253 ERR("Failed to generate exclusions from event rule while allocating an event notifier rule");
1254 goto error_put_event_rule
;
1257 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1258 ua_event_notifier_rule
->token
);
1260 return ua_event_notifier_rule
;
1262 error_put_event_rule
:
1263 lttng_event_rule_put(event_rule
);
1265 free(ua_event_notifier_rule
);
1270 * Alloc new UST app context.
1273 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1275 struct ust_app_ctx
*ua_ctx
;
1277 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1278 if (ua_ctx
== NULL
) {
1282 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1285 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1286 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1287 char *provider_name
= NULL
, *ctx_name
= NULL
;
1289 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1290 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1291 if (!provider_name
|| !ctx_name
) {
1292 free(provider_name
);
1297 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1298 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1302 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1310 * Allocate a filter and copy the given original filter.
1312 * Return allocated filter or NULL on error.
1314 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1315 struct lttng_filter_bytecode
*orig_f
)
1317 struct lttng_filter_bytecode
*filter
= NULL
;
1319 /* Copy filter bytecode */
1320 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1322 PERROR("zmalloc alloc filter bytecode");
1326 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1333 * Create a liblttng-ust filter bytecode from given bytecode.
1335 * Return allocated filter or NULL on error.
1337 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1338 const struct lttng_filter_bytecode
*orig_f
)
1340 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1342 /* Copy filter bytecode */
1343 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1345 PERROR("zmalloc alloc ust filter bytecode");
1349 assert(sizeof(struct lttng_filter_bytecode
) ==
1350 sizeof(struct lttng_ust_filter_bytecode
));
1351 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1357 * Find an ust_app using the sock and return it. RCU read side lock must be
1358 * held before calling this helper function.
1360 struct ust_app
*ust_app_find_by_sock(int sock
)
1362 struct lttng_ht_node_ulong
*node
;
1363 struct lttng_ht_iter iter
;
1365 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1366 node
= lttng_ht_iter_get_node_ulong(&iter
);
1368 DBG2("UST app find by sock %d not found", sock
);
1372 return caa_container_of(node
, struct ust_app
, sock_n
);
1379 * Find an ust_app using the notify sock and return it. RCU read side lock must
1380 * be held before calling this helper function.
1382 static struct ust_app
*find_app_by_notify_sock(int sock
)
1384 struct lttng_ht_node_ulong
*node
;
1385 struct lttng_ht_iter iter
;
1387 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1389 node
= lttng_ht_iter_get_node_ulong(&iter
);
1391 DBG2("UST app find by notify sock %d not found", sock
);
1395 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1402 * Lookup for an ust app event based on event name, filter bytecode and the
1405 * Return an ust_app_event object or NULL on error.
1407 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1408 const char *name
, const struct lttng_filter_bytecode
*filter
,
1410 const struct lttng_event_exclusion
*exclusion
)
1412 struct lttng_ht_iter iter
;
1413 struct lttng_ht_node_str
*node
;
1414 struct ust_app_event
*event
= NULL
;
1415 struct ust_app_ht_key key
;
1420 /* Setup key for event lookup. */
1422 key
.filter
= filter
;
1423 key
.loglevel_type
= loglevel_value
;
1424 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1425 key
.exclusion
= exclusion
;
1427 /* Lookup using the event name as hash and a custom match fct. */
1428 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1429 ht_match_ust_app_event
, &key
, &iter
.iter
);
1430 node
= lttng_ht_iter_get_node_str(&iter
);
1435 event
= caa_container_of(node
, struct ust_app_event
, node
);
1442 * Look-up an event notifier rule based on its token id.
1444 * Must be called with the RCU read lock held.
1445 * Return an ust_app_event_notifier_rule object or NULL on error.
1447 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1448 struct lttng_ht
*ht
, uint64_t token
)
1450 struct lttng_ht_iter iter
;
1451 struct lttng_ht_node_u64
*node
;
1452 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1456 lttng_ht_lookup(ht
, &token
, &iter
);
1457 node
= lttng_ht_iter_get_node_u64(&iter
);
1459 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1464 event_notifier_rule
= caa_container_of(
1465 node
, struct ust_app_event_notifier_rule
, node
);
1467 return event_notifier_rule
;
1471 * Create the channel context on the tracer.
1473 * Called with UST app session lock held.
1476 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1477 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1481 health_code_update();
1483 pthread_mutex_lock(&app
->sock_lock
);
1484 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1485 ua_chan
->obj
, &ua_ctx
->obj
);
1486 pthread_mutex_unlock(&app
->sock_lock
);
1488 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1489 ERR("UST app create channel context failed for app (pid: %d) "
1490 "with ret %d", app
->pid
, ret
);
1493 * This is normal behavior, an application can die during the
1494 * creation process. Don't report an error so the execution can
1495 * continue normally.
1498 DBG3("UST app add context failed. Application is dead.");
1503 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1505 DBG2("UST app context handle %d created successfully for channel %s",
1506 ua_ctx
->handle
, ua_chan
->name
);
1509 health_code_update();
1514 * Set the filter on the tracer.
1516 static int set_ust_object_filter(struct ust_app
*app
,
1517 const struct lttng_filter_bytecode
*bytecode
,
1518 struct lttng_ust_object_data
*ust_object
)
1521 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1523 health_code_update();
1525 ust_bytecode
= create_ust_bytecode_from_bytecode(bytecode
);
1526 if (!ust_bytecode
) {
1527 ret
= -LTTNG_ERR_NOMEM
;
1530 pthread_mutex_lock(&app
->sock_lock
);
1531 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1533 pthread_mutex_unlock(&app
->sock_lock
);
1535 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1536 ERR("UST app set object filter failed for object %p of app (pid: %d) "
1537 "with ret %d", ust_object
, app
->pid
, ret
);
1540 * This is normal behavior, an application can die during the
1541 * creation process. Don't report an error so the execution can
1542 * continue normally.
1545 DBG3("Failed to set UST app object filter. Application is dead.");
1550 DBG2("UST filter successfully set for object %p", ust_object
);
1553 health_code_update();
1559 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1560 const struct lttng_event_exclusion
*exclusion
)
1562 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1563 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1564 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1566 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1567 if (!ust_exclusion
) {
1572 assert(sizeof(struct lttng_event_exclusion
) ==
1573 sizeof(struct lttng_ust_event_exclusion
));
1574 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1576 return ust_exclusion
;
1580 * Set event exclusions on the tracer.
1582 static int set_ust_object_exclusions(struct ust_app
*app
,
1583 const struct lttng_event_exclusion
*exclusions
,
1584 struct lttng_ust_object_data
*ust_object
)
1587 struct lttng_ust_event_exclusion
*ust_exclusions
= NULL
;
1589 assert(exclusions
&& exclusions
->count
> 0);
1591 health_code_update();
1593 ust_exclusions
= create_ust_exclusion_from_exclusion(
1595 if (!ust_exclusions
) {
1596 ret
= -LTTNG_ERR_NOMEM
;
1599 pthread_mutex_lock(&app
->sock_lock
);
1600 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1601 pthread_mutex_unlock(&app
->sock_lock
);
1603 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1604 ERR("Failed to set UST app exclusions for object %p of app (pid: %d) "
1605 "with ret %d", ust_object
, app
->pid
, ret
);
1608 * This is normal behavior, an application can die during the
1609 * creation process. Don't report an error so the execution can
1610 * continue normally.
1613 DBG3("Failed to set UST app object exclusions. Application is dead.");
1618 DBG2("UST exclusions set successfully for object %p", ust_object
);
1621 health_code_update();
1622 free(ust_exclusions
);
1627 * Disable the specified event on to UST tracer for the UST session.
1629 static int disable_ust_object(struct ust_app
*app
,
1630 struct lttng_ust_object_data
*object
)
1634 health_code_update();
1636 pthread_mutex_lock(&app
->sock_lock
);
1637 ret
= ustctl_disable(app
->sock
, object
);
1638 pthread_mutex_unlock(&app
->sock_lock
);
1640 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1641 ERR("Failed to disable UST app object %p app (pid: %d) with ret %d",
1642 object
, app
->pid
, ret
);
1645 * This is normal behavior, an application can die during the
1646 * creation process. Don't report an error so the execution can
1647 * continue normally.
1650 DBG3("Failed to disable UST app object. Application is dead.");
1655 DBG2("UST app object %p disabled successfully for app (pid: %d)",
1659 health_code_update();
1664 * Disable the specified channel on to UST tracer for the UST session.
1666 static int disable_ust_channel(struct ust_app
*app
,
1667 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1671 health_code_update();
1673 pthread_mutex_lock(&app
->sock_lock
);
1674 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1675 pthread_mutex_unlock(&app
->sock_lock
);
1677 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1678 ERR("UST app channel %s disable failed for app (pid: %d) "
1679 "and session handle %d with ret %d",
1680 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1683 * This is normal behavior, an application can die during the
1684 * creation process. Don't report an error so the execution can
1685 * continue normally.
1688 DBG3("UST app disable channel failed. Application is dead.");
1693 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1694 ua_chan
->name
, app
->pid
);
1697 health_code_update();
1702 * Enable the specified channel on to UST tracer for the UST session.
1704 static int enable_ust_channel(struct ust_app
*app
,
1705 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1709 health_code_update();
1711 pthread_mutex_lock(&app
->sock_lock
);
1712 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1713 pthread_mutex_unlock(&app
->sock_lock
);
1715 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1716 ERR("UST app channel %s enable failed for app (pid: %d) "
1717 "and session handle %d with ret %d",
1718 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1721 * This is normal behavior, an application can die during the
1722 * creation process. Don't report an error so the execution can
1723 * continue normally.
1726 DBG3("UST app enable channel failed. Application is dead.");
1731 ua_chan
->enabled
= 1;
1733 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1734 ua_chan
->name
, app
->pid
);
1737 health_code_update();
1742 * Enable the specified event on to UST tracer for the UST session.
1744 static int enable_ust_object(
1745 struct ust_app
*app
, struct lttng_ust_object_data
*ust_object
)
1749 health_code_update();
1751 pthread_mutex_lock(&app
->sock_lock
);
1752 ret
= ustctl_enable(app
->sock
, ust_object
);
1753 pthread_mutex_unlock(&app
->sock_lock
);
1755 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1756 ERR("UST app enable failed for object %p app (pid: %d) with ret %d",
1757 ust_object
, app
->pid
, ret
);
1760 * This is normal behavior, an application can die during the
1761 * creation process. Don't report an error so the execution can
1762 * continue normally.
1765 DBG3("Failed to enable UST app object. Application is dead.");
1770 DBG2("UST app object %p enabled successfully for app (pid: %d)",
1771 ust_object
, app
->pid
);
1774 health_code_update();
1779 * Send channel and stream buffer to application.
1781 * Return 0 on success. On error, a negative value is returned.
1783 static int send_channel_pid_to_ust(struct ust_app
*app
,
1784 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1787 struct ust_app_stream
*stream
, *stmp
;
1793 health_code_update();
1795 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1798 /* Send channel to the application. */
1799 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1800 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1801 ret
= -ENOTCONN
; /* Caused by app exiting. */
1803 } else if (ret
< 0) {
1807 health_code_update();
1809 /* Send all streams to application. */
1810 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1811 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1812 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1813 ret
= -ENOTCONN
; /* Caused by app exiting. */
1815 } else if (ret
< 0) {
1818 /* We don't need the stream anymore once sent to the tracer. */
1819 cds_list_del(&stream
->list
);
1820 delete_ust_app_stream(-1, stream
, app
);
1822 /* Flag the channel that it is sent to the application. */
1823 ua_chan
->is_sent
= 1;
1826 health_code_update();
1831 * Create the specified event onto the UST tracer for a UST session.
1833 * Should be called with session mutex held.
1836 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1837 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1841 health_code_update();
1843 /* Create UST event on tracer */
1844 pthread_mutex_lock(&app
->sock_lock
);
1845 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1847 pthread_mutex_unlock(&app
->sock_lock
);
1849 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1851 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1852 ua_event
->attr
.name
, app
->pid
, ret
);
1855 * This is normal behavior, an application can die during the
1856 * creation process. Don't report an error so the execution can
1857 * continue normally.
1860 DBG3("UST app create event failed. Application is dead.");
1865 ua_event
->handle
= ua_event
->obj
->handle
;
1867 DBG2("UST app event %s created successfully for pid:%d object: %p",
1868 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
1870 health_code_update();
1872 /* Set filter if one is present. */
1873 if (ua_event
->filter
) {
1874 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
1880 /* Set exclusions for the event */
1881 if (ua_event
->exclusion
) {
1882 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
1888 /* If event not enabled, disable it on the tracer */
1889 if (ua_event
->enabled
) {
1891 * We now need to explicitly enable the event, since it
1892 * is now disabled at creation.
1894 ret
= enable_ust_object(app
, ua_event
->obj
);
1897 * If we hit an EPERM, something is wrong with our enable call. If
1898 * we get an EEXIST, there is a problem on the tracer side since we
1902 case -LTTNG_UST_ERR_PERM
:
1903 /* Code flow problem */
1905 case -LTTNG_UST_ERR_EXIST
:
1906 /* It's OK for our use case. */
1917 health_code_update();
1921 static int init_ust_event_notifier_from_event_rule(
1922 const struct lttng_event_rule
*rule
,
1923 struct lttng_ust_event_notifier
*event_notifier
)
1925 enum lttng_event_rule_status status
;
1926 enum lttng_loglevel_type loglevel_type
;
1927 enum lttng_ust_loglevel_type ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1928 int loglevel
= -1, ret
= 0;
1929 const char *pattern
;
1931 /* For now only LTTNG_EVENT_RULE_TYPE_TRACEPOINT are supported. */
1932 assert(lttng_event_rule_get_type(rule
) ==
1933 LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
1935 memset(event_notifier
, 0, sizeof(*event_notifier
));
1937 status
= lttng_event_rule_tracepoint_get_pattern(rule
, &pattern
);
1938 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1939 /* At this point, this is a fatal error. */
1943 status
= lttng_event_rule_tracepoint_get_log_level_type(
1944 rule
, &loglevel_type
);
1945 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1946 /* At this point, this is a fatal error. */
1950 switch (loglevel_type
) {
1951 case LTTNG_EVENT_LOGLEVEL_ALL
:
1952 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1954 case LTTNG_EVENT_LOGLEVEL_RANGE
:
1955 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
1957 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
1958 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
1961 /* Unknown log level specification type. */
1965 if (loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1966 status
= lttng_event_rule_tracepoint_get_log_level(
1968 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
1971 event_notifier
->event
.instrumentation
= LTTNG_UST_TRACEPOINT
;
1972 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
1973 LTTNG_UST_SYM_NAME_LEN
- 1);
1975 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
1980 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
1981 event_notifier
->event
.loglevel
= loglevel
;
1987 * Create the specified event notifier against the user space tracer of a
1988 * given application.
1990 static int create_ust_event_notifier(struct ust_app
*app
,
1991 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
1994 struct lttng_ust_event_notifier event_notifier
;
1996 health_code_update();
1997 assert(app
->event_notifier_group
.object
);
1999 ret
= init_ust_event_notifier_from_event_rule(
2000 ua_event_notifier_rule
->event_rule
, &event_notifier
);
2002 ERR("Failed to initialize UST event notifier from event rule: app = '%s' (ppid: %d)",
2003 app
->name
, app
->ppid
);
2007 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2009 /* Create UST event notifier against the tracer. */
2010 pthread_mutex_lock(&app
->sock_lock
);
2011 ret
= ustctl_create_event_notifier(app
->sock
, &event_notifier
,
2012 app
->event_notifier_group
.object
,
2013 &ua_event_notifier_rule
->obj
);
2014 pthread_mutex_unlock(&app
->sock_lock
);
2016 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2017 ERR("Error ustctl create event notifier: name = '%s', app = '%s' (ppid: %d), ret = %d",
2018 event_notifier
.event
.name
, app
->name
,
2022 * This is normal behavior, an application can die
2023 * during the creation process. Don't report an error so
2024 * the execution can continue normally.
2027 DBG3("UST app create event notifier failed (application is dead): app = '%s' (ppid = %d)",
2028 app
->name
, app
->ppid
);
2034 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2036 DBG2("UST app event notifier %s created successfully: app = '%s' (ppid: %d), object: %p",
2037 event_notifier
.event
.name
, app
->name
, app
->ppid
,
2038 ua_event_notifier_rule
->obj
);
2040 health_code_update();
2042 /* Set filter if one is present. */
2043 if (ua_event_notifier_rule
->filter
) {
2044 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2045 ua_event_notifier_rule
->obj
);
2051 /* Set exclusions for the event. */
2052 if (ua_event_notifier_rule
->exclusion
) {
2053 ret
= set_ust_object_exclusions(app
,
2054 ua_event_notifier_rule
->exclusion
,
2055 ua_event_notifier_rule
->obj
);
2062 * We now need to explicitly enable the event, since it
2063 * is disabled at creation.
2065 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2068 * If we hit an EPERM, something is wrong with our enable call.
2069 * If we get an EEXIST, there is a problem on the tracer side
2070 * since we just created it.
2073 case -LTTNG_UST_ERR_PERM
:
2074 /* Code flow problem. */
2076 case -LTTNG_UST_ERR_EXIST
:
2077 /* It's OK for our use case. */
2087 ua_event_notifier_rule
->enabled
= true;
2090 health_code_update();
2095 * Copy data between an UST app event and a LTT event.
2097 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2098 struct ltt_ust_event
*uevent
)
2100 size_t exclusion_alloc_size
;
2102 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2103 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2105 ua_event
->enabled
= uevent
->enabled
;
2107 /* Copy event attributes */
2108 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2110 /* Copy filter bytecode */
2111 if (uevent
->filter
) {
2112 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
2113 /* Filter might be NULL here in case of ENONEM. */
2116 /* Copy exclusion data */
2117 if (uevent
->exclusion
) {
2118 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2119 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2120 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2121 if (ua_event
->exclusion
== NULL
) {
2124 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2125 exclusion_alloc_size
);
2131 * Copy data between an UST app channel and a LTT channel.
2133 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2134 struct ltt_ust_channel
*uchan
)
2136 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2138 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2139 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2141 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2142 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2144 /* Copy event attributes since the layout is different. */
2145 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2146 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2147 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2148 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2149 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2150 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2151 ua_chan
->attr
.output
= uchan
->attr
.output
;
2152 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2155 * Note that the attribute channel type is not set since the channel on the
2156 * tracing registry side does not have this information.
2159 ua_chan
->enabled
= uchan
->enabled
;
2160 ua_chan
->tracing_channel_id
= uchan
->id
;
2162 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2166 * Copy data between a UST app session and a regular LTT session.
2168 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2169 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2171 struct tm
*timeinfo
;
2174 char tmp_shm_path
[PATH_MAX
];
2176 timeinfo
= localtime(&app
->registration_time
);
2177 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2179 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2181 ua_sess
->tracing_id
= usess
->id
;
2182 ua_sess
->id
= get_next_session_id();
2183 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2184 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2185 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2186 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2187 ua_sess
->buffer_type
= usess
->buffer_type
;
2188 ua_sess
->bits_per_long
= app
->bits_per_long
;
2190 /* There is only one consumer object per session possible. */
2191 consumer_output_get(usess
->consumer
);
2192 ua_sess
->consumer
= usess
->consumer
;
2194 ua_sess
->output_traces
= usess
->output_traces
;
2195 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2196 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2197 &usess
->metadata_attr
);
2199 switch (ua_sess
->buffer_type
) {
2200 case LTTNG_BUFFER_PER_PID
:
2201 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2202 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2205 case LTTNG_BUFFER_PER_UID
:
2206 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2207 DEFAULT_UST_TRACE_UID_PATH
,
2208 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2209 app
->bits_per_long
);
2216 PERROR("asprintf UST shadow copy session");
2221 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2222 sizeof(ua_sess
->root_shm_path
));
2223 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2224 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2225 sizeof(ua_sess
->shm_path
));
2226 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2227 if (ua_sess
->shm_path
[0]) {
2228 switch (ua_sess
->buffer_type
) {
2229 case LTTNG_BUFFER_PER_PID
:
2230 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2231 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2232 app
->name
, app
->pid
, datetime
);
2234 case LTTNG_BUFFER_PER_UID
:
2235 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2236 "/" DEFAULT_UST_TRACE_UID_PATH
,
2237 app
->uid
, app
->bits_per_long
);
2244 PERROR("sprintf UST shadow copy session");
2248 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2249 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2250 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2255 consumer_output_put(ua_sess
->consumer
);
2259 * Lookup sesison wrapper.
2262 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2263 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2265 /* Get right UST app session from app */
2266 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2270 * Return ust app session from the app session hashtable using the UST session
2273 static struct ust_app_session
*lookup_session_by_app(
2274 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2276 struct lttng_ht_iter iter
;
2277 struct lttng_ht_node_u64
*node
;
2279 __lookup_session_by_app(usess
, app
, &iter
);
2280 node
= lttng_ht_iter_get_node_u64(&iter
);
2285 return caa_container_of(node
, struct ust_app_session
, node
);
2292 * Setup buffer registry per PID for the given session and application. If none
2293 * is found, a new one is created, added to the global registry and
2294 * initialized. If regp is valid, it's set with the newly created object.
2296 * Return 0 on success or else a negative value.
2298 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2299 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2302 struct buffer_reg_pid
*reg_pid
;
2309 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2312 * This is the create channel path meaning that if there is NO
2313 * registry available, we have to create one for this session.
2315 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2316 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2324 /* Initialize registry. */
2325 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2326 app
->bits_per_long
, app
->uint8_t_alignment
,
2327 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2328 app
->uint64_t_alignment
, app
->long_alignment
,
2329 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2330 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2331 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2332 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2333 ua_sess
->tracing_id
,
2337 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2338 * destroy the buffer registry, because it is always expected
2339 * that if the buffer registry can be found, its ust registry is
2342 buffer_reg_pid_destroy(reg_pid
);
2346 buffer_reg_pid_add(reg_pid
);
2348 DBG3("UST app buffer registry per PID created successfully");
2360 * Setup buffer registry per UID for the given session and application. If none
2361 * is found, a new one is created, added to the global registry and
2362 * initialized. If regp is valid, it's set with the newly created object.
2364 * Return 0 on success or else a negative value.
2366 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2367 struct ust_app_session
*ua_sess
,
2368 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2371 struct buffer_reg_uid
*reg_uid
;
2378 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2381 * This is the create channel path meaning that if there is NO
2382 * registry available, we have to create one for this session.
2384 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2385 LTTNG_DOMAIN_UST
, ®_uid
,
2386 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2394 /* Initialize registry. */
2395 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2396 app
->bits_per_long
, app
->uint8_t_alignment
,
2397 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2398 app
->uint64_t_alignment
, app
->long_alignment
,
2399 app
->byte_order
, app
->version
.major
,
2400 app
->version
.minor
, reg_uid
->root_shm_path
,
2401 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2402 ua_sess
->tracing_id
, app
->uid
);
2405 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2406 * destroy the buffer registry, because it is always expected
2407 * that if the buffer registry can be found, its ust registry is
2410 buffer_reg_uid_destroy(reg_uid
, NULL
);
2413 /* Add node to teardown list of the session. */
2414 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2416 buffer_reg_uid_add(reg_uid
);
2418 DBG3("UST app buffer registry per UID created successfully");
2429 * Create a session on the tracer side for the given app.
2431 * On success, ua_sess_ptr is populated with the session pointer or else left
2432 * untouched. If the session was created, is_created is set to 1. On error,
2433 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2436 * Returns 0 on success or else a negative code which is either -ENOMEM or
2437 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2439 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2440 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2443 int ret
, created
= 0;
2444 struct ust_app_session
*ua_sess
;
2448 assert(ua_sess_ptr
);
2450 health_code_update();
2452 ua_sess
= lookup_session_by_app(usess
, app
);
2453 if (ua_sess
== NULL
) {
2454 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2455 app
->pid
, usess
->id
);
2456 ua_sess
= alloc_ust_app_session();
2457 if (ua_sess
== NULL
) {
2458 /* Only malloc can failed so something is really wrong */
2462 shadow_copy_session(ua_sess
, usess
, app
);
2466 switch (usess
->buffer_type
) {
2467 case LTTNG_BUFFER_PER_PID
:
2468 /* Init local registry. */
2469 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2471 delete_ust_app_session(-1, ua_sess
, app
);
2475 case LTTNG_BUFFER_PER_UID
:
2476 /* Look for a global registry. If none exists, create one. */
2477 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2479 delete_ust_app_session(-1, ua_sess
, app
);
2489 health_code_update();
2491 if (ua_sess
->handle
== -1) {
2492 pthread_mutex_lock(&app
->sock_lock
);
2493 ret
= ustctl_create_session(app
->sock
);
2494 pthread_mutex_unlock(&app
->sock_lock
);
2496 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2497 ERR("Creating session for app pid %d with ret %d",
2500 DBG("UST app creating session failed. Application is dead");
2502 * This is normal behavior, an application can die during the
2503 * creation process. Don't report an error so the execution can
2504 * continue normally. This will get flagged ENOTCONN and the
2505 * caller will handle it.
2509 delete_ust_app_session(-1, ua_sess
, app
);
2510 if (ret
!= -ENOMEM
) {
2512 * Tracer is probably gone or got an internal error so let's
2513 * behave like it will soon unregister or not usable.
2520 ua_sess
->handle
= ret
;
2522 /* Add ust app session to app's HT */
2523 lttng_ht_node_init_u64(&ua_sess
->node
,
2524 ua_sess
->tracing_id
);
2525 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2526 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2527 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2528 &ua_sess
->ust_objd_node
);
2530 DBG2("UST app session created successfully with handle %d", ret
);
2533 *ua_sess_ptr
= ua_sess
;
2535 *is_created
= created
;
2538 /* Everything went well. */
2542 health_code_update();
2547 * Match function for a hash table lookup of ust_app_ctx.
2549 * It matches an ust app context based on the context type and, in the case
2550 * of perf counters, their name.
2552 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2554 struct ust_app_ctx
*ctx
;
2555 const struct lttng_ust_context_attr
*key
;
2560 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2564 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2569 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2570 if (strncmp(key
->u
.perf_counter
.name
,
2571 ctx
->ctx
.u
.perf_counter
.name
,
2572 sizeof(key
->u
.perf_counter
.name
))) {
2576 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2577 if (strcmp(key
->u
.app_ctx
.provider_name
,
2578 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2579 strcmp(key
->u
.app_ctx
.ctx_name
,
2580 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2596 * Lookup for an ust app context from an lttng_ust_context.
2598 * Must be called while holding RCU read side lock.
2599 * Return an ust_app_ctx object or NULL on error.
2602 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2603 struct lttng_ust_context_attr
*uctx
)
2605 struct lttng_ht_iter iter
;
2606 struct lttng_ht_node_ulong
*node
;
2607 struct ust_app_ctx
*app_ctx
= NULL
;
2612 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2613 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2614 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2615 node
= lttng_ht_iter_get_node_ulong(&iter
);
2620 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2627 * Create a context for the channel on the tracer.
2629 * Called with UST app session lock held and a RCU read side lock.
2632 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2633 struct lttng_ust_context_attr
*uctx
,
2634 struct ust_app
*app
)
2637 struct ust_app_ctx
*ua_ctx
;
2639 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2641 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2647 ua_ctx
= alloc_ust_app_ctx(uctx
);
2648 if (ua_ctx
== NULL
) {
2654 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2655 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2656 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2658 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2668 * Enable on the tracer side a ust app event for the session and channel.
2670 * Called with UST app session lock held.
2673 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2674 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2678 ret
= enable_ust_object(app
, ua_event
->obj
);
2683 ua_event
->enabled
= 1;
2690 * Disable on the tracer side a ust app event for the session and channel.
2692 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2693 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2697 ret
= disable_ust_object(app
, ua_event
->obj
);
2702 ua_event
->enabled
= 0;
2709 * Lookup ust app channel for session and disable it on the tracer side.
2712 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2713 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2717 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2722 ua_chan
->enabled
= 0;
2729 * Lookup ust app channel for session and enable it on the tracer side. This
2730 * MUST be called with a RCU read side lock acquired.
2732 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2733 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2736 struct lttng_ht_iter iter
;
2737 struct lttng_ht_node_str
*ua_chan_node
;
2738 struct ust_app_channel
*ua_chan
;
2740 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2741 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2742 if (ua_chan_node
== NULL
) {
2743 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2744 uchan
->name
, ua_sess
->tracing_id
);
2748 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2750 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2760 * Ask the consumer to create a channel and get it if successful.
2762 * Called with UST app session lock held.
2764 * Return 0 on success or else a negative value.
2766 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2767 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2768 int bitness
, struct ust_registry_session
*registry
,
2769 uint64_t trace_archive_id
)
2772 unsigned int nb_fd
= 0;
2773 struct consumer_socket
*socket
;
2781 health_code_update();
2783 /* Get the right consumer socket for the application. */
2784 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2790 health_code_update();
2792 /* Need one fd for the channel. */
2793 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2795 ERR("Exhausted number of available FD upon create channel");
2800 * Ask consumer to create channel. The consumer will return the number of
2801 * stream we have to expect.
2803 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2804 registry
, usess
->current_trace_chunk
);
2810 * Compute the number of fd needed before receiving them. It must be 2 per
2811 * stream (2 being the default value here).
2813 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2815 /* Reserve the amount of file descriptor we need. */
2816 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2818 ERR("Exhausted number of available FD upon create channel");
2819 goto error_fd_get_stream
;
2822 health_code_update();
2825 * Now get the channel from the consumer. This call wil populate the stream
2826 * list of that channel and set the ust objects.
2828 if (usess
->consumer
->enabled
) {
2829 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2839 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2840 error_fd_get_stream
:
2842 * Initiate a destroy channel on the consumer since we had an error
2843 * handling it on our side. The return value is of no importance since we
2844 * already have a ret value set by the previous error that we need to
2847 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2849 lttng_fd_put(LTTNG_FD_APPS
, 1);
2851 health_code_update();
2857 * Duplicate the ust data object of the ust app stream and save it in the
2858 * buffer registry stream.
2860 * Return 0 on success or else a negative value.
2862 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2863 struct ust_app_stream
*stream
)
2870 /* Reserve the amount of file descriptor we need. */
2871 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2873 ERR("Exhausted number of available FD upon duplicate stream");
2877 /* Duplicate object for stream once the original is in the registry. */
2878 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2879 reg_stream
->obj
.ust
);
2881 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2882 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2883 lttng_fd_put(LTTNG_FD_APPS
, 2);
2886 stream
->handle
= stream
->obj
->handle
;
2893 * Duplicate the ust data object of the ust app. channel and save it in the
2894 * buffer registry channel.
2896 * Return 0 on success or else a negative value.
2898 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2899 struct ust_app_channel
*ua_chan
)
2906 /* Need two fds for the channel. */
2907 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2909 ERR("Exhausted number of available FD upon duplicate channel");
2913 /* Duplicate object for stream once the original is in the registry. */
2914 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2916 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2917 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2920 ua_chan
->handle
= ua_chan
->obj
->handle
;
2925 lttng_fd_put(LTTNG_FD_APPS
, 1);
2931 * For a given channel buffer registry, setup all streams of the given ust
2932 * application channel.
2934 * Return 0 on success or else a negative value.
2936 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2937 struct ust_app_channel
*ua_chan
,
2938 struct ust_app
*app
)
2941 struct ust_app_stream
*stream
, *stmp
;
2946 DBG2("UST app setup buffer registry stream");
2948 /* Send all streams to application. */
2949 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2950 struct buffer_reg_stream
*reg_stream
;
2952 ret
= buffer_reg_stream_create(®_stream
);
2958 * Keep original pointer and nullify it in the stream so the delete
2959 * stream call does not release the object.
2961 reg_stream
->obj
.ust
= stream
->obj
;
2963 buffer_reg_stream_add(reg_stream
, reg_chan
);
2965 /* We don't need the streams anymore. */
2966 cds_list_del(&stream
->list
);
2967 delete_ust_app_stream(-1, stream
, app
);
2975 * Create a buffer registry channel for the given session registry and
2976 * application channel object. If regp pointer is valid, it's set with the
2977 * created object. Important, the created object is NOT added to the session
2978 * registry hash table.
2980 * Return 0 on success else a negative value.
2982 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2983 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2986 struct buffer_reg_channel
*reg_chan
= NULL
;
2991 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2993 /* Create buffer registry channel. */
2994 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2999 reg_chan
->consumer_key
= ua_chan
->key
;
3000 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3001 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3003 /* Create and add a channel registry to session. */
3004 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3005 ua_chan
->tracing_channel_id
);
3009 buffer_reg_channel_add(reg_sess
, reg_chan
);
3018 /* Safe because the registry channel object was not added to any HT. */
3019 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3025 * Setup buffer registry channel for the given session registry and application
3026 * channel object. If regp pointer is valid, it's set with the created object.
3028 * Return 0 on success else a negative value.
3030 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3031 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
3032 struct ust_app
*app
)
3039 assert(ua_chan
->obj
);
3041 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3043 /* Setup all streams for the registry. */
3044 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
3049 reg_chan
->obj
.ust
= ua_chan
->obj
;
3050 ua_chan
->obj
= NULL
;
3055 buffer_reg_channel_remove(reg_sess
, reg_chan
);
3056 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3061 * Send buffer registry channel to the application.
3063 * Return 0 on success else a negative value.
3065 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
3066 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3067 struct ust_app_channel
*ua_chan
)
3070 struct buffer_reg_stream
*reg_stream
;
3077 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3079 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
3084 /* Send channel to the application. */
3085 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3086 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3087 ret
= -ENOTCONN
; /* Caused by app exiting. */
3089 } else if (ret
< 0) {
3093 health_code_update();
3095 /* Send all streams to application. */
3096 pthread_mutex_lock(®_chan
->stream_list_lock
);
3097 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
3098 struct ust_app_stream stream
;
3100 ret
= duplicate_stream_object(reg_stream
, &stream
);
3102 goto error_stream_unlock
;
3105 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3107 (void) release_ust_app_stream(-1, &stream
, app
);
3108 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3109 ret
= -ENOTCONN
; /* Caused by app exiting. */
3111 goto error_stream_unlock
;
3115 * The return value is not important here. This function will output an
3118 (void) release_ust_app_stream(-1, &stream
, app
);
3120 ua_chan
->is_sent
= 1;
3122 error_stream_unlock
:
3123 pthread_mutex_unlock(®_chan
->stream_list_lock
);
3129 * Create and send to the application the created buffers with per UID buffers.
3131 * This MUST be called with a RCU read side lock acquired.
3132 * The session list lock and the session's lock must be acquired.
3134 * Return 0 on success else a negative value.
3136 static int create_channel_per_uid(struct ust_app
*app
,
3137 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3138 struct ust_app_channel
*ua_chan
)
3141 struct buffer_reg_uid
*reg_uid
;
3142 struct buffer_reg_channel
*reg_chan
;
3143 struct ltt_session
*session
= NULL
;
3144 enum lttng_error_code notification_ret
;
3145 struct ust_registry_channel
*chan_reg
;
3152 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3154 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3156 * The session creation handles the creation of this global registry
3157 * object. If none can be find, there is a code flow problem or a
3162 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3168 /* Create the buffer registry channel object. */
3169 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
3171 ERR("Error creating the UST channel \"%s\" registry instance",
3176 session
= session_find_by_id(ua_sess
->tracing_id
);
3178 assert(pthread_mutex_trylock(&session
->lock
));
3179 assert(session_trylock_list());
3182 * Create the buffers on the consumer side. This call populates the
3183 * ust app channel object with all streams and data object.
3185 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3186 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3187 session
->most_recent_chunk_id
.value
);
3189 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3193 * Let's remove the previously created buffer registry channel so
3194 * it's not visible anymore in the session registry.
3196 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3197 ua_chan
->tracing_channel_id
, false);
3198 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
3199 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3204 * Setup the streams and add it to the session registry.
3206 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3207 ua_chan
, reg_chan
, app
);
3209 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3213 /* Notify the notification subsystem of the channel's creation. */
3214 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3215 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3216 ua_chan
->tracing_channel_id
);
3218 chan_reg
->consumer_key
= ua_chan
->key
;
3220 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3222 notification_ret
= notification_thread_command_add_channel(
3223 notification_thread_handle
, session
->name
,
3224 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3225 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3227 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3228 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3229 if (notification_ret
!= LTTNG_OK
) {
3230 ret
= - (int) notification_ret
;
3231 ERR("Failed to add channel to notification thread");
3236 /* Send buffers to the application. */
3237 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
3239 if (ret
!= -ENOTCONN
) {
3240 ERR("Error sending channel to application");
3247 session_put(session
);
3253 * Create and send to the application the created buffers with per PID buffers.
3255 * Called with UST app session lock held.
3256 * The session list lock and the session's lock must be acquired.
3258 * Return 0 on success else a negative value.
3260 static int create_channel_per_pid(struct ust_app
*app
,
3261 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3262 struct ust_app_channel
*ua_chan
)
3265 struct ust_registry_session
*registry
;
3266 enum lttng_error_code cmd_ret
;
3267 struct ltt_session
*session
= NULL
;
3268 uint64_t chan_reg_key
;
3269 struct ust_registry_channel
*chan_reg
;
3276 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3280 registry
= get_session_registry(ua_sess
);
3281 /* The UST app session lock is held, registry shall not be null. */
3284 /* Create and add a new channel registry to session. */
3285 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3287 ERR("Error creating the UST channel \"%s\" registry instance",
3292 session
= session_find_by_id(ua_sess
->tracing_id
);
3295 assert(pthread_mutex_trylock(&session
->lock
));
3296 assert(session_trylock_list());
3298 /* Create and get channel on the consumer side. */
3299 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3300 app
->bits_per_long
, registry
,
3301 session
->most_recent_chunk_id
.value
);
3303 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3305 goto error_remove_from_registry
;
3308 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3310 if (ret
!= -ENOTCONN
) {
3311 ERR("Error sending channel to application");
3313 goto error_remove_from_registry
;
3316 chan_reg_key
= ua_chan
->key
;
3317 pthread_mutex_lock(®istry
->lock
);
3318 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3320 chan_reg
->consumer_key
= ua_chan
->key
;
3321 pthread_mutex_unlock(®istry
->lock
);
3323 cmd_ret
= notification_thread_command_add_channel(
3324 notification_thread_handle
, session
->name
,
3325 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3326 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3328 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3329 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3330 if (cmd_ret
!= LTTNG_OK
) {
3331 ret
= - (int) cmd_ret
;
3332 ERR("Failed to add channel to notification thread");
3333 goto error_remove_from_registry
;
3336 error_remove_from_registry
:
3338 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3343 session_put(session
);
3349 * From an already allocated ust app channel, create the channel buffers if
3350 * needed and send them to the application. This MUST be called with a RCU read
3351 * side lock acquired.
3353 * Called with UST app session lock held.
3355 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3356 * the application exited concurrently.
3358 static int ust_app_channel_send(struct ust_app
*app
,
3359 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3360 struct ust_app_channel
*ua_chan
)
3366 assert(usess
->active
);
3370 /* Handle buffer type before sending the channel to the application. */
3371 switch (usess
->buffer_type
) {
3372 case LTTNG_BUFFER_PER_UID
:
3374 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3380 case LTTNG_BUFFER_PER_PID
:
3382 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3394 /* Initialize ust objd object using the received handle and add it. */
3395 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3396 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3398 /* If channel is not enabled, disable it on the tracer */
3399 if (!ua_chan
->enabled
) {
3400 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3411 * Create UST app channel and return it through ua_chanp if not NULL.
3413 * Called with UST app session lock and RCU read-side lock held.
3415 * Return 0 on success or else a negative value.
3417 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3418 struct ltt_ust_channel
*uchan
,
3419 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3420 struct ust_app_channel
**ua_chanp
)
3423 struct lttng_ht_iter iter
;
3424 struct lttng_ht_node_str
*ua_chan_node
;
3425 struct ust_app_channel
*ua_chan
;
3427 /* Lookup channel in the ust app session */
3428 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3429 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3430 if (ua_chan_node
!= NULL
) {
3431 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3435 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3436 if (ua_chan
== NULL
) {
3437 /* Only malloc can fail here */
3441 shadow_copy_channel(ua_chan
, uchan
);
3443 /* Set channel type. */
3444 ua_chan
->attr
.type
= type
;
3446 /* Only add the channel if successful on the tracer side. */
3447 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3450 *ua_chanp
= ua_chan
;
3453 /* Everything went well. */
3461 * Create UST app event and create it on the tracer side.
3463 * Must be called with the RCU read side lock held.
3464 * Called with ust app session mutex held.
3467 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3468 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3469 struct ust_app
*app
)
3472 struct ust_app_event
*ua_event
;
3474 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3475 if (ua_event
== NULL
) {
3476 /* Only failure mode of alloc_ust_app_event(). */
3480 shadow_copy_event(ua_event
, uevent
);
3482 /* Create it on the tracer side */
3483 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3486 * Not found previously means that it does not exist on the
3487 * tracer. If the application reports that the event existed,
3488 * it means there is a bug in the sessiond or lttng-ust
3489 * (or corruption, etc.)
3491 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3492 ERR("Tracer for application reported that an event being created already existed: "
3493 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3495 app
->pid
, app
->ppid
, app
->uid
,
3501 add_unique_ust_app_event(ua_chan
, ua_event
);
3503 DBG2("UST app create event completed: app = '%s' (ppid: %d)",
3504 app
->name
, app
->ppid
);
3510 /* Valid. Calling here is already in a read side lock */
3511 delete_ust_app_event(-1, ua_event
, app
);
3516 * Create UST app event notifier rule and create it on the tracer side.
3518 * Must be called with the RCU read side lock held.
3519 * Called with ust app session mutex held.
3522 int create_ust_app_event_notifier_rule(struct lttng_event_rule
*rule
,
3523 struct ust_app
*app
, uint64_t token
)
3526 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3528 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(rule
, token
);
3529 if (ua_event_notifier_rule
== NULL
) {
3534 /* Create it on the tracer side. */
3535 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3538 * Not found previously means that it does not exist on the
3539 * tracer. If the application reports that the event existed,
3540 * it means there is a bug in the sessiond or lttng-ust
3541 * (or corruption, etc.)
3543 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3544 ERR("Tracer for application reported that an event notifier being created already exists: "
3545 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3547 app
->pid
, app
->ppid
, app
->uid
,
3553 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3554 &ua_event_notifier_rule
->node
);
3556 DBG2("UST app create token event rule completed: app = '%s' (ppid: %d), token = %" PRIu64
,
3557 app
->name
, app
->ppid
, token
);
3563 /* The RCU read side lock is already being held by the caller. */
3564 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3569 * Create UST metadata and open it on the tracer side.
3571 * Called with UST app session lock held and RCU read side lock.
3573 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3574 struct ust_app
*app
, struct consumer_output
*consumer
)
3577 struct ust_app_channel
*metadata
;
3578 struct consumer_socket
*socket
;
3579 struct ust_registry_session
*registry
;
3580 struct ltt_session
*session
= NULL
;
3586 registry
= get_session_registry(ua_sess
);
3587 /* The UST app session is held registry shall not be null. */
3590 pthread_mutex_lock(®istry
->lock
);
3592 /* Metadata already exists for this registry or it was closed previously */
3593 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3598 /* Allocate UST metadata */
3599 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3601 /* malloc() failed */
3606 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3608 /* Need one fd for the channel. */
3609 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3611 ERR("Exhausted number of available FD upon create metadata");
3615 /* Get the right consumer socket for the application. */
3616 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3619 goto error_consumer
;
3623 * Keep metadata key so we can identify it on the consumer side. Assign it
3624 * to the registry *before* we ask the consumer so we avoid the race of the
3625 * consumer requesting the metadata and the ask_channel call on our side
3626 * did not returned yet.
3628 registry
->metadata_key
= metadata
->key
;
3630 session
= session_find_by_id(ua_sess
->tracing_id
);
3633 assert(pthread_mutex_trylock(&session
->lock
));
3634 assert(session_trylock_list());
3637 * Ask the metadata channel creation to the consumer. The metadata object
3638 * will be created by the consumer and kept their. However, the stream is
3639 * never added or monitored until we do a first push metadata to the
3642 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3643 registry
, session
->current_trace_chunk
);
3645 /* Nullify the metadata key so we don't try to close it later on. */
3646 registry
->metadata_key
= 0;
3647 goto error_consumer
;
3651 * The setup command will make the metadata stream be sent to the relayd,
3652 * if applicable, and the thread managing the metadatas. This is important
3653 * because after this point, if an error occurs, the only way the stream
3654 * can be deleted is to be monitored in the consumer.
3656 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3658 /* Nullify the metadata key so we don't try to close it later on. */
3659 registry
->metadata_key
= 0;
3660 goto error_consumer
;
3663 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3664 metadata
->key
, app
->pid
);
3667 lttng_fd_put(LTTNG_FD_APPS
, 1);
3668 delete_ust_app_channel(-1, metadata
, app
);
3670 pthread_mutex_unlock(®istry
->lock
);
3672 session_put(session
);
3678 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3679 * acquired before calling this function.
3681 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3683 struct ust_app
*app
= NULL
;
3684 struct lttng_ht_node_ulong
*node
;
3685 struct lttng_ht_iter iter
;
3687 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3688 node
= lttng_ht_iter_get_node_ulong(&iter
);
3690 DBG2("UST app no found with pid %d", pid
);
3694 DBG2("Found UST app by pid %d", pid
);
3696 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3703 * Allocate and init an UST app object using the registration information and
3704 * the command socket. This is called when the command socket connects to the
3707 * The object is returned on success or else NULL.
3709 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3711 struct ust_app
*lta
= NULL
;
3712 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3717 DBG3("UST app creating application for socket %d", sock
);
3719 if ((msg
->bits_per_long
== 64 &&
3720 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3721 || (msg
->bits_per_long
== 32 &&
3722 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3723 ERR("Registration failed: application \"%s\" (pid: %d) has "
3724 "%d-bit long, but no consumerd for this size is available.\n",
3725 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3729 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3730 if (!event_notifier_event_source_pipe
) {
3731 PERROR("Failed to open application event source pipe: '%s' (ppid = %d)",
3732 msg
->name
, msg
->ppid
);
3736 lta
= zmalloc(sizeof(struct ust_app
));
3739 goto error_free_pipe
;
3742 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3744 lta
->ppid
= msg
->ppid
;
3745 lta
->uid
= msg
->uid
;
3746 lta
->gid
= msg
->gid
;
3748 lta
->bits_per_long
= msg
->bits_per_long
;
3749 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3750 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3751 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3752 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3753 lta
->long_alignment
= msg
->long_alignment
;
3754 lta
->byte_order
= msg
->byte_order
;
3756 lta
->v_major
= msg
->major
;
3757 lta
->v_minor
= msg
->minor
;
3758 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3759 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3760 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3761 lta
->notify_sock
= -1;
3762 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3764 /* Copy name and make sure it's NULL terminated. */
3765 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3766 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3769 * Before this can be called, when receiving the registration information,
3770 * the application compatibility is checked. So, at this point, the
3771 * application can work with this session daemon.
3773 lta
->compatible
= 1;
3775 lta
->pid
= msg
->pid
;
3776 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3778 pthread_mutex_init(<a
->sock_lock
, NULL
);
3779 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3781 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3785 lttng_pipe_destroy(event_notifier_event_source_pipe
);
3791 * For a given application object, add it to every hash table.
3793 void ust_app_add(struct ust_app
*app
)
3796 assert(app
->notify_sock
>= 0);
3798 app
->registration_time
= time(NULL
);
3803 * On a re-registration, we want to kick out the previous registration of
3806 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3809 * The socket _should_ be unique until _we_ call close. So, a add_unique
3810 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3811 * already in the table.
3813 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3815 /* Add application to the notify socket hash table. */
3816 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3817 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3819 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3820 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3821 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3828 * Set the application version into the object.
3830 * Return 0 on success else a negative value either an errno code or a
3831 * LTTng-UST error code.
3833 int ust_app_version(struct ust_app
*app
)
3839 pthread_mutex_lock(&app
->sock_lock
);
3840 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3841 pthread_mutex_unlock(&app
->sock_lock
);
3843 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3844 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3846 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3854 * Setup the base event notifier group.
3856 * Return 0 on success else a negative value either an errno code or a
3857 * LTTng-UST error code.
3859 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
3862 int event_pipe_write_fd
;
3863 struct lttng_ust_object_data
*event_notifier_group
= NULL
;
3864 enum lttng_error_code lttng_ret
;
3868 /* Get the write side of the pipe. */
3869 event_pipe_write_fd
= lttng_pipe_get_writefd(
3870 app
->event_notifier_group
.event_pipe
);
3872 pthread_mutex_lock(&app
->sock_lock
);
3873 ret
= ustctl_create_event_notifier_group(app
->sock
,
3874 event_pipe_write_fd
, &event_notifier_group
);
3875 pthread_mutex_unlock(&app
->sock_lock
);
3877 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3878 ERR("Failed to create application event notifier group: ret = %d, app socket fd = %d, event_pipe_write_fd = %d",
3879 ret
, app
->sock
, event_pipe_write_fd
);
3881 DBG("Failed to create application event notifier group (application is dead): app socket fd = %d",
3888 lttng_ret
= notification_thread_command_add_tracer_event_source(
3889 notification_thread_handle
,
3890 lttng_pipe_get_readfd(app
->event_notifier_group
.event_pipe
),
3892 if (lttng_ret
!= LTTNG_OK
) {
3893 ERR("Failed to add tracer event source to notification thread");
3898 /* Assign handle only when the complete setup is valid. */
3899 app
->event_notifier_group
.object
= event_notifier_group
;
3903 ustctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
3904 free(app
->event_notifier_group
.object
);
3909 * Unregister app by removing it from the global traceable app list and freeing
3912 * The socket is already closed at this point so no close to sock.
3914 void ust_app_unregister(int sock
)
3916 struct ust_app
*lta
;
3917 struct lttng_ht_node_ulong
*node
;
3918 struct lttng_ht_iter ust_app_sock_iter
;
3919 struct lttng_ht_iter iter
;
3920 struct ust_app_session
*ua_sess
;
3925 /* Get the node reference for a call_rcu */
3926 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3927 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3930 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3931 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3934 * For per-PID buffers, perform "push metadata" and flush all
3935 * application streams before removing app from hash tables,
3936 * ensuring proper behavior of data_pending check.
3937 * Remove sessions so they are not visible during deletion.
3939 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3941 struct ust_registry_session
*registry
;
3943 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3945 /* The session was already removed so scheduled for teardown. */
3949 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3950 (void) ust_app_flush_app_session(lta
, ua_sess
);
3954 * Add session to list for teardown. This is safe since at this point we
3955 * are the only one using this list.
3957 pthread_mutex_lock(&ua_sess
->lock
);
3959 if (ua_sess
->deleted
) {
3960 pthread_mutex_unlock(&ua_sess
->lock
);
3965 * Normally, this is done in the delete session process which is
3966 * executed in the call rcu below. However, upon registration we can't
3967 * afford to wait for the grace period before pushing data or else the
3968 * data pending feature can race between the unregistration and stop
3969 * command where the data pending command is sent *before* the grace
3972 * The close metadata below nullifies the metadata pointer in the
3973 * session so the delete session will NOT push/close a second time.
3975 registry
= get_session_registry(ua_sess
);
3977 /* Push metadata for application before freeing the application. */
3978 (void) push_metadata(registry
, ua_sess
->consumer
);
3981 * Don't ask to close metadata for global per UID buffers. Close
3982 * metadata only on destroy trace session in this case. Also, the
3983 * previous push metadata could have flag the metadata registry to
3984 * close so don't send a close command if closed.
3986 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3987 /* And ask to close it for this session registry. */
3988 (void) close_metadata(registry
, ua_sess
->consumer
);
3991 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3993 pthread_mutex_unlock(&ua_sess
->lock
);
3996 /* Remove application from PID hash table */
3997 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4001 * Remove application from notify hash table. The thread handling the
4002 * notify socket could have deleted the node so ignore on error because
4003 * either way it's valid. The close of that socket is handled by the
4004 * apps_notify_thread.
4006 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4007 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4010 * Ignore return value since the node might have been removed before by an
4011 * add replace during app registration because the PID can be reassigned by
4014 iter
.iter
.node
= <a
->pid_n
.node
;
4015 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4017 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4022 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4029 * Fill events array with all events name of all registered apps.
4031 int ust_app_list_events(struct lttng_event
**events
)
4034 size_t nbmem
, count
= 0;
4035 struct lttng_ht_iter iter
;
4036 struct ust_app
*app
;
4037 struct lttng_event
*tmp_event
;
4039 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4040 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4041 if (tmp_event
== NULL
) {
4042 PERROR("zmalloc ust app events");
4049 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4050 struct lttng_ust_tracepoint_iter uiter
;
4052 health_code_update();
4054 if (!app
->compatible
) {
4056 * TODO: In time, we should notice the caller of this error by
4057 * telling him that this is a version error.
4061 pthread_mutex_lock(&app
->sock_lock
);
4062 handle
= ustctl_tracepoint_list(app
->sock
);
4064 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4065 ERR("UST app list events getting handle failed for app pid %d",
4068 pthread_mutex_unlock(&app
->sock_lock
);
4072 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
4073 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4074 /* Handle ustctl error. */
4078 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4079 ERR("UST app tp list get failed for app %d with ret %d",
4082 DBG3("UST app tp list get failed. Application is dead");
4084 * This is normal behavior, an application can die during the
4085 * creation process. Don't report an error so the execution can
4086 * continue normally. Continue normal execution.
4091 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4092 if (release_ret
< 0 &&
4093 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4094 release_ret
!= -EPIPE
) {
4095 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4097 pthread_mutex_unlock(&app
->sock_lock
);
4101 health_code_update();
4102 if (count
>= nbmem
) {
4103 /* In case the realloc fails, we free the memory */
4104 struct lttng_event
*new_tmp_event
;
4107 new_nbmem
= nbmem
<< 1;
4108 DBG2("Reallocating event list from %zu to %zu entries",
4110 new_tmp_event
= realloc(tmp_event
,
4111 new_nbmem
* sizeof(struct lttng_event
));
4112 if (new_tmp_event
== NULL
) {
4115 PERROR("realloc ust app events");
4118 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4119 if (release_ret
< 0 &&
4120 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4121 release_ret
!= -EPIPE
) {
4122 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4124 pthread_mutex_unlock(&app
->sock_lock
);
4127 /* Zero the new memory */
4128 memset(new_tmp_event
+ nbmem
, 0,
4129 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4131 tmp_event
= new_tmp_event
;
4133 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
4134 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4135 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
4136 tmp_event
[count
].pid
= app
->pid
;
4137 tmp_event
[count
].enabled
= -1;
4140 ret
= ustctl_release_handle(app
->sock
, handle
);
4141 pthread_mutex_unlock(&app
->sock_lock
);
4142 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4143 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4148 *events
= tmp_event
;
4150 DBG2("UST app list events done (%zu events)", count
);
4155 health_code_update();
4160 * Fill events array with all events name of all registered apps.
4162 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4165 size_t nbmem
, count
= 0;
4166 struct lttng_ht_iter iter
;
4167 struct ust_app
*app
;
4168 struct lttng_event_field
*tmp_event
;
4170 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4171 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4172 if (tmp_event
== NULL
) {
4173 PERROR("zmalloc ust app event fields");
4180 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4181 struct lttng_ust_field_iter uiter
;
4183 health_code_update();
4185 if (!app
->compatible
) {
4187 * TODO: In time, we should notice the caller of this error by
4188 * telling him that this is a version error.
4192 pthread_mutex_lock(&app
->sock_lock
);
4193 handle
= ustctl_tracepoint_field_list(app
->sock
);
4195 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4196 ERR("UST app list field getting handle failed for app pid %d",
4199 pthread_mutex_unlock(&app
->sock_lock
);
4203 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
4204 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4205 /* Handle ustctl error. */
4209 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4210 ERR("UST app tp list field failed for app %d with ret %d",
4213 DBG3("UST app tp list field failed. Application is dead");
4215 * This is normal behavior, an application can die during the
4216 * creation process. Don't report an error so the execution can
4217 * continue normally. Reset list and count for next app.
4222 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4223 pthread_mutex_unlock(&app
->sock_lock
);
4224 if (release_ret
< 0 &&
4225 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4226 release_ret
!= -EPIPE
) {
4227 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4232 health_code_update();
4233 if (count
>= nbmem
) {
4234 /* In case the realloc fails, we free the memory */
4235 struct lttng_event_field
*new_tmp_event
;
4238 new_nbmem
= nbmem
<< 1;
4239 DBG2("Reallocating event field list from %zu to %zu entries",
4241 new_tmp_event
= realloc(tmp_event
,
4242 new_nbmem
* sizeof(struct lttng_event_field
));
4243 if (new_tmp_event
== NULL
) {
4246 PERROR("realloc ust app event fields");
4249 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4250 pthread_mutex_unlock(&app
->sock_lock
);
4252 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4253 release_ret
!= -EPIPE
) {
4254 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4258 /* Zero the new memory */
4259 memset(new_tmp_event
+ nbmem
, 0,
4260 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4262 tmp_event
= new_tmp_event
;
4265 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
4266 /* Mapping between these enums matches 1 to 1. */
4267 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4268 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4270 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
4271 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4272 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4273 tmp_event
[count
].event
.pid
= app
->pid
;
4274 tmp_event
[count
].event
.enabled
= -1;
4277 ret
= ustctl_release_handle(app
->sock
, handle
);
4278 pthread_mutex_unlock(&app
->sock_lock
);
4280 ret
!= -LTTNG_UST_ERR_EXITING
&&
4282 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4287 *fields
= tmp_event
;
4289 DBG2("UST app list event fields done (%zu events)", count
);
4294 health_code_update();
4299 * Free and clean all traceable apps of the global list.
4301 * Should _NOT_ be called with RCU read-side lock held.
4303 void ust_app_clean_list(void)
4306 struct ust_app
*app
;
4307 struct lttng_ht_iter iter
;
4309 DBG2("UST app cleaning registered apps hash table");
4313 /* Cleanup notify socket hash table */
4314 if (ust_app_ht_by_notify_sock
) {
4315 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4316 notify_sock_n
.node
) {
4318 * Assert that all notifiers are gone as all triggers
4319 * are unregistered prior to this clean-up.
4321 assert(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4323 ust_app_notify_sock_unregister(app
->notify_sock
);
4328 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4329 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4331 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4335 /* Cleanup socket hash table */
4336 if (ust_app_ht_by_sock
) {
4337 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4339 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4346 /* Destroy is done only when the ht is empty */
4348 ht_cleanup_push(ust_app_ht
);
4350 if (ust_app_ht_by_sock
) {
4351 ht_cleanup_push(ust_app_ht_by_sock
);
4353 if (ust_app_ht_by_notify_sock
) {
4354 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4359 * Init UST app hash table.
4361 int ust_app_ht_alloc(void)
4363 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4367 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4368 if (!ust_app_ht_by_sock
) {
4371 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4372 if (!ust_app_ht_by_notify_sock
) {
4379 * For a specific UST session, disable the channel for all registered apps.
4381 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4382 struct ltt_ust_channel
*uchan
)
4385 struct lttng_ht_iter iter
;
4386 struct lttng_ht_node_str
*ua_chan_node
;
4387 struct ust_app
*app
;
4388 struct ust_app_session
*ua_sess
;
4389 struct ust_app_channel
*ua_chan
;
4391 assert(usess
->active
);
4392 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4393 uchan
->name
, usess
->id
);
4397 /* For every registered applications */
4398 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4399 struct lttng_ht_iter uiter
;
4400 if (!app
->compatible
) {
4402 * TODO: In time, we should notice the caller of this error by
4403 * telling him that this is a version error.
4407 ua_sess
= lookup_session_by_app(usess
, app
);
4408 if (ua_sess
== NULL
) {
4413 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4414 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4415 /* If the session if found for the app, the channel must be there */
4416 assert(ua_chan_node
);
4418 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4419 /* The channel must not be already disabled */
4420 assert(ua_chan
->enabled
== 1);
4422 /* Disable channel onto application */
4423 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4425 /* XXX: We might want to report this error at some point... */
4435 * For a specific UST session, enable the channel for all registered apps.
4437 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4438 struct ltt_ust_channel
*uchan
)
4441 struct lttng_ht_iter iter
;
4442 struct ust_app
*app
;
4443 struct ust_app_session
*ua_sess
;
4445 assert(usess
->active
);
4446 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4447 uchan
->name
, usess
->id
);
4451 /* For every registered applications */
4452 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4453 if (!app
->compatible
) {
4455 * TODO: In time, we should notice the caller of this error by
4456 * telling him that this is a version error.
4460 ua_sess
= lookup_session_by_app(usess
, app
);
4461 if (ua_sess
== NULL
) {
4465 /* Enable channel onto application */
4466 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4468 /* XXX: We might want to report this error at some point... */
4478 * Disable an event in a channel and for a specific session.
4480 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4481 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4484 struct lttng_ht_iter iter
, uiter
;
4485 struct lttng_ht_node_str
*ua_chan_node
;
4486 struct ust_app
*app
;
4487 struct ust_app_session
*ua_sess
;
4488 struct ust_app_channel
*ua_chan
;
4489 struct ust_app_event
*ua_event
;
4491 assert(usess
->active
);
4492 DBG("UST app disabling event %s for all apps in channel "
4493 "%s for session id %" PRIu64
,
4494 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4498 /* For all registered applications */
4499 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4500 if (!app
->compatible
) {
4502 * TODO: In time, we should notice the caller of this error by
4503 * telling him that this is a version error.
4507 ua_sess
= lookup_session_by_app(usess
, app
);
4508 if (ua_sess
== NULL
) {
4513 /* Lookup channel in the ust app session */
4514 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4515 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4516 if (ua_chan_node
== NULL
) {
4517 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4518 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4521 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4523 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4524 uevent
->filter
, uevent
->attr
.loglevel
,
4526 if (ua_event
== NULL
) {
4527 DBG2("Event %s not found in channel %s for app pid %d."
4528 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4532 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4534 /* XXX: Report error someday... */
4543 /* The ua_sess lock must be held by the caller. */
4545 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4546 struct ust_app_session
*ua_sess
,
4547 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4548 struct ust_app_channel
**_ua_chan
)
4551 struct ust_app_channel
*ua_chan
= NULL
;
4554 ASSERT_LOCKED(ua_sess
->lock
);
4556 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4557 sizeof(uchan
->name
))) {
4558 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4562 struct ltt_ust_context
*uctx
= NULL
;
4565 * Create channel onto application and synchronize its
4568 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4569 LTTNG_UST_CHAN_PER_CPU
, usess
,
4575 ret
= ust_app_channel_send(app
, usess
,
4582 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4583 ret
= create_ust_app_channel_context(ua_chan
,
4596 * The application's socket is not valid. Either a bad socket
4597 * or a timeout on it. We can't inform the caller that for a
4598 * specific app, the session failed so lets continue here.
4600 ret
= 0; /* Not an error. */
4608 if (ret
== 0 && _ua_chan
) {
4610 * Only return the application's channel on success. Note
4611 * that the channel can still be part of the application's
4612 * channel hashtable on error.
4614 *_ua_chan
= ua_chan
;
4620 * Enable event for a specific session and channel on the tracer.
4622 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4623 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4626 struct lttng_ht_iter iter
, uiter
;
4627 struct lttng_ht_node_str
*ua_chan_node
;
4628 struct ust_app
*app
;
4629 struct ust_app_session
*ua_sess
;
4630 struct ust_app_channel
*ua_chan
;
4631 struct ust_app_event
*ua_event
;
4633 assert(usess
->active
);
4634 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4635 uevent
->attr
.name
, usess
->id
);
4638 * NOTE: At this point, this function is called only if the session and
4639 * channel passed are already created for all apps. and enabled on the
4645 /* For all registered applications */
4646 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4647 if (!app
->compatible
) {
4649 * TODO: In time, we should notice the caller of this error by
4650 * telling him that this is a version error.
4654 ua_sess
= lookup_session_by_app(usess
, app
);
4656 /* The application has problem or is probably dead. */
4660 pthread_mutex_lock(&ua_sess
->lock
);
4662 if (ua_sess
->deleted
) {
4663 pthread_mutex_unlock(&ua_sess
->lock
);
4667 /* Lookup channel in the ust app session */
4668 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4669 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4671 * It is possible that the channel cannot be found is
4672 * the channel/event creation occurs concurrently with
4673 * an application exit.
4675 if (!ua_chan_node
) {
4676 pthread_mutex_unlock(&ua_sess
->lock
);
4680 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4682 /* Get event node */
4683 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4684 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4685 if (ua_event
== NULL
) {
4686 DBG3("UST app enable event %s not found for app PID %d."
4687 "Skipping app", uevent
->attr
.name
, app
->pid
);
4691 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4693 pthread_mutex_unlock(&ua_sess
->lock
);
4697 pthread_mutex_unlock(&ua_sess
->lock
);
4706 * For a specific existing UST session and UST channel, creates the event for
4707 * all registered apps.
4709 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4710 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4713 struct lttng_ht_iter iter
, uiter
;
4714 struct lttng_ht_node_str
*ua_chan_node
;
4715 struct ust_app
*app
;
4716 struct ust_app_session
*ua_sess
;
4717 struct ust_app_channel
*ua_chan
;
4719 assert(usess
->active
);
4720 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4721 uevent
->attr
.name
, usess
->id
);
4725 /* For all registered applications */
4726 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4727 if (!app
->compatible
) {
4729 * TODO: In time, we should notice the caller of this error by
4730 * telling him that this is a version error.
4734 ua_sess
= lookup_session_by_app(usess
, app
);
4736 /* The application has problem or is probably dead. */
4740 pthread_mutex_lock(&ua_sess
->lock
);
4742 if (ua_sess
->deleted
) {
4743 pthread_mutex_unlock(&ua_sess
->lock
);
4747 /* Lookup channel in the ust app session */
4748 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4749 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4750 /* If the channel is not found, there is a code flow error */
4751 assert(ua_chan_node
);
4753 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4755 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4756 pthread_mutex_unlock(&ua_sess
->lock
);
4758 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4759 /* Possible value at this point: -ENOMEM. If so, we stop! */
4762 DBG2("UST app event %s already exist on app PID %d",
4763 uevent
->attr
.name
, app
->pid
);
4773 * Start tracing for a specific UST session and app.
4775 * Called with UST app session lock held.
4779 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4782 struct ust_app_session
*ua_sess
;
4784 DBG("Starting tracing for ust app pid %d", app
->pid
);
4788 if (!app
->compatible
) {
4792 ua_sess
= lookup_session_by_app(usess
, app
);
4793 if (ua_sess
== NULL
) {
4794 /* The session is in teardown process. Ignore and continue. */
4798 pthread_mutex_lock(&ua_sess
->lock
);
4800 if (ua_sess
->deleted
) {
4801 pthread_mutex_unlock(&ua_sess
->lock
);
4805 if (ua_sess
->enabled
) {
4806 pthread_mutex_unlock(&ua_sess
->lock
);
4810 /* Upon restart, we skip the setup, already done */
4811 if (ua_sess
->started
) {
4815 health_code_update();
4818 /* This starts the UST tracing */
4819 pthread_mutex_lock(&app
->sock_lock
);
4820 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4821 pthread_mutex_unlock(&app
->sock_lock
);
4823 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4824 ERR("Error starting tracing for app pid: %d (ret: %d)",
4827 DBG("UST app start session failed. Application is dead.");
4829 * This is normal behavior, an application can die during the
4830 * creation process. Don't report an error so the execution can
4831 * continue normally.
4833 pthread_mutex_unlock(&ua_sess
->lock
);
4839 /* Indicate that the session has been started once */
4840 ua_sess
->started
= 1;
4841 ua_sess
->enabled
= 1;
4843 pthread_mutex_unlock(&ua_sess
->lock
);
4845 health_code_update();
4847 /* Quiescent wait after starting trace */
4848 pthread_mutex_lock(&app
->sock_lock
);
4849 ret
= ustctl_wait_quiescent(app
->sock
);
4850 pthread_mutex_unlock(&app
->sock_lock
);
4851 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4852 ERR("UST app wait quiescent failed for app pid %d ret %d",
4858 health_code_update();
4862 pthread_mutex_unlock(&ua_sess
->lock
);
4864 health_code_update();
4869 * Stop tracing for a specific UST session and app.
4872 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4875 struct ust_app_session
*ua_sess
;
4876 struct ust_registry_session
*registry
;
4878 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4882 if (!app
->compatible
) {
4883 goto end_no_session
;
4886 ua_sess
= lookup_session_by_app(usess
, app
);
4887 if (ua_sess
== NULL
) {
4888 goto end_no_session
;
4891 pthread_mutex_lock(&ua_sess
->lock
);
4893 if (ua_sess
->deleted
) {
4894 pthread_mutex_unlock(&ua_sess
->lock
);
4895 goto end_no_session
;
4899 * If started = 0, it means that stop trace has been called for a session
4900 * that was never started. It's possible since we can have a fail start
4901 * from either the application manager thread or the command thread. Simply
4902 * indicate that this is a stop error.
4904 if (!ua_sess
->started
) {
4905 goto error_rcu_unlock
;
4908 health_code_update();
4910 /* This inhibits UST tracing */
4911 pthread_mutex_lock(&app
->sock_lock
);
4912 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4913 pthread_mutex_unlock(&app
->sock_lock
);
4915 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4916 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4919 DBG("UST app stop session failed. Application is dead.");
4921 * This is normal behavior, an application can die during the
4922 * creation process. Don't report an error so the execution can
4923 * continue normally.
4927 goto error_rcu_unlock
;
4930 health_code_update();
4931 ua_sess
->enabled
= 0;
4933 /* Quiescent wait after stopping trace */
4934 pthread_mutex_lock(&app
->sock_lock
);
4935 ret
= ustctl_wait_quiescent(app
->sock
);
4936 pthread_mutex_unlock(&app
->sock_lock
);
4937 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4938 ERR("UST app wait quiescent failed for app pid %d ret %d",
4942 health_code_update();
4944 registry
= get_session_registry(ua_sess
);
4946 /* The UST app session is held registry shall not be null. */
4949 /* Push metadata for application before freeing the application. */
4950 (void) push_metadata(registry
, ua_sess
->consumer
);
4953 pthread_mutex_unlock(&ua_sess
->lock
);
4956 health_code_update();
4960 pthread_mutex_unlock(&ua_sess
->lock
);
4962 health_code_update();
4967 int ust_app_flush_app_session(struct ust_app
*app
,
4968 struct ust_app_session
*ua_sess
)
4970 int ret
, retval
= 0;
4971 struct lttng_ht_iter iter
;
4972 struct ust_app_channel
*ua_chan
;
4973 struct consumer_socket
*socket
;
4975 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4979 if (!app
->compatible
) {
4980 goto end_not_compatible
;
4983 pthread_mutex_lock(&ua_sess
->lock
);
4985 if (ua_sess
->deleted
) {
4989 health_code_update();
4991 /* Flushing buffers */
4992 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4995 /* Flush buffers and push metadata. */
4996 switch (ua_sess
->buffer_type
) {
4997 case LTTNG_BUFFER_PER_PID
:
4998 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5000 health_code_update();
5001 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5003 ERR("Error flushing consumer channel");
5009 case LTTNG_BUFFER_PER_UID
:
5015 health_code_update();
5018 pthread_mutex_unlock(&ua_sess
->lock
);
5022 health_code_update();
5027 * Flush buffers for all applications for a specific UST session.
5028 * Called with UST session lock held.
5031 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5036 DBG("Flushing session buffers for all ust apps");
5040 /* Flush buffers and push metadata. */
5041 switch (usess
->buffer_type
) {
5042 case LTTNG_BUFFER_PER_UID
:
5044 struct buffer_reg_uid
*reg
;
5045 struct lttng_ht_iter iter
;
5047 /* Flush all per UID buffers associated to that session. */
5048 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5049 struct ust_registry_session
*ust_session_reg
;
5050 struct buffer_reg_channel
*reg_chan
;
5051 struct consumer_socket
*socket
;
5053 /* Get consumer socket to use to push the metadata.*/
5054 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5057 /* Ignore request if no consumer is found for the session. */
5061 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5062 reg_chan
, node
.node
) {
5064 * The following call will print error values so the return
5065 * code is of little importance because whatever happens, we
5066 * have to try them all.
5068 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
5071 ust_session_reg
= reg
->registry
->reg
.ust
;
5072 /* Push metadata. */
5073 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5077 case LTTNG_BUFFER_PER_PID
:
5079 struct ust_app_session
*ua_sess
;
5080 struct lttng_ht_iter iter
;
5081 struct ust_app
*app
;
5083 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5084 ua_sess
= lookup_session_by_app(usess
, app
);
5085 if (ua_sess
== NULL
) {
5088 (void) ust_app_flush_app_session(app
, ua_sess
);
5099 health_code_update();
5104 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5105 struct ust_app_session
*ua_sess
)
5108 struct lttng_ht_iter iter
;
5109 struct ust_app_channel
*ua_chan
;
5110 struct consumer_socket
*socket
;
5112 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5116 if (!app
->compatible
) {
5117 goto end_not_compatible
;
5120 pthread_mutex_lock(&ua_sess
->lock
);
5122 if (ua_sess
->deleted
) {
5126 health_code_update();
5128 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5131 ERR("Failed to find consumer (%" PRIu32
") socket",
5132 app
->bits_per_long
);
5137 /* Clear quiescent state. */
5138 switch (ua_sess
->buffer_type
) {
5139 case LTTNG_BUFFER_PER_PID
:
5140 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5141 ua_chan
, node
.node
) {
5142 health_code_update();
5143 ret
= consumer_clear_quiescent_channel(socket
,
5146 ERR("Error clearing quiescent state for consumer channel");
5152 case LTTNG_BUFFER_PER_UID
:
5159 health_code_update();
5162 pthread_mutex_unlock(&ua_sess
->lock
);
5166 health_code_update();
5171 * Clear quiescent state in each stream for all applications for a
5172 * specific UST session.
5173 * Called with UST session lock held.
5176 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5181 DBG("Clearing stream quiescent state for all ust apps");
5185 switch (usess
->buffer_type
) {
5186 case LTTNG_BUFFER_PER_UID
:
5188 struct lttng_ht_iter iter
;
5189 struct buffer_reg_uid
*reg
;
5192 * Clear quiescent for all per UID buffers associated to
5195 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5196 struct consumer_socket
*socket
;
5197 struct buffer_reg_channel
*reg_chan
;
5199 /* Get associated consumer socket.*/
5200 socket
= consumer_find_socket_by_bitness(
5201 reg
->bits_per_long
, usess
->consumer
);
5204 * Ignore request if no consumer is found for
5210 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5211 &iter
.iter
, reg_chan
, node
.node
) {
5213 * The following call will print error values so
5214 * the return code is of little importance
5215 * because whatever happens, we have to try them
5218 (void) consumer_clear_quiescent_channel(socket
,
5219 reg_chan
->consumer_key
);
5224 case LTTNG_BUFFER_PER_PID
:
5226 struct ust_app_session
*ua_sess
;
5227 struct lttng_ht_iter iter
;
5228 struct ust_app
*app
;
5230 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5232 ua_sess
= lookup_session_by_app(usess
, app
);
5233 if (ua_sess
== NULL
) {
5236 (void) ust_app_clear_quiescent_app_session(app
,
5248 health_code_update();
5253 * Destroy a specific UST session in apps.
5255 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5258 struct ust_app_session
*ua_sess
;
5259 struct lttng_ht_iter iter
;
5260 struct lttng_ht_node_u64
*node
;
5262 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5266 if (!app
->compatible
) {
5270 __lookup_session_by_app(usess
, app
, &iter
);
5271 node
= lttng_ht_iter_get_node_u64(&iter
);
5273 /* Session is being or is deleted. */
5276 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5278 health_code_update();
5279 destroy_app_session(app
, ua_sess
);
5281 health_code_update();
5283 /* Quiescent wait after stopping trace */
5284 pthread_mutex_lock(&app
->sock_lock
);
5285 ret
= ustctl_wait_quiescent(app
->sock
);
5286 pthread_mutex_unlock(&app
->sock_lock
);
5287 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5288 ERR("UST app wait quiescent failed for app pid %d ret %d",
5293 health_code_update();
5298 * Start tracing for the UST session.
5300 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5302 struct lttng_ht_iter iter
;
5303 struct ust_app
*app
;
5305 DBG("Starting all UST traces");
5308 * Even though the start trace might fail, flag this session active so
5309 * other application coming in are started by default.
5316 * In a start-stop-start use-case, we need to clear the quiescent state
5317 * of each channel set by the prior stop command, thus ensuring that a
5318 * following stop or destroy is sure to grab a timestamp_end near those
5319 * operations, even if the packet is empty.
5321 (void) ust_app_clear_quiescent_session(usess
);
5323 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5324 ust_app_global_update(usess
, app
);
5333 * Start tracing for the UST session.
5334 * Called with UST session lock held.
5336 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5339 struct lttng_ht_iter iter
;
5340 struct ust_app
*app
;
5342 DBG("Stopping all UST traces");
5345 * Even though the stop trace might fail, flag this session inactive so
5346 * other application coming in are not started by default.
5352 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5353 ret
= ust_app_stop_trace(usess
, app
);
5355 /* Continue to next apps even on error */
5360 (void) ust_app_flush_session(usess
);
5368 * Destroy app UST session.
5370 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5373 struct lttng_ht_iter iter
;
5374 struct ust_app
*app
;
5376 DBG("Destroy all UST traces");
5380 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5381 ret
= destroy_trace(usess
, app
);
5383 /* Continue to next apps even on error */
5393 /* The ua_sess lock must be held by the caller. */
5395 int find_or_create_ust_app_channel(
5396 struct ltt_ust_session
*usess
,
5397 struct ust_app_session
*ua_sess
,
5398 struct ust_app
*app
,
5399 struct ltt_ust_channel
*uchan
,
5400 struct ust_app_channel
**ua_chan
)
5403 struct lttng_ht_iter iter
;
5404 struct lttng_ht_node_str
*ua_chan_node
;
5406 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5407 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5409 *ua_chan
= caa_container_of(ua_chan_node
,
5410 struct ust_app_channel
, node
);
5414 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5423 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5424 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5425 struct ust_app
*app
)
5428 struct ust_app_event
*ua_event
= NULL
;
5430 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5431 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5433 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5438 if (ua_event
->enabled
!= uevent
->enabled
) {
5439 ret
= uevent
->enabled
?
5440 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5441 disable_ust_app_event(ua_sess
, ua_event
, app
);
5449 /* Called with RCU read-side lock held. */
5451 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5454 enum lttng_error_code ret_code
;
5455 enum lttng_trigger_status t_status
;
5456 struct lttng_ht_iter app_trigger_iter
;
5457 struct lttng_triggers
*triggers
= NULL
;
5458 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5459 unsigned int count
, i
;
5462 * Currrently, registering or unregistering a trigger with an
5463 * event rule condition causes a full synchronization of the event
5466 * The first step attempts to add an event notifier for all registered
5467 * triggers that apply to the user space tracers. Then, the
5468 * application's event notifiers rules are all checked against the list
5469 * of registered triggers. Any event notifier that doesn't have a
5470 * matching trigger can be assumed to have been disabled.
5472 * All of this is inefficient, but is put in place to get the feature
5473 * rolling as it is simpler at this moment. It will be optimized Soon™
5474 * to allow the state of enabled
5475 * event notifiers to be synchronized in a piece-wise way.
5478 /* Get all triggers using uid 0 (root) */
5479 ret_code
= notification_thread_command_list_triggers(
5480 notification_thread_handle
, 0, &triggers
);
5481 if (ret_code
!= LTTNG_OK
) {
5488 t_status
= lttng_triggers_get_count(triggers
, &count
);
5489 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5494 for (i
= 0; i
< count
; i
++) {
5495 struct lttng_condition
*condition
;
5496 struct lttng_event_rule
*event_rule
;
5497 struct lttng_trigger
*trigger
;
5498 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5499 enum lttng_condition_status condition_status
;
5502 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5505 token
= lttng_trigger_get_tracer_token(trigger
);
5506 condition
= lttng_trigger_get_condition(trigger
);
5508 if (lttng_condition_get_type(condition
) != LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
) {
5509 /* Does not apply */
5513 condition_status
= lttng_condition_event_rule_borrow_rule_mutable(condition
, &event_rule
);
5514 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5516 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5517 /* Skip kernel related triggers. */
5522 * Find or create the associated token event rule. The caller
5523 * holds the RCU read lock, so this is safe to call without
5524 * explicitly acquiring it here.
5526 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5527 app
->token_to_event_notifier_rule_ht
, token
);
5528 if (!looked_up_event_notifier_rule
) {
5529 ret
= create_ust_app_event_notifier_rule(event_rule
, app
, token
);
5537 /* Remove all unknown event sources from the app. */
5538 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5539 &app_trigger_iter
.iter
, event_notifier_rule
,
5541 const uint64_t app_token
= event_notifier_rule
->token
;
5545 * Check if the app event trigger still exists on the
5546 * notification side.
5548 for (i
= 0; i
< count
; i
++) {
5549 uint64_t notification_thread_token
;
5550 const struct lttng_trigger
*trigger
=
5551 lttng_triggers_get_at_index(
5556 notification_thread_token
=
5557 lttng_trigger_get_tracer_token(trigger
);
5559 if (notification_thread_token
== app_token
) {
5571 * This trigger was unregistered, disable it on the tracer's
5574 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5578 /* Callee logs errors. */
5579 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5581 delete_ust_app_event_notifier_rule(
5582 app
->sock
, event_notifier_rule
, app
);
5588 lttng_triggers_destroy(triggers
);
5593 * The caller must ensure that the application is compatible and is tracked
5594 * by the process attribute trackers.
5597 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5598 struct ust_app
*app
)
5601 struct cds_lfht_iter uchan_iter
;
5602 struct ltt_ust_channel
*uchan
;
5603 struct ust_app_session
*ua_sess
= NULL
;
5606 * The application's configuration should only be synchronized for
5609 assert(usess
->active
);
5611 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5613 /* Tracer is probably gone or ENOMEM. */
5618 pthread_mutex_lock(&ua_sess
->lock
);
5619 if (ua_sess
->deleted
) {
5620 pthread_mutex_unlock(&ua_sess
->lock
);
5626 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5628 struct ust_app_channel
*ua_chan
;
5629 struct cds_lfht_iter uevent_iter
;
5630 struct ltt_ust_event
*uevent
;
5633 * Search for a matching ust_app_channel. If none is found,
5634 * create it. Creating the channel will cause the ua_chan
5635 * structure to be allocated, the channel buffers to be
5636 * allocated (if necessary) and sent to the application, and
5637 * all enabled contexts will be added to the channel.
5639 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5640 app
, uchan
, &ua_chan
);
5642 /* Tracer is probably gone or ENOMEM. */
5647 /* ua_chan will be NULL for the metadata channel */
5651 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5653 ret
= ust_app_channel_synchronize_event(ua_chan
,
5654 uevent
, ua_sess
, app
);
5660 if (ua_chan
->enabled
!= uchan
->enabled
) {
5661 ret
= uchan
->enabled
?
5662 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5663 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5671 * Create the metadata for the application. This returns gracefully if a
5672 * metadata was already set for the session.
5674 * The metadata channel must be created after the data channels as the
5675 * consumer daemon assumes this ordering. When interacting with a relay
5676 * daemon, the consumer will use this assumption to send the
5677 * "STREAMS_SENT" message to the relay daemon.
5679 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
5687 pthread_mutex_unlock(&ua_sess
->lock
);
5688 /* Everything went well at this point. */
5693 pthread_mutex_unlock(&ua_sess
->lock
);
5696 destroy_app_session(app
, ua_sess
);
5702 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5704 struct ust_app_session
*ua_sess
;
5706 ua_sess
= lookup_session_by_app(usess
, app
);
5707 if (ua_sess
== NULL
) {
5710 destroy_app_session(app
, ua_sess
);
5714 * Add channels/events from UST global domain to registered apps at sock.
5716 * Called with session lock held.
5717 * Called with RCU read-side lock held.
5719 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5722 assert(usess
->active
);
5724 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5725 app
->sock
, usess
->id
);
5727 if (!app
->compatible
) {
5730 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5732 trace_ust_id_tracker_lookup(
5733 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5735 trace_ust_id_tracker_lookup(
5736 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5739 * Synchronize the application's internal tracing configuration
5740 * and start tracing.
5742 ust_app_synchronize(usess
, app
);
5743 ust_app_start_trace(usess
, app
);
5745 ust_app_global_destroy(usess
, app
);
5750 * Add all event notifiers to an application.
5752 * Called with session lock held.
5753 * Called with RCU read-side lock held.
5755 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
5757 DBG2("UST application global event notifier rules update: app = '%s' (ppid: %d)",
5758 app
->name
, app
->ppid
);
5760 if (!app
->compatible
) {
5764 if (app
->event_notifier_group
.object
== NULL
) {
5765 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' (ppid: %d)",
5766 app
->name
, app
->ppid
);
5770 ust_app_synchronize_event_notifier_rules(app
);
5774 * Called with session lock held.
5776 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5778 struct lttng_ht_iter iter
;
5779 struct ust_app
*app
;
5782 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5783 ust_app_global_update(usess
, app
);
5788 void ust_app_global_update_all_event_notifier_rules(void)
5790 struct lttng_ht_iter iter
;
5791 struct ust_app
*app
;
5794 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5795 ust_app_global_update_event_notifier_rules(app
);
5802 * Add context to a specific channel for global UST domain.
5804 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5805 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5808 struct lttng_ht_node_str
*ua_chan_node
;
5809 struct lttng_ht_iter iter
, uiter
;
5810 struct ust_app_channel
*ua_chan
= NULL
;
5811 struct ust_app_session
*ua_sess
;
5812 struct ust_app
*app
;
5814 assert(usess
->active
);
5817 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5818 if (!app
->compatible
) {
5820 * TODO: In time, we should notice the caller of this error by
5821 * telling him that this is a version error.
5825 ua_sess
= lookup_session_by_app(usess
, app
);
5826 if (ua_sess
== NULL
) {
5830 pthread_mutex_lock(&ua_sess
->lock
);
5832 if (ua_sess
->deleted
) {
5833 pthread_mutex_unlock(&ua_sess
->lock
);
5837 /* Lookup channel in the ust app session */
5838 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5839 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5840 if (ua_chan_node
== NULL
) {
5843 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5845 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5850 pthread_mutex_unlock(&ua_sess
->lock
);
5858 * Receive registration and populate the given msg structure.
5860 * On success return 0 else a negative value returned by the ustctl call.
5862 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5865 uint32_t pid
, ppid
, uid
, gid
;
5869 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5870 &pid
, &ppid
, &uid
, &gid
,
5871 &msg
->bits_per_long
,
5872 &msg
->uint8_t_alignment
,
5873 &msg
->uint16_t_alignment
,
5874 &msg
->uint32_t_alignment
,
5875 &msg
->uint64_t_alignment
,
5876 &msg
->long_alignment
,
5883 case LTTNG_UST_ERR_EXITING
:
5884 DBG3("UST app recv reg message failed. Application died");
5886 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5887 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5888 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5889 LTTNG_UST_ABI_MINOR_VERSION
);
5892 ERR("UST app recv reg message failed with ret %d", ret
);
5897 msg
->pid
= (pid_t
) pid
;
5898 msg
->ppid
= (pid_t
) ppid
;
5899 msg
->uid
= (uid_t
) uid
;
5900 msg
->gid
= (gid_t
) gid
;
5907 * Return a ust app session object using the application object and the
5908 * session object descriptor has a key. If not found, NULL is returned.
5909 * A RCU read side lock MUST be acquired when calling this function.
5911 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5914 struct lttng_ht_node_ulong
*node
;
5915 struct lttng_ht_iter iter
;
5916 struct ust_app_session
*ua_sess
= NULL
;
5920 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5921 node
= lttng_ht_iter_get_node_ulong(&iter
);
5923 DBG2("UST app session find by objd %d not found", objd
);
5927 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5934 * Return a ust app channel object using the application object and the channel
5935 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5936 * lock MUST be acquired before calling this function.
5938 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5941 struct lttng_ht_node_ulong
*node
;
5942 struct lttng_ht_iter iter
;
5943 struct ust_app_channel
*ua_chan
= NULL
;
5947 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5948 node
= lttng_ht_iter_get_node_ulong(&iter
);
5950 DBG2("UST app channel find by objd %d not found", objd
);
5954 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5961 * Reply to a register channel notification from an application on the notify
5962 * socket. The channel metadata is also created.
5964 * The session UST registry lock is acquired in this function.
5966 * On success 0 is returned else a negative value.
5968 static int reply_ust_register_channel(int sock
, int cobjd
,
5969 size_t nr_fields
, struct ustctl_field
*fields
)
5971 int ret
, ret_code
= 0;
5973 uint64_t chan_reg_key
;
5974 enum ustctl_channel_header type
;
5975 struct ust_app
*app
;
5976 struct ust_app_channel
*ua_chan
;
5977 struct ust_app_session
*ua_sess
;
5978 struct ust_registry_session
*registry
;
5979 struct ust_registry_channel
*chan_reg
;
5983 /* Lookup application. If not found, there is a code flow error. */
5984 app
= find_app_by_notify_sock(sock
);
5986 DBG("Application socket %d is being torn down. Abort event notify",
5989 goto error_rcu_unlock
;
5992 /* Lookup channel by UST object descriptor. */
5993 ua_chan
= find_channel_by_objd(app
, cobjd
);
5995 DBG("Application channel is being torn down. Abort event notify");
5997 goto error_rcu_unlock
;
6000 assert(ua_chan
->session
);
6001 ua_sess
= ua_chan
->session
;
6003 /* Get right session registry depending on the session buffer type. */
6004 registry
= get_session_registry(ua_sess
);
6006 DBG("Application session is being torn down. Abort event notify");
6008 goto error_rcu_unlock
;
6011 /* Depending on the buffer type, a different channel key is used. */
6012 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6013 chan_reg_key
= ua_chan
->tracing_channel_id
;
6015 chan_reg_key
= ua_chan
->key
;
6018 pthread_mutex_lock(®istry
->lock
);
6020 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
6023 if (!chan_reg
->register_done
) {
6025 * TODO: eventually use the registry event count for
6026 * this channel to better guess header type for per-pid
6029 type
= USTCTL_CHANNEL_HEADER_LARGE
;
6030 chan_reg
->nr_ctx_fields
= nr_fields
;
6031 chan_reg
->ctx_fields
= fields
;
6033 chan_reg
->header_type
= type
;
6035 /* Get current already assigned values. */
6036 type
= chan_reg
->header_type
;
6038 /* Channel id is set during the object creation. */
6039 chan_id
= chan_reg
->chan_id
;
6041 /* Append to metadata */
6042 if (!chan_reg
->metadata_dumped
) {
6043 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
6045 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6051 DBG3("UST app replying to register channel key %" PRIu64
6052 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
6055 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6057 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6058 ERR("UST app reply channel failed with ret %d", ret
);
6060 DBG3("UST app reply channel failed. Application died");
6065 /* This channel registry registration is completed. */
6066 chan_reg
->register_done
= 1;
6069 pthread_mutex_unlock(®istry
->lock
);
6077 * Add event to the UST channel registry. When the event is added to the
6078 * registry, the metadata is also created. Once done, this replies to the
6079 * application with the appropriate error code.
6081 * The session UST registry lock is acquired in the function.
6083 * On success 0 is returned else a negative value.
6085 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6086 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
6087 int loglevel_value
, char *model_emf_uri
)
6090 uint32_t event_id
= 0;
6091 uint64_t chan_reg_key
;
6092 struct ust_app
*app
;
6093 struct ust_app_channel
*ua_chan
;
6094 struct ust_app_session
*ua_sess
;
6095 struct ust_registry_session
*registry
;
6099 /* Lookup application. If not found, there is a code flow error. */
6100 app
= find_app_by_notify_sock(sock
);
6102 DBG("Application socket %d is being torn down. Abort event notify",
6105 goto error_rcu_unlock
;
6108 /* Lookup channel by UST object descriptor. */
6109 ua_chan
= find_channel_by_objd(app
, cobjd
);
6111 DBG("Application channel is being torn down. Abort event notify");
6113 goto error_rcu_unlock
;
6116 assert(ua_chan
->session
);
6117 ua_sess
= ua_chan
->session
;
6119 registry
= get_session_registry(ua_sess
);
6121 DBG("Application session is being torn down. Abort event notify");
6123 goto error_rcu_unlock
;
6126 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6127 chan_reg_key
= ua_chan
->tracing_channel_id
;
6129 chan_reg_key
= ua_chan
->key
;
6132 pthread_mutex_lock(®istry
->lock
);
6135 * From this point on, this call acquires the ownership of the sig, fields
6136 * and model_emf_uri meaning any free are done inside it if needed. These
6137 * three variables MUST NOT be read/write after this.
6139 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6140 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6141 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6145 model_emf_uri
= NULL
;
6148 * The return value is returned to ustctl so in case of an error, the
6149 * application can be notified. In case of an error, it's important not to
6150 * return a negative error or else the application will get closed.
6152 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
6154 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6155 ERR("UST app reply event failed with ret %d", ret
);
6157 DBG3("UST app reply event failed. Application died");
6160 * No need to wipe the create event since the application socket will
6161 * get close on error hence cleaning up everything by itself.
6166 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6170 pthread_mutex_unlock(®istry
->lock
);
6175 free(model_emf_uri
);
6180 * Add enum to the UST session registry. Once done, this replies to the
6181 * application with the appropriate error code.
6183 * The session UST registry lock is acquired within this function.
6185 * On success 0 is returned else a negative value.
6187 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6188 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
6190 int ret
= 0, ret_code
;
6191 struct ust_app
*app
;
6192 struct ust_app_session
*ua_sess
;
6193 struct ust_registry_session
*registry
;
6194 uint64_t enum_id
= -1ULL;
6198 /* Lookup application. If not found, there is a code flow error. */
6199 app
= find_app_by_notify_sock(sock
);
6201 /* Return an error since this is not an error */
6202 DBG("Application socket %d is being torn down. Aborting enum registration",
6205 goto error_rcu_unlock
;
6208 /* Lookup session by UST object descriptor. */
6209 ua_sess
= find_session_by_objd(app
, sobjd
);
6211 /* Return an error since this is not an error */
6212 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6214 goto error_rcu_unlock
;
6217 registry
= get_session_registry(ua_sess
);
6219 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6221 goto error_rcu_unlock
;
6224 pthread_mutex_lock(®istry
->lock
);
6227 * From this point on, the callee acquires the ownership of
6228 * entries. The variable entries MUST NOT be read/written after
6231 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6232 entries
, nr_entries
, &enum_id
);
6236 * The return value is returned to ustctl so in case of an error, the
6237 * application can be notified. In case of an error, it's important not to
6238 * return a negative error or else the application will get closed.
6240 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
6242 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6243 ERR("UST app reply enum failed with ret %d", ret
);
6245 DBG3("UST app reply enum failed. Application died");
6248 * No need to wipe the create enum since the application socket will
6249 * get close on error hence cleaning up everything by itself.
6254 DBG3("UST registry enum %s added successfully or already found", name
);
6257 pthread_mutex_unlock(®istry
->lock
);
6264 * Handle application notification through the given notify socket.
6266 * Return 0 on success or else a negative value.
6268 int ust_app_recv_notify(int sock
)
6271 enum ustctl_notify_cmd cmd
;
6273 DBG3("UST app receiving notify from sock %d", sock
);
6275 ret
= ustctl_recv_notify(sock
, &cmd
);
6277 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6278 ERR("UST app recv notify failed with ret %d", ret
);
6280 DBG3("UST app recv notify failed. Application died");
6286 case USTCTL_NOTIFY_CMD_EVENT
:
6288 int sobjd
, cobjd
, loglevel_value
;
6289 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6291 struct ustctl_field
*fields
;
6293 DBG2("UST app ustctl register event received");
6295 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6296 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6299 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6300 ERR("UST app recv event failed with ret %d", ret
);
6302 DBG3("UST app recv event failed. Application died");
6308 * Add event to the UST registry coming from the notify socket. This
6309 * call will free if needed the sig, fields and model_emf_uri. This
6310 * code path loses the ownsership of these variables and transfer them
6311 * to the this function.
6313 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6314 fields
, loglevel_value
, model_emf_uri
);
6321 case USTCTL_NOTIFY_CMD_CHANNEL
:
6325 struct ustctl_field
*fields
;
6327 DBG2("UST app ustctl register channel received");
6329 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6332 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6333 ERR("UST app recv channel failed with ret %d", ret
);
6335 DBG3("UST app recv channel failed. Application died");
6341 * The fields ownership are transfered to this function call meaning
6342 * that if needed it will be freed. After this, it's invalid to access
6343 * fields or clean it up.
6345 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6353 case USTCTL_NOTIFY_CMD_ENUM
:
6356 char name
[LTTNG_UST_SYM_NAME_LEN
];
6358 struct ustctl_enum_entry
*entries
;
6360 DBG2("UST app ustctl register enum received");
6362 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
6363 &entries
, &nr_entries
);
6365 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6366 ERR("UST app recv enum failed with ret %d", ret
);
6368 DBG3("UST app recv enum failed. Application died");
6373 /* Callee assumes ownership of entries */
6374 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6375 entries
, nr_entries
);
6383 /* Should NEVER happen. */
6392 * Once the notify socket hangs up, this is called. First, it tries to find the
6393 * corresponding application. On failure, the call_rcu to close the socket is
6394 * executed. If an application is found, it tries to delete it from the notify
6395 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6397 * Note that an object needs to be allocated here so on ENOMEM failure, the
6398 * call RCU is not done but the rest of the cleanup is.
6400 void ust_app_notify_sock_unregister(int sock
)
6403 struct lttng_ht_iter iter
;
6404 struct ust_app
*app
;
6405 struct ust_app_notify_sock_obj
*obj
;
6411 obj
= zmalloc(sizeof(*obj
));
6414 * An ENOMEM is kind of uncool. If this strikes we continue the
6415 * procedure but the call_rcu will not be called. In this case, we
6416 * accept the fd leak rather than possibly creating an unsynchronized
6417 * state between threads.
6419 * TODO: The notify object should be created once the notify socket is
6420 * registered and stored independantely from the ust app object. The
6421 * tricky part is to synchronize the teardown of the application and
6422 * this notify object. Let's keep that in mind so we can avoid this
6423 * kind of shenanigans with ENOMEM in the teardown path.
6430 DBG("UST app notify socket unregister %d", sock
);
6433 * Lookup application by notify socket. If this fails, this means that the
6434 * hash table delete has already been done by the application
6435 * unregistration process so we can safely close the notify socket in a
6438 app
= find_app_by_notify_sock(sock
);
6443 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6446 * Whatever happens here either we fail or succeed, in both cases we have
6447 * to close the socket after a grace period to continue to the call RCU
6448 * here. If the deletion is successful, the application is not visible
6449 * anymore by other threads and is it fails it means that it was already
6450 * deleted from the hash table so either way we just have to close the
6453 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6459 * Close socket after a grace period to avoid for the socket to be reused
6460 * before the application object is freed creating potential race between
6461 * threads trying to add unique in the global hash table.
6464 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6469 * Destroy a ust app data structure and free its memory.
6471 void ust_app_destroy(struct ust_app
*app
)
6477 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6481 * Take a snapshot for a given UST session. The snapshot is sent to the given
6484 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6486 enum lttng_error_code
ust_app_snapshot_record(
6487 const struct ltt_ust_session
*usess
,
6488 const struct consumer_output
*output
, int wait
,
6489 uint64_t nb_packets_per_stream
)
6492 enum lttng_error_code status
= LTTNG_OK
;
6493 struct lttng_ht_iter iter
;
6494 struct ust_app
*app
;
6495 char *trace_path
= NULL
;
6502 switch (usess
->buffer_type
) {
6503 case LTTNG_BUFFER_PER_UID
:
6505 struct buffer_reg_uid
*reg
;
6507 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6508 struct buffer_reg_channel
*reg_chan
;
6509 struct consumer_socket
*socket
;
6510 char pathname
[PATH_MAX
];
6511 size_t consumer_path_offset
= 0;
6513 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6514 /* Skip since no metadata is present */
6518 /* Get consumer socket to use to push the metadata.*/
6519 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6522 status
= LTTNG_ERR_INVALID
;
6526 memset(pathname
, 0, sizeof(pathname
));
6527 ret
= snprintf(pathname
, sizeof(pathname
),
6528 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6529 reg
->uid
, reg
->bits_per_long
);
6531 PERROR("snprintf snapshot path");
6532 status
= LTTNG_ERR_INVALID
;
6535 /* Free path allowed on previous iteration. */
6537 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6538 &consumer_path_offset
);
6540 status
= LTTNG_ERR_INVALID
;
6543 /* Add the UST default trace dir to path. */
6544 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6545 reg_chan
, node
.node
) {
6546 status
= consumer_snapshot_channel(socket
,
6547 reg_chan
->consumer_key
,
6548 output
, 0, usess
->uid
,
6549 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6550 nb_packets_per_stream
);
6551 if (status
!= LTTNG_OK
) {
6555 status
= consumer_snapshot_channel(socket
,
6556 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6557 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6559 if (status
!= LTTNG_OK
) {
6565 case LTTNG_BUFFER_PER_PID
:
6567 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6568 struct consumer_socket
*socket
;
6569 struct lttng_ht_iter chan_iter
;
6570 struct ust_app_channel
*ua_chan
;
6571 struct ust_app_session
*ua_sess
;
6572 struct ust_registry_session
*registry
;
6573 char pathname
[PATH_MAX
];
6574 size_t consumer_path_offset
= 0;
6576 ua_sess
= lookup_session_by_app(usess
, app
);
6578 /* Session not associated with this app. */
6582 /* Get the right consumer socket for the application. */
6583 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6586 status
= LTTNG_ERR_INVALID
;
6590 /* Add the UST default trace dir to path. */
6591 memset(pathname
, 0, sizeof(pathname
));
6592 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6595 status
= LTTNG_ERR_INVALID
;
6596 PERROR("snprintf snapshot path");
6599 /* Free path allowed on previous iteration. */
6601 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6602 &consumer_path_offset
);
6604 status
= LTTNG_ERR_INVALID
;
6607 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6608 ua_chan
, node
.node
) {
6609 status
= consumer_snapshot_channel(socket
,
6610 ua_chan
->key
, output
, 0,
6611 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6612 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6613 &trace_path
[consumer_path_offset
], wait
,
6614 nb_packets_per_stream
);
6618 case LTTNG_ERR_CHAN_NOT_FOUND
:
6625 registry
= get_session_registry(ua_sess
);
6627 DBG("Application session is being torn down. Skip application.");
6630 status
= consumer_snapshot_channel(socket
,
6631 registry
->metadata_key
, output
, 1,
6632 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6633 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6634 &trace_path
[consumer_path_offset
], wait
, 0);
6638 case LTTNG_ERR_CHAN_NOT_FOUND
:
6658 * Return the size taken by one more packet per stream.
6660 uint64_t ust_app_get_size_one_more_packet_per_stream(
6661 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6663 uint64_t tot_size
= 0;
6664 struct ust_app
*app
;
6665 struct lttng_ht_iter iter
;
6669 switch (usess
->buffer_type
) {
6670 case LTTNG_BUFFER_PER_UID
:
6672 struct buffer_reg_uid
*reg
;
6674 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6675 struct buffer_reg_channel
*reg_chan
;
6678 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6679 reg_chan
, node
.node
) {
6680 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6682 * Don't take channel into account if we
6683 * already grab all its packets.
6687 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6693 case LTTNG_BUFFER_PER_PID
:
6696 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6697 struct ust_app_channel
*ua_chan
;
6698 struct ust_app_session
*ua_sess
;
6699 struct lttng_ht_iter chan_iter
;
6701 ua_sess
= lookup_session_by_app(usess
, app
);
6703 /* Session not associated with this app. */
6707 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6708 ua_chan
, node
.node
) {
6709 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6711 * Don't take channel into account if we
6712 * already grab all its packets.
6716 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6730 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6731 struct cds_list_head
*buffer_reg_uid_list
,
6732 struct consumer_output
*consumer
, uint64_t uchan_id
,
6733 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6736 uint64_t consumer_chan_key
;
6741 ret
= buffer_reg_uid_consumer_channel_key(
6742 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6750 ret
= consumer_get_lost_packets(ust_session_id
,
6751 consumer_chan_key
, consumer
, lost
);
6753 ret
= consumer_get_discarded_events(ust_session_id
,
6754 consumer_chan_key
, consumer
, discarded
);
6761 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6762 struct ltt_ust_channel
*uchan
,
6763 struct consumer_output
*consumer
, int overwrite
,
6764 uint64_t *discarded
, uint64_t *lost
)
6767 struct lttng_ht_iter iter
;
6768 struct lttng_ht_node_str
*ua_chan_node
;
6769 struct ust_app
*app
;
6770 struct ust_app_session
*ua_sess
;
6771 struct ust_app_channel
*ua_chan
;
6778 * Iterate over every registered applications. Sum counters for
6779 * all applications containing requested session and channel.
6781 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6782 struct lttng_ht_iter uiter
;
6784 ua_sess
= lookup_session_by_app(usess
, app
);
6785 if (ua_sess
== NULL
) {
6790 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6791 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6792 /* If the session is found for the app, the channel must be there */
6793 assert(ua_chan_node
);
6795 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6800 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6807 uint64_t _discarded
;
6809 ret
= consumer_get_discarded_events(usess
->id
,
6810 ua_chan
->key
, consumer
, &_discarded
);
6814 (*discarded
) += _discarded
;
6823 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6824 struct ust_app
*app
)
6827 struct ust_app_session
*ua_sess
;
6829 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6833 ua_sess
= lookup_session_by_app(usess
, app
);
6834 if (ua_sess
== NULL
) {
6835 /* The session is in teardown process. Ignore and continue. */
6839 pthread_mutex_lock(&ua_sess
->lock
);
6841 if (ua_sess
->deleted
) {
6845 pthread_mutex_lock(&app
->sock_lock
);
6846 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6847 pthread_mutex_unlock(&app
->sock_lock
);
6850 pthread_mutex_unlock(&ua_sess
->lock
);
6854 health_code_update();
6859 * Regenerate the statedump for each app in the session.
6861 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6864 struct lttng_ht_iter iter
;
6865 struct ust_app
*app
;
6867 DBG("Regenerating the metadata for all UST apps");
6871 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6872 if (!app
->compatible
) {
6876 ret
= ust_app_regenerate_statedump(usess
, app
);
6878 /* Continue to the next app even on error */
6889 * Rotate all the channels of a session.
6891 * Return LTTNG_OK on success or else an LTTng error code.
6893 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6896 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6897 struct lttng_ht_iter iter
;
6898 struct ust_app
*app
;
6899 struct ltt_ust_session
*usess
= session
->ust_session
;
6905 switch (usess
->buffer_type
) {
6906 case LTTNG_BUFFER_PER_UID
:
6908 struct buffer_reg_uid
*reg
;
6910 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6911 struct buffer_reg_channel
*reg_chan
;
6912 struct consumer_socket
*socket
;
6914 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6915 /* Skip since no metadata is present */
6919 /* Get consumer socket to use to push the metadata.*/
6920 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6923 cmd_ret
= LTTNG_ERR_INVALID
;
6927 /* Rotate the data channels. */
6928 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6929 reg_chan
, node
.node
) {
6930 ret
= consumer_rotate_channel(socket
,
6931 reg_chan
->consumer_key
,
6932 usess
->uid
, usess
->gid
,
6934 /* is_metadata_channel */ false);
6936 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6941 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6943 ret
= consumer_rotate_channel(socket
,
6944 reg
->registry
->reg
.ust
->metadata_key
,
6945 usess
->uid
, usess
->gid
,
6947 /* is_metadata_channel */ true);
6949 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6955 case LTTNG_BUFFER_PER_PID
:
6957 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6958 struct consumer_socket
*socket
;
6959 struct lttng_ht_iter chan_iter
;
6960 struct ust_app_channel
*ua_chan
;
6961 struct ust_app_session
*ua_sess
;
6962 struct ust_registry_session
*registry
;
6964 ua_sess
= lookup_session_by_app(usess
, app
);
6966 /* Session not associated with this app. */
6970 /* Get the right consumer socket for the application. */
6971 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6974 cmd_ret
= LTTNG_ERR_INVALID
;
6978 registry
= get_session_registry(ua_sess
);
6980 DBG("Application session is being torn down. Skip application.");
6984 /* Rotate the data channels. */
6985 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6986 ua_chan
, node
.node
) {
6987 ret
= consumer_rotate_channel(socket
,
6989 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6990 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6992 /* is_metadata_channel */ false);
6994 /* Per-PID buffer and application going away. */
6995 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
6997 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7002 /* Rotate the metadata channel. */
7003 (void) push_metadata(registry
, usess
->consumer
);
7004 ret
= consumer_rotate_channel(socket
,
7005 registry
->metadata_key
,
7006 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7007 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7009 /* is_metadata_channel */ true);
7011 /* Per-PID buffer and application going away. */
7012 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7014 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7032 enum lttng_error_code
ust_app_create_channel_subdirectories(
7033 const struct ltt_ust_session
*usess
)
7035 enum lttng_error_code ret
= LTTNG_OK
;
7036 struct lttng_ht_iter iter
;
7037 enum lttng_trace_chunk_status chunk_status
;
7038 char *pathname_index
;
7041 assert(usess
->current_trace_chunk
);
7044 switch (usess
->buffer_type
) {
7045 case LTTNG_BUFFER_PER_UID
:
7047 struct buffer_reg_uid
*reg
;
7049 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7050 fmt_ret
= asprintf(&pathname_index
,
7051 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7052 reg
->uid
, reg
->bits_per_long
);
7054 ERR("Failed to format channel index directory");
7055 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7060 * Create the index subdirectory which will take care
7061 * of implicitly creating the channel's path.
7063 chunk_status
= lttng_trace_chunk_create_subdirectory(
7064 usess
->current_trace_chunk
,
7066 free(pathname_index
);
7067 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7068 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7074 case LTTNG_BUFFER_PER_PID
:
7076 struct ust_app
*app
;
7079 * Create the toplevel ust/ directory in case no apps are running.
7081 chunk_status
= lttng_trace_chunk_create_subdirectory(
7082 usess
->current_trace_chunk
,
7083 DEFAULT_UST_TRACE_DIR
);
7084 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7085 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7089 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7091 struct ust_app_session
*ua_sess
;
7092 struct ust_registry_session
*registry
;
7094 ua_sess
= lookup_session_by_app(usess
, app
);
7096 /* Session not associated with this app. */
7100 registry
= get_session_registry(ua_sess
);
7102 DBG("Application session is being torn down. Skip application.");
7106 fmt_ret
= asprintf(&pathname_index
,
7107 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7110 ERR("Failed to format channel index directory");
7111 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7115 * Create the index subdirectory which will take care
7116 * of implicitly creating the channel's path.
7118 chunk_status
= lttng_trace_chunk_create_subdirectory(
7119 usess
->current_trace_chunk
,
7121 free(pathname_index
);
7122 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7123 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7140 * Clear all the channels of a session.
7142 * Return LTTNG_OK on success or else an LTTng error code.
7144 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7147 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7148 struct lttng_ht_iter iter
;
7149 struct ust_app
*app
;
7150 struct ltt_ust_session
*usess
= session
->ust_session
;
7156 if (usess
->active
) {
7157 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7158 cmd_ret
= LTTNG_ERR_FATAL
;
7162 switch (usess
->buffer_type
) {
7163 case LTTNG_BUFFER_PER_UID
:
7165 struct buffer_reg_uid
*reg
;
7167 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7168 struct buffer_reg_channel
*reg_chan
;
7169 struct consumer_socket
*socket
;
7171 /* Get consumer socket to use to push the metadata.*/
7172 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7175 cmd_ret
= LTTNG_ERR_INVALID
;
7179 /* Clear the data channels. */
7180 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7181 reg_chan
, node
.node
) {
7182 ret
= consumer_clear_channel(socket
,
7183 reg_chan
->consumer_key
);
7189 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7192 * Clear the metadata channel.
7193 * Metadata channel is not cleared per se but we still need to
7194 * perform a rotation operation on it behind the scene.
7196 ret
= consumer_clear_channel(socket
,
7197 reg
->registry
->reg
.ust
->metadata_key
);
7204 case LTTNG_BUFFER_PER_PID
:
7206 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7207 struct consumer_socket
*socket
;
7208 struct lttng_ht_iter chan_iter
;
7209 struct ust_app_channel
*ua_chan
;
7210 struct ust_app_session
*ua_sess
;
7211 struct ust_registry_session
*registry
;
7213 ua_sess
= lookup_session_by_app(usess
, app
);
7215 /* Session not associated with this app. */
7219 /* Get the right consumer socket for the application. */
7220 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7223 cmd_ret
= LTTNG_ERR_INVALID
;
7227 registry
= get_session_registry(ua_sess
);
7229 DBG("Application session is being torn down. Skip application.");
7233 /* Clear the data channels. */
7234 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7235 ua_chan
, node
.node
) {
7236 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7238 /* Per-PID buffer and application going away. */
7239 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7246 (void) push_metadata(registry
, usess
->consumer
);
7249 * Clear the metadata channel.
7250 * Metadata channel is not cleared per se but we still need to
7251 * perform rotation operation on it behind the scene.
7253 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7255 /* Per-PID buffer and application going away. */
7256 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7274 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7275 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7278 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7288 * This function skips the metadata channel as the begin/end timestamps of a
7289 * metadata packet are useless.
7291 * Moreover, opening a packet after a "clear" will cause problems for live
7292 * sessions as it will introduce padding that was not part of the first trace
7293 * chunk. The relay daemon expects the content of the metadata stream of
7294 * successive metadata trace chunks to be strict supersets of one another.
7296 * For example, flushing a packet at the beginning of the metadata stream of
7297 * a trace chunk resulting from a "clear" session command will cause the
7298 * size of the metadata stream of the new trace chunk to not match the size of
7299 * the metadata stream of the original chunk. This will confuse the relay
7300 * daemon as the same "offset" in a metadata stream will no longer point
7301 * to the same content.
7303 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7305 enum lttng_error_code ret
= LTTNG_OK
;
7306 struct lttng_ht_iter iter
;
7307 struct ltt_ust_session
*usess
= session
->ust_session
;
7313 switch (usess
->buffer_type
) {
7314 case LTTNG_BUFFER_PER_UID
:
7316 struct buffer_reg_uid
*reg
;
7318 cds_list_for_each_entry (
7319 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7320 struct buffer_reg_channel
*reg_chan
;
7321 struct consumer_socket
*socket
;
7323 socket
= consumer_find_socket_by_bitness(
7324 reg
->bits_per_long
, usess
->consumer
);
7326 ret
= LTTNG_ERR_FATAL
;
7330 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7331 &iter
.iter
, reg_chan
, node
.node
) {
7332 const int open_ret
=
7333 consumer_open_channel_packets(
7335 reg_chan
->consumer_key
);
7338 ret
= LTTNG_ERR_UNK
;
7345 case LTTNG_BUFFER_PER_PID
:
7347 struct ust_app
*app
;
7349 cds_lfht_for_each_entry (
7350 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7351 struct consumer_socket
*socket
;
7352 struct lttng_ht_iter chan_iter
;
7353 struct ust_app_channel
*ua_chan
;
7354 struct ust_app_session
*ua_sess
;
7355 struct ust_registry_session
*registry
;
7357 ua_sess
= lookup_session_by_app(usess
, app
);
7359 /* Session not associated with this app. */
7363 /* Get the right consumer socket for the application. */
7364 socket
= consumer_find_socket_by_bitness(
7365 app
->bits_per_long
, usess
->consumer
);
7367 ret
= LTTNG_ERR_FATAL
;
7371 registry
= get_session_registry(ua_sess
);
7373 DBG("Application session is being torn down. Skip application.");
7377 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7378 &chan_iter
.iter
, ua_chan
, node
.node
) {
7379 const int open_ret
=
7380 consumer_open_channel_packets(
7386 * Per-PID buffer and application going
7389 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7393 ret
= LTTNG_ERR_UNK
;