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
19 #include <sys/types.h>
21 #include <urcu/compiler.h>
24 #include <common/bytecode/bytecode.h>
25 #include <common/common.h>
26 #include <common/hashtable/utils.h>
27 #include <lttng/event-rule/event-rule.h>
28 #include <lttng/event-rule/event-rule-internal.h>
29 #include <lttng/event-rule/tracepoint.h>
30 #include <lttng/condition/condition.h>
31 #include <lttng/condition/event-rule-internal.h>
32 #include <lttng/condition/event-rule.h>
33 #include <lttng/trigger/trigger-internal.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
36 #include "buffer-registry.h"
37 #include "condition-internal.h"
39 #include "health-sessiond.h"
41 #include "ust-consumer.h"
42 #include "lttng-ust-ctl.h"
43 #include "lttng-ust-error.h"
46 #include "lttng-sessiond.h"
47 #include "notification-thread-commands.h"
50 #include "trigger-error-accounting.h"
53 struct lttng_ht
*ust_app_ht
;
54 struct lttng_ht
*ust_app_ht_by_sock
;
55 struct lttng_ht
*ust_app_ht_by_notify_sock
;
58 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
60 /* Next available channel key. Access under next_channel_key_lock. */
61 static uint64_t _next_channel_key
;
62 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
64 /* Next available session ID. Access under next_session_id_lock. */
65 static uint64_t _next_session_id
;
66 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
69 * Return the incremented value of next_channel_key.
71 static uint64_t get_next_channel_key(void)
75 pthread_mutex_lock(&next_channel_key_lock
);
76 ret
= ++_next_channel_key
;
77 pthread_mutex_unlock(&next_channel_key_lock
);
82 * Return the atomically incremented value of next_session_id.
84 static uint64_t get_next_session_id(void)
88 pthread_mutex_lock(&next_session_id_lock
);
89 ret
= ++_next_session_id
;
90 pthread_mutex_unlock(&next_session_id_lock
);
94 static void copy_channel_attr_to_ustctl(
95 struct ustctl_consumer_channel_attr
*attr
,
96 struct lttng_ust_channel_attr
*uattr
)
98 /* Copy event attributes since the layout is different. */
99 attr
->subbuf_size
= uattr
->subbuf_size
;
100 attr
->num_subbuf
= uattr
->num_subbuf
;
101 attr
->overwrite
= uattr
->overwrite
;
102 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
103 attr
->read_timer_interval
= uattr
->read_timer_interval
;
104 attr
->output
= uattr
->output
;
105 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
109 * Match function for the hash table lookup.
111 * It matches an ust app event based on three attributes which are the event
112 * name, the filter bytecode and the loglevel.
114 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
116 struct ust_app_event
*event
;
117 const struct ust_app_ht_key
*key
;
118 int ev_loglevel_value
;
123 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
125 ev_loglevel_value
= event
->attr
.loglevel
;
127 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
130 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
134 /* Event loglevel. */
135 if (ev_loglevel_value
!= key
->loglevel_type
) {
136 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
137 && key
->loglevel_type
== 0 &&
138 ev_loglevel_value
== -1) {
140 * Match is accepted. This is because on event creation, the
141 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
142 * -1 are accepted for this loglevel type since 0 is the one set by
143 * the API when receiving an enable event.
150 /* One of the filters is NULL, fail. */
151 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
155 if (key
->filter
&& event
->filter
) {
156 /* Both filters exists, check length followed by the bytecode. */
157 if (event
->filter
->len
!= key
->filter
->len
||
158 memcmp(event
->filter
->data
, key
->filter
->data
,
159 event
->filter
->len
) != 0) {
164 /* One of the exclusions is NULL, fail. */
165 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
169 if (key
->exclusion
&& event
->exclusion
) {
170 /* Both exclusions exists, check count followed by the names. */
171 if (event
->exclusion
->count
!= key
->exclusion
->count
||
172 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
173 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
187 * Unique add of an ust app event in the given ht. This uses the custom
188 * ht_match_ust_app_event match function and the event name as hash.
190 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
191 struct ust_app_event
*event
)
193 struct cds_lfht_node
*node_ptr
;
194 struct ust_app_ht_key key
;
198 assert(ua_chan
->events
);
201 ht
= ua_chan
->events
;
202 key
.name
= event
->attr
.name
;
203 key
.filter
= event
->filter
;
204 key
.loglevel_type
= event
->attr
.loglevel
;
205 key
.exclusion
= event
->exclusion
;
207 node_ptr
= cds_lfht_add_unique(ht
->ht
,
208 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
209 ht_match_ust_app_event
, &key
, &event
->node
.node
);
210 assert(node_ptr
== &event
->node
.node
);
214 * Close the notify socket from the given RCU head object. This MUST be called
215 * through a call_rcu().
217 static void close_notify_sock_rcu(struct rcu_head
*head
)
220 struct ust_app_notify_sock_obj
*obj
=
221 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
223 /* Must have a valid fd here. */
224 assert(obj
->fd
>= 0);
226 ret
= close(obj
->fd
);
228 ERR("close notify sock %d RCU", obj
->fd
);
230 lttng_fd_put(LTTNG_FD_APPS
, 1);
236 * Return the session registry according to the buffer type of the given
239 * A registry per UID object MUST exists before calling this function or else
240 * it assert() if not found. RCU read side lock must be acquired.
242 static struct ust_registry_session
*get_session_registry(
243 struct ust_app_session
*ua_sess
)
245 struct ust_registry_session
*registry
= NULL
;
249 switch (ua_sess
->buffer_type
) {
250 case LTTNG_BUFFER_PER_PID
:
252 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
256 registry
= reg_pid
->registry
->reg
.ust
;
259 case LTTNG_BUFFER_PER_UID
:
261 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
262 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
263 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
267 registry
= reg_uid
->registry
->reg
.ust
;
279 * Delete ust context safely. RCU read lock must be held before calling
283 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
291 pthread_mutex_lock(&app
->sock_lock
);
292 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
293 pthread_mutex_unlock(&app
->sock_lock
);
294 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
295 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
296 sock
, ua_ctx
->obj
->handle
, ret
);
304 * Delete ust app event safely. RCU read lock must be held before calling
308 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
315 free(ua_event
->filter
);
316 if (ua_event
->exclusion
!= NULL
)
317 free(ua_event
->exclusion
);
318 if (ua_event
->obj
!= NULL
) {
319 pthread_mutex_lock(&app
->sock_lock
);
320 ret
= ustctl_release_object(sock
, ua_event
->obj
);
321 pthread_mutex_unlock(&app
->sock_lock
);
322 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
323 ERR("UST app sock %d release event obj failed with ret %d",
332 * Delete ust app token event_rule safely. RCU read lock must be held before calling
333 * this function. TODO: or does it????
336 void delete_ust_app_token_event_rule(int sock
, struct ust_app_token_event_rule
*ua_token
,
343 if (ua_token
->exclusion
!= NULL
)
344 free(ua_token
->exclusion
);
345 if (ua_token
->obj
!= NULL
) {
346 pthread_mutex_lock(&app
->sock_lock
);
347 ret
= ustctl_release_object(sock
, ua_token
->obj
);
348 pthread_mutex_unlock(&app
->sock_lock
);
349 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
350 ERR("UST app sock %d release event obj failed with ret %d",
355 lttng_trigger_put(ua_token
->trigger
);
360 * Release ust data object of the given stream.
362 * Return 0 on success or else a negative value.
364 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
372 pthread_mutex_lock(&app
->sock_lock
);
373 ret
= ustctl_release_object(sock
, stream
->obj
);
374 pthread_mutex_unlock(&app
->sock_lock
);
375 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
376 ERR("UST app sock %d release stream obj failed with ret %d",
379 lttng_fd_put(LTTNG_FD_APPS
, 2);
387 * Delete ust app stream safely. RCU read lock must be held before calling
391 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
396 (void) release_ust_app_stream(sock
, stream
, app
);
401 * We need to execute ht_destroy outside of RCU read-side critical
402 * section and outside of call_rcu thread, so we postpone its execution
403 * using ht_cleanup_push. It is simpler than to change the semantic of
404 * the many callers of delete_ust_app_session().
407 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
409 struct ust_app_channel
*ua_chan
=
410 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
412 ht_cleanup_push(ua_chan
->ctx
);
413 ht_cleanup_push(ua_chan
->events
);
418 * Extract the lost packet or discarded events counter when the channel is
419 * being deleted and store the value in the parent channel so we can
420 * access it from lttng list and at stop/destroy.
422 * The session list lock must be held by the caller.
425 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
427 uint64_t discarded
= 0, lost
= 0;
428 struct ltt_session
*session
;
429 struct ltt_ust_channel
*uchan
;
431 if (ua_chan
->attr
.type
!= LTTNG_UST_CHAN_PER_CPU
) {
436 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
437 if (!session
|| !session
->ust_session
) {
439 * Not finding the session is not an error because there are
440 * multiple ways the channels can be torn down.
442 * 1) The session daemon can initiate the destruction of the
443 * ust app session after receiving a destroy command or
444 * during its shutdown/teardown.
445 * 2) The application, since we are in per-pid tracing, is
446 * unregistering and tearing down its ust app session.
448 * Both paths are protected by the session list lock which
449 * ensures that the accounting of lost packets and discarded
450 * events is done exactly once. The session is then unpublished
451 * from the session list, resulting in this condition.
456 if (ua_chan
->attr
.overwrite
) {
457 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
458 ua_chan
->key
, session
->ust_session
->consumer
,
461 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
462 ua_chan
->key
, session
->ust_session
->consumer
,
465 uchan
= trace_ust_find_channel_by_name(
466 session
->ust_session
->domain_global
.channels
,
469 ERR("Missing UST channel to store discarded counters");
473 uchan
->per_pid_closed_app_discarded
+= discarded
;
474 uchan
->per_pid_closed_app_lost
+= lost
;
479 session_put(session
);
484 * Delete ust app channel safely. RCU read lock must be held before calling
487 * The session list lock must be held by the caller.
490 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
494 struct lttng_ht_iter iter
;
495 struct ust_app_event
*ua_event
;
496 struct ust_app_ctx
*ua_ctx
;
497 struct ust_app_stream
*stream
, *stmp
;
498 struct ust_registry_session
*registry
;
502 DBG3("UST app deleting channel %s", ua_chan
->name
);
505 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
506 cds_list_del(&stream
->list
);
507 delete_ust_app_stream(sock
, stream
, app
);
511 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
512 cds_list_del(&ua_ctx
->list
);
513 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
515 delete_ust_app_ctx(sock
, ua_ctx
, app
);
519 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
521 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
523 delete_ust_app_event(sock
, ua_event
, app
);
526 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
527 /* Wipe and free registry from session registry. */
528 registry
= get_session_registry(ua_chan
->session
);
530 ust_registry_channel_del_free(registry
, ua_chan
->key
,
534 * A negative socket can be used by the caller when
535 * cleaning-up a ua_chan in an error path. Skip the
536 * accounting in this case.
539 save_per_pid_lost_discarded_counters(ua_chan
);
543 if (ua_chan
->obj
!= NULL
) {
544 /* Remove channel from application UST object descriptor. */
545 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
546 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
548 pthread_mutex_lock(&app
->sock_lock
);
549 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
550 pthread_mutex_unlock(&app
->sock_lock
);
551 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
552 ERR("UST app sock %d release channel obj failed with ret %d",
555 lttng_fd_put(LTTNG_FD_APPS
, 1);
558 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
561 int ust_app_register_done(struct ust_app
*app
)
565 pthread_mutex_lock(&app
->sock_lock
);
566 ret
= ustctl_register_done(app
->sock
);
567 pthread_mutex_unlock(&app
->sock_lock
);
571 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
576 pthread_mutex_lock(&app
->sock_lock
);
581 ret
= ustctl_release_object(sock
, data
);
583 pthread_mutex_unlock(&app
->sock_lock
);
589 * Push metadata to consumer socket.
591 * RCU read-side lock must be held to guarantee existance of socket.
592 * Must be called with the ust app session lock held.
593 * Must be called with the registry lock held.
595 * On success, return the len of metadata pushed or else a negative value.
596 * Returning a -EPIPE return value means we could not send the metadata,
597 * but it can be caused by recoverable errors (e.g. the application has
598 * terminated concurrently).
600 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
601 struct consumer_socket
*socket
, int send_zero_data
)
604 char *metadata_str
= NULL
;
605 size_t len
, offset
, new_metadata_len_sent
;
607 uint64_t metadata_key
, metadata_version
;
612 metadata_key
= registry
->metadata_key
;
615 * Means that no metadata was assigned to the session. This can
616 * happens if no start has been done previously.
622 offset
= registry
->metadata_len_sent
;
623 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
624 new_metadata_len_sent
= registry
->metadata_len
;
625 metadata_version
= registry
->metadata_version
;
627 DBG3("No metadata to push for metadata key %" PRIu64
,
628 registry
->metadata_key
);
630 if (send_zero_data
) {
631 DBG("No metadata to push");
637 /* Allocate only what we have to send. */
638 metadata_str
= zmalloc(len
);
640 PERROR("zmalloc ust app metadata string");
644 /* Copy what we haven't sent out. */
645 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
648 pthread_mutex_unlock(®istry
->lock
);
650 * We need to unlock the registry while we push metadata to
651 * break a circular dependency between the consumerd metadata
652 * lock and the sessiond registry lock. Indeed, pushing metadata
653 * to the consumerd awaits that it gets pushed all the way to
654 * relayd, but doing so requires grabbing the metadata lock. If
655 * a concurrent metadata request is being performed by
656 * consumerd, this can try to grab the registry lock on the
657 * sessiond while holding the metadata lock on the consumer
658 * daemon. Those push and pull schemes are performed on two
659 * different bidirectionnal communication sockets.
661 ret
= consumer_push_metadata(socket
, metadata_key
,
662 metadata_str
, len
, offset
, metadata_version
);
663 pthread_mutex_lock(®istry
->lock
);
666 * There is an acceptable race here between the registry
667 * metadata key assignment and the creation on the
668 * consumer. The session daemon can concurrently push
669 * metadata for this registry while being created on the
670 * consumer since the metadata key of the registry is
671 * assigned *before* it is setup to avoid the consumer
672 * to ask for metadata that could possibly be not found
673 * in the session daemon.
675 * The metadata will get pushed either by the session
676 * being stopped or the consumer requesting metadata if
677 * that race is triggered.
679 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
682 ERR("Error pushing metadata to consumer");
688 * Metadata may have been concurrently pushed, since
689 * we're not holding the registry lock while pushing to
690 * consumer. This is handled by the fact that we send
691 * the metadata content, size, and the offset at which
692 * that metadata belongs. This may arrive out of order
693 * on the consumer side, and the consumer is able to
694 * deal with overlapping fragments. The consumer
695 * supports overlapping fragments, which must be
696 * contiguous starting from offset 0. We keep the
697 * largest metadata_len_sent value of the concurrent
700 registry
->metadata_len_sent
=
701 max_t(size_t, registry
->metadata_len_sent
,
702 new_metadata_len_sent
);
711 * On error, flag the registry that the metadata is
712 * closed. We were unable to push anything and this
713 * means that either the consumer is not responding or
714 * the metadata cache has been destroyed on the
717 registry
->metadata_closed
= 1;
725 * For a given application and session, push metadata to consumer.
726 * Either sock or consumer is required : if sock is NULL, the default
727 * socket to send the metadata is retrieved from consumer, if sock
728 * is not NULL we use it to send the metadata.
729 * RCU read-side lock must be held while calling this function,
730 * therefore ensuring existance of registry. It also ensures existance
731 * of socket throughout this function.
733 * Return 0 on success else a negative error.
734 * Returning a -EPIPE return value means we could not send the metadata,
735 * but it can be caused by recoverable errors (e.g. the application has
736 * terminated concurrently).
738 static int push_metadata(struct ust_registry_session
*registry
,
739 struct consumer_output
*consumer
)
743 struct consumer_socket
*socket
;
748 pthread_mutex_lock(®istry
->lock
);
749 if (registry
->metadata_closed
) {
754 /* Get consumer socket to use to push the metadata.*/
755 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
762 ret
= ust_app_push_metadata(registry
, socket
, 0);
767 pthread_mutex_unlock(®istry
->lock
);
771 pthread_mutex_unlock(®istry
->lock
);
776 * Send to the consumer a close metadata command for the given session. Once
777 * done, the metadata channel is deleted and the session metadata pointer is
778 * nullified. The session lock MUST be held unless the application is
779 * in the destroy path.
781 * Do not hold the registry lock while communicating with the consumerd, because
782 * doing so causes inter-process deadlocks between consumerd and sessiond with
783 * the metadata request notification.
785 * Return 0 on success else a negative value.
787 static int close_metadata(struct ust_registry_session
*registry
,
788 struct consumer_output
*consumer
)
791 struct consumer_socket
*socket
;
792 uint64_t metadata_key
;
793 bool registry_was_already_closed
;
800 pthread_mutex_lock(®istry
->lock
);
801 metadata_key
= registry
->metadata_key
;
802 registry_was_already_closed
= registry
->metadata_closed
;
803 if (metadata_key
!= 0) {
805 * Metadata closed. Even on error this means that the consumer
806 * is not responding or not found so either way a second close
807 * should NOT be emit for this registry.
809 registry
->metadata_closed
= 1;
811 pthread_mutex_unlock(®istry
->lock
);
813 if (metadata_key
== 0 || registry_was_already_closed
) {
818 /* Get consumer socket to use to push the metadata.*/
819 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
826 ret
= consumer_close_metadata(socket
, metadata_key
);
837 * We need to execute ht_destroy outside of RCU read-side critical
838 * section and outside of call_rcu thread, so we postpone its execution
839 * using ht_cleanup_push. It is simpler than to change the semantic of
840 * the many callers of delete_ust_app_session().
843 void delete_ust_app_session_rcu(struct rcu_head
*head
)
845 struct ust_app_session
*ua_sess
=
846 caa_container_of(head
, struct ust_app_session
, rcu_head
);
848 ht_cleanup_push(ua_sess
->channels
);
853 * Delete ust app session safely. RCU read lock must be held before calling
856 * The session list lock must be held by the caller.
859 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
863 struct lttng_ht_iter iter
;
864 struct ust_app_channel
*ua_chan
;
865 struct ust_registry_session
*registry
;
869 pthread_mutex_lock(&ua_sess
->lock
);
871 assert(!ua_sess
->deleted
);
872 ua_sess
->deleted
= true;
874 registry
= get_session_registry(ua_sess
);
875 /* Registry can be null on error path during initialization. */
877 /* Push metadata for application before freeing the application. */
878 (void) push_metadata(registry
, ua_sess
->consumer
);
881 * Don't ask to close metadata for global per UID buffers. Close
882 * metadata only on destroy trace session in this case. Also, the
883 * previous push metadata could have flag the metadata registry to
884 * close so don't send a close command if closed.
886 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
887 /* And ask to close it for this session registry. */
888 (void) close_metadata(registry
, ua_sess
->consumer
);
892 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
894 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
896 delete_ust_app_channel(sock
, ua_chan
, app
);
899 /* In case of per PID, the registry is kept in the session. */
900 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
901 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
904 * Registry can be null on error path during
907 buffer_reg_pid_remove(reg_pid
);
908 buffer_reg_pid_destroy(reg_pid
);
912 if (ua_sess
->handle
!= -1) {
913 pthread_mutex_lock(&app
->sock_lock
);
914 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
915 pthread_mutex_unlock(&app
->sock_lock
);
916 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
917 ERR("UST app sock %d release session handle failed with ret %d",
920 /* Remove session from application UST object descriptor. */
921 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
922 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
926 pthread_mutex_unlock(&ua_sess
->lock
);
928 consumer_output_put(ua_sess
->consumer
);
930 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
934 * Delete a traceable application structure from the global list. Never call
935 * this function outside of a call_rcu call.
937 * RCU read side lock should _NOT_ be held when calling this function.
940 void delete_ust_app(struct ust_app
*app
)
943 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
944 struct lttng_ht_iter iter
;
945 struct ust_app_token_event_rule
*token
;
948 * The session list lock must be held during this function to guarantee
949 * the existence of ua_sess.
952 /* Delete ust app sessions info */
957 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
959 /* Free every object in the session and the session. */
961 delete_ust_app_session(sock
, ua_sess
, app
);
965 /* Wipe token associated with the app */
966 cds_lfht_for_each_entry(app
->tokens_ht
->ht
, &iter
.iter
, token
,
968 ret
= lttng_ht_del(app
->tokens_ht
, &iter
);
970 delete_ust_app_token_event_rule(app
->sock
, token
, app
);
973 ht_cleanup_push(app
->sessions
);
974 ht_cleanup_push(app
->ust_sessions_objd
);
975 ht_cleanup_push(app
->ust_objd
);
976 ht_cleanup_push(app
->tokens_ht
);
978 /* This can happen if trigger setup failed. e.g killed app */
979 if (app
->token_communication
.handle
) {
980 ustctl_release_object(sock
, app
->token_communication
.handle
);
981 free(app
->token_communication
.handle
);
984 lttng_pipe_destroy(app
->token_communication
.trigger_event_pipe
);
987 * Wait until we have deleted the application from the sock hash table
988 * before closing this socket, otherwise an application could re-use the
989 * socket ID and race with the teardown, using the same hash table entry.
991 * It's OK to leave the close in call_rcu. We want it to stay unique for
992 * all RCU readers that could run concurrently with unregister app,
993 * therefore we _need_ to only close that socket after a grace period. So
994 * it should stay in this RCU callback.
996 * This close() is a very important step of the synchronization model so
997 * every modification to this function must be carefully reviewed.
1003 lttng_fd_put(LTTNG_FD_APPS
, 1);
1005 DBG2("UST app pid %d deleted", app
->pid
);
1007 session_unlock_list();
1011 * URCU intermediate call to delete an UST app.
1014 void delete_ust_app_rcu(struct rcu_head
*head
)
1016 struct lttng_ht_node_ulong
*node
=
1017 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1018 struct ust_app
*app
=
1019 caa_container_of(node
, struct ust_app
, pid_n
);
1021 DBG3("Call RCU deleting app PID %d", app
->pid
);
1022 delete_ust_app(app
);
1026 * Delete the session from the application ht and delete the data structure by
1027 * freeing every object inside and releasing them.
1029 * The session list lock must be held by the caller.
1031 static void destroy_app_session(struct ust_app
*app
,
1032 struct ust_app_session
*ua_sess
)
1035 struct lttng_ht_iter iter
;
1040 iter
.iter
.node
= &ua_sess
->node
.node
;
1041 ret
= lttng_ht_del(app
->sessions
, &iter
);
1043 /* Already scheduled for teardown. */
1047 /* Once deleted, free the data structure. */
1048 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1055 * Alloc new UST app session.
1058 struct ust_app_session
*alloc_ust_app_session(void)
1060 struct ust_app_session
*ua_sess
;
1062 /* Init most of the default value by allocating and zeroing */
1063 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1064 if (ua_sess
== NULL
) {
1069 ua_sess
->handle
= -1;
1070 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1071 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
1072 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1081 * Alloc new UST app channel.
1084 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1085 struct ust_app_session
*ua_sess
,
1086 struct lttng_ust_channel_attr
*attr
)
1088 struct ust_app_channel
*ua_chan
;
1090 /* Init most of the default value by allocating and zeroing */
1091 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1092 if (ua_chan
== NULL
) {
1097 /* Setup channel name */
1098 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1099 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1101 ua_chan
->enabled
= 1;
1102 ua_chan
->handle
= -1;
1103 ua_chan
->session
= ua_sess
;
1104 ua_chan
->key
= get_next_channel_key();
1105 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1106 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1107 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1109 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1110 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1112 /* Copy attributes */
1114 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
1115 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1116 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1117 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1118 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1119 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1120 ua_chan
->attr
.output
= attr
->output
;
1121 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1123 /* By default, the channel is a per cpu channel. */
1124 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1126 DBG3("UST app channel %s allocated", ua_chan
->name
);
1135 * Allocate and initialize a UST app stream.
1137 * Return newly allocated stream pointer or NULL on error.
1139 struct ust_app_stream
*ust_app_alloc_stream(void)
1141 struct ust_app_stream
*stream
= NULL
;
1143 stream
= zmalloc(sizeof(*stream
));
1144 if (stream
== NULL
) {
1145 PERROR("zmalloc ust app stream");
1149 /* Zero could be a valid value for a handle so flag it to -1. */
1150 stream
->handle
= -1;
1157 * Alloc new UST app event.
1160 struct ust_app_event
*alloc_ust_app_event(char *name
,
1161 struct lttng_ust_event
*attr
)
1163 struct ust_app_event
*ua_event
;
1165 /* Init most of the default value by allocating and zeroing */
1166 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1167 if (ua_event
== NULL
) {
1168 PERROR("Failed to allocate ust_app_event structure");
1172 ua_event
->enabled
= 1;
1173 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1174 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1175 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1177 /* Copy attributes */
1179 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1182 DBG3("UST app event %s allocated", ua_event
->name
);
1191 * Alloc new UST app token event rule.
1193 static struct ust_app_token_event_rule
*alloc_ust_app_token_event_rule(
1194 struct lttng_trigger
*trigger
)
1196 struct ust_app_token_event_rule
*ua_token
;
1197 struct lttng_condition
*condition
= NULL
;
1198 struct lttng_event_rule
*event_rule
= NULL
;
1200 ua_token
= zmalloc(sizeof(struct ust_app_token_event_rule
));
1201 if (ua_token
== NULL
) {
1202 PERROR("Failed to allocate ust_app_token_event_rule structure");
1206 /* Get reference of the trigger */
1207 /* TODO should this be like lttng_event_rule_get with a returned bool? */
1208 lttng_trigger_get(trigger
);
1210 ua_token
->enabled
= 1;
1211 ua_token
->token
= lttng_trigger_get_tracer_token(trigger
);
1212 lttng_ht_node_init_u64(&ua_token
->node
, ua_token
->token
);
1214 condition
= lttng_trigger_get_condition(trigger
);
1216 assert(lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
1218 assert(LTTNG_CONDITION_STATUS_OK
== lttng_condition_event_rule_get_rule_mutable(condition
, &event_rule
));
1221 ua_token
->trigger
= trigger
;
1222 ua_token
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1223 ua_token
->exclusion
= lttng_event_rule_generate_exclusions(event_rule
);
1224 ua_token
->error_counter_index
= lttng_trigger_get_error_counter_index(trigger
);
1226 /* TODO put capture here? or later*/
1228 DBG3("UST app token event rule %" PRIu64
" allocated", ua_token
->token
);
1237 * Alloc new UST app context.
1240 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1242 struct ust_app_ctx
*ua_ctx
;
1244 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1245 if (ua_ctx
== NULL
) {
1249 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1252 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1253 if (uctx
->ctx
== LTTNG_UST_CONTEXT_APP_CONTEXT
) {
1254 char *provider_name
= NULL
, *ctx_name
= NULL
;
1256 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1257 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1258 if (!provider_name
|| !ctx_name
) {
1259 free(provider_name
);
1264 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1265 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1269 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1277 * Create a liblttng-ust filter bytecode from given bytecode.
1279 * Return allocated filter or NULL on error.
1281 static struct lttng_ust_filter_bytecode
*
1282 create_ust_filter_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1284 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1286 /* Copy filter bytecode */
1287 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1289 PERROR("zmalloc alloc ust filter bytecode");
1293 assert(sizeof(struct lttng_bytecode
) ==
1294 sizeof(struct lttng_ust_filter_bytecode
));
1295 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1301 * Create a liblttng-ust capture bytecode from given bytecode.
1303 * Return allocated filter or NULL on error.
1305 static struct lttng_ust_capture_bytecode
*
1306 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1308 struct lttng_ust_capture_bytecode
*capture
= NULL
;
1310 /* Copy capture bytecode */
1311 capture
= zmalloc(sizeof(*capture
) + orig_f
->len
);
1313 PERROR("zmalloc alloc ust capture bytecode");
1317 assert(sizeof(struct lttng_bytecode
) ==
1318 sizeof(struct lttng_ust_capture_bytecode
));
1319 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1325 * Find an ust_app using the sock and return it. RCU read side lock must be
1326 * held before calling this helper function.
1328 struct ust_app
*ust_app_find_by_sock(int sock
)
1330 struct lttng_ht_node_ulong
*node
;
1331 struct lttng_ht_iter iter
;
1333 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1334 node
= lttng_ht_iter_get_node_ulong(&iter
);
1336 DBG2("UST app find by sock %d not found", sock
);
1340 return caa_container_of(node
, struct ust_app
, sock_n
);
1347 * Find an ust_app using the notify sock and return it. RCU read side lock must
1348 * be held before calling this helper function.
1350 static struct ust_app
*find_app_by_notify_sock(int sock
)
1352 struct lttng_ht_node_ulong
*node
;
1353 struct lttng_ht_iter iter
;
1355 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1357 node
= lttng_ht_iter_get_node_ulong(&iter
);
1359 DBG2("UST app find by notify sock %d not found", sock
);
1363 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1370 * Lookup for an ust app event based on event name, filter bytecode and the
1373 * Return an ust_app_event object or NULL on error.
1375 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1376 const char *name
, const struct lttng_bytecode
*filter
,
1378 const struct lttng_event_exclusion
*exclusion
)
1380 struct lttng_ht_iter iter
;
1381 struct lttng_ht_node_str
*node
;
1382 struct ust_app_event
*event
= NULL
;
1383 struct ust_app_ht_key key
;
1388 /* Setup key for event lookup. */
1390 key
.filter
= filter
;
1391 key
.loglevel_type
= loglevel_value
;
1392 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1393 key
.exclusion
= exclusion
;
1395 /* Lookup using the event name as hash and a custom match fct. */
1396 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1397 ht_match_ust_app_event
, &key
, &iter
.iter
);
1398 node
= lttng_ht_iter_get_node_str(&iter
);
1403 event
= caa_container_of(node
, struct ust_app_event
, node
);
1410 * Lookup for an ust app tokens based on a token id.
1412 * Return an ust_app_token_event_rule object or NULL on error.
1414 static struct ust_app_token_event_rule
*find_ust_app_token_event_rule(struct lttng_ht
*ht
,
1417 struct lttng_ht_iter iter
;
1418 struct lttng_ht_node_u64
*node
;
1419 struct ust_app_token_event_rule
*token_event_rule
= NULL
;
1423 lttng_ht_lookup(ht
, &token
, &iter
);
1424 node
= lttng_ht_iter_get_node_u64(&iter
);
1426 DBG2("UST app token %" PRIu64
" not found", token
);
1430 token_event_rule
= caa_container_of(node
, struct ust_app_token_event_rule
, node
);
1432 return token_event_rule
;
1436 * Create the channel context on the tracer.
1438 * Called with UST app session lock held.
1441 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1442 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1446 health_code_update();
1448 pthread_mutex_lock(&app
->sock_lock
);
1449 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1450 ua_chan
->obj
, &ua_ctx
->obj
);
1451 pthread_mutex_unlock(&app
->sock_lock
);
1453 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1454 ERR("UST app create channel context failed for app (pid: %d) "
1455 "with ret %d", app
->pid
, ret
);
1458 * This is normal behavior, an application can die during the
1459 * creation process. Don't report an error so the execution can
1460 * continue normally.
1463 DBG3("UST app add context failed. Application is dead.");
1468 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1470 DBG2("UST app context handle %d created successfully for channel %s",
1471 ua_ctx
->handle
, ua_chan
->name
);
1474 health_code_update();
1479 * Set the filter on the tracer.
1481 static int set_ust_filter(struct ust_app
*app
,
1482 const struct lttng_bytecode
*bytecode
,
1483 struct lttng_ust_object_data
*ust_object
)
1486 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1488 health_code_update();
1490 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1491 if (!ust_bytecode
) {
1492 ret
= -LTTNG_ERR_NOMEM
;
1495 pthread_mutex_lock(&app
->sock_lock
);
1496 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1498 pthread_mutex_unlock(&app
->sock_lock
);
1500 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1501 ERR("UST app set filter failed for object %p of app (pid: %d) "
1502 "with ret %d", ust_object
, app
->pid
, ret
);
1505 * This is normal behavior, an application can die during the
1506 * creation process. Don't report an error so the execution can
1507 * continue normally.
1510 DBG3("UST app set filter. Application is dead.");
1515 DBG2("UST filter set for object %p successfully", ust_object
);
1518 health_code_update();
1524 * Set a capture bytecode for the passed object.
1525 * The seqnum enforce the ordering at runtime and on reception.
1527 static int set_ust_capture(struct ust_app
*app
,
1528 const struct lttng_bytecode
*bytecode
,
1529 unsigned int seqnum
,
1530 struct lttng_ust_object_data
*ust_object
)
1533 struct lttng_ust_capture_bytecode
*ust_bytecode
= NULL
;
1535 health_code_update();
1537 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1538 if (!ust_bytecode
) {
1539 ret
= -LTTNG_ERR_NOMEM
;
1543 /* Set the seqnum */
1544 ust_bytecode
->seqnum
= seqnum
;
1546 pthread_mutex_lock(&app
->sock_lock
);
1547 ret
= ustctl_set_capture(app
->sock
, ust_bytecode
,
1549 pthread_mutex_unlock(&app
->sock_lock
);
1551 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1552 ERR("UST app set capture failed for object %p of app (pid: %d) "
1553 "with ret %d", ust_object
, app
->pid
, ret
);
1556 * This is normal behavior, an application can die during the
1557 * creation process. Don't report an error so the execution can
1558 * continue normally.
1561 DBG3("UST app set capture. Application is dead.");
1566 DBG2("UST capture set for object %p successfully", ust_object
);
1569 health_code_update();
1575 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1576 struct lttng_event_exclusion
*exclusion
)
1578 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1579 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1580 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1582 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1583 if (!ust_exclusion
) {
1588 assert(sizeof(struct lttng_event_exclusion
) ==
1589 sizeof(struct lttng_ust_event_exclusion
));
1590 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1592 return ust_exclusion
;
1596 * Set event exclusions on the tracer.
1598 static int set_ust_exclusions(struct ust_app
*app
,
1599 struct lttng_event_exclusion
*exclusions
,
1600 struct lttng_ust_object_data
*ust_object
)
1603 struct lttng_ust_event_exclusion
*ust_exclusions
= NULL
;
1605 assert(exclusions
&& exclusions
->count
> 0);
1607 health_code_update();
1609 ust_exclusions
= create_ust_exclusion_from_exclusion(
1611 if (!ust_exclusions
) {
1612 ret
= -LTTNG_ERR_NOMEM
;
1615 pthread_mutex_lock(&app
->sock_lock
);
1616 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1617 pthread_mutex_unlock(&app
->sock_lock
);
1619 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1620 ERR("UST app exclusions failed for object %p of app (pid: %d) "
1621 "with ret %d", ust_object
, app
->pid
, ret
);
1624 * This is normal behavior, an application can die during the
1625 * creation process. Don't report an error so the execution can
1626 * continue normally.
1629 DBG3("UST app set exclusions failed. Application is dead.");
1634 DBG2("UST exclusions set successfully for object %p", ust_object
);
1637 health_code_update();
1638 free(ust_exclusions
);
1643 * Disable the specified event on to UST tracer for the UST session.
1645 static int disable_ust_object(struct ust_app
*app
,
1646 struct lttng_ust_object_data
*object
)
1650 health_code_update();
1652 pthread_mutex_lock(&app
->sock_lock
);
1653 ret
= ustctl_disable(app
->sock
, object
);
1654 pthread_mutex_unlock(&app
->sock_lock
);
1656 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1657 ERR("UST app disable failed for object %p app (pid: %d) with ret %d",
1658 object
, app
->pid
, ret
);
1661 * This is normal behavior, an application can die during the
1662 * creation process. Don't report an error so the execution can
1663 * continue normally.
1666 DBG3("UST app disable event failed. Application is dead.");
1671 DBG2("UST app object %p disabled successfully for app (pid: %d)",
1675 health_code_update();
1680 * Disable the specified channel on to UST tracer for the UST session.
1682 static int disable_ust_channel(struct ust_app
*app
,
1683 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1687 health_code_update();
1689 pthread_mutex_lock(&app
->sock_lock
);
1690 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1691 pthread_mutex_unlock(&app
->sock_lock
);
1693 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1694 ERR("UST app channel %s disable failed for app (pid: %d) "
1695 "and session handle %d with ret %d",
1696 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1699 * This is normal behavior, an application can die during the
1700 * creation process. Don't report an error so the execution can
1701 * continue normally.
1704 DBG3("UST app disable channel failed. Application is dead.");
1709 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1710 ua_chan
->name
, app
->pid
);
1713 health_code_update();
1718 * Enable the specified channel on to UST tracer for the UST session.
1720 static int enable_ust_channel(struct ust_app
*app
,
1721 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1725 health_code_update();
1727 pthread_mutex_lock(&app
->sock_lock
);
1728 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1729 pthread_mutex_unlock(&app
->sock_lock
);
1731 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1732 ERR("UST app channel %s enable failed for app (pid: %d) "
1733 "and session handle %d with ret %d",
1734 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1737 * This is normal behavior, an application can die during the
1738 * creation process. Don't report an error so the execution can
1739 * continue normally.
1742 DBG3("UST app enable channel failed. Application is dead.");
1747 ua_chan
->enabled
= 1;
1749 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1750 ua_chan
->name
, app
->pid
);
1753 health_code_update();
1758 * Enable the specified event on to UST tracer for the UST session.
1760 static int enable_ust_object(struct ust_app
*app
, struct lttng_ust_object_data
*ust_object
)
1764 health_code_update();
1766 pthread_mutex_lock(&app
->sock_lock
);
1767 ret
= ustctl_enable(app
->sock
, ust_object
);
1768 pthread_mutex_unlock(&app
->sock_lock
);
1770 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1771 ERR("UST app enable failed for object %p app (pid: %d) with ret %d",
1772 ust_object
, app
->pid
, ret
);
1775 * This is normal behavior, an application can die during the
1776 * creation process. Don't report an error so the execution can
1777 * continue normally.
1780 DBG3("UST app enable failed. Application is dead.");
1785 DBG2("UST app object %p enabled successfully for app (pid: %d)",
1786 ust_object
, app
->pid
);
1789 health_code_update();
1794 * Send channel and stream buffer to application.
1796 * Return 0 on success. On error, a negative value is returned.
1798 static int send_channel_pid_to_ust(struct ust_app
*app
,
1799 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1802 struct ust_app_stream
*stream
, *stmp
;
1808 health_code_update();
1810 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1813 /* Send channel to the application. */
1814 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1815 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1816 ret
= -ENOTCONN
; /* Caused by app exiting. */
1818 } else if (ret
< 0) {
1822 health_code_update();
1824 /* Send all streams to application. */
1825 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1826 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1827 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1828 ret
= -ENOTCONN
; /* Caused by app exiting. */
1830 } else if (ret
< 0) {
1833 /* We don't need the stream anymore once sent to the tracer. */
1834 cds_list_del(&stream
->list
);
1835 delete_ust_app_stream(-1, stream
, app
);
1837 /* Flag the channel that it is sent to the application. */
1838 ua_chan
->is_sent
= 1;
1841 health_code_update();
1846 * Create the specified event onto the UST tracer for a UST session.
1848 * Should be called with session mutex held.
1851 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1852 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1856 health_code_update();
1858 /* Create UST event on tracer */
1859 pthread_mutex_lock(&app
->sock_lock
);
1860 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1862 pthread_mutex_unlock(&app
->sock_lock
);
1864 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1866 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1867 ua_event
->attr
.name
, app
->pid
, ret
);
1870 * This is normal behavior, an application can die during the
1871 * creation process. Don't report an error so the execution can
1872 * continue normally.
1875 DBG3("UST app create event failed. Application is dead.");
1880 ua_event
->handle
= ua_event
->obj
->handle
;
1882 DBG2("UST app event %s created successfully for pid:%d object: %p",
1883 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
1885 health_code_update();
1887 /* Set filter if one is present. */
1888 if (ua_event
->filter
) {
1889 ret
= set_ust_filter(app
, ua_event
->filter
, ua_event
->obj
);
1895 /* Set exclusions for the event */
1896 if (ua_event
->exclusion
) {
1897 ret
= set_ust_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
1903 /* If event not enabled, disable it on the tracer */
1904 if (ua_event
->enabled
) {
1906 * We now need to explicitly enable the event, since it
1907 * is now disabled at creation.
1909 ret
= enable_ust_object(app
, ua_event
->obj
);
1912 * If we hit an EPERM, something is wrong with our enable call. If
1913 * we get an EEXIST, there is a problem on the tracer side since we
1917 case -LTTNG_UST_ERR_PERM
:
1918 /* Code flow problem */
1920 case -LTTNG_UST_ERR_EXIST
:
1921 /* It's OK for our use case. */
1932 health_code_update();
1937 void init_ust_trigger_from_event_rule(const struct lttng_event_rule
*rule
, struct lttng_ust_trigger
*trigger
)
1939 enum lttng_event_rule_status status
;
1940 enum lttng_loglevel_type loglevel_type
;
1941 enum lttng_ust_loglevel_type ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1943 const char *pattern
;
1945 /* For now only LTTNG_EVENT_RULE_TYPE_TRACEPOINT are supported */
1946 assert(lttng_event_rule_get_type(rule
) == LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
1948 memset(trigger
, 0, sizeof(*trigger
));
1950 if (lttng_event_rule_is_agent(rule
)) {
1952 * Special event for agents
1953 * The actual meat of the event is in the filter that will be
1954 * attached later on.
1955 * Set the default values for the agent event.
1957 pattern
= event_get_default_agent_ust_name(lttng_event_rule_get_domain_type(rule
));
1959 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1961 status
= lttng_event_rule_tracepoint_get_pattern(rule
, &pattern
);
1962 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1963 /* At this point this is a fatal error */
1967 status
= lttng_event_rule_tracepoint_get_log_level_type(
1968 rule
, &loglevel_type
);
1969 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
1970 /* At this point this is a fatal error */
1974 switch (loglevel_type
) {
1975 case LTTNG_EVENT_LOGLEVEL_ALL
:
1976 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_ALL
;
1978 case LTTNG_EVENT_LOGLEVEL_RANGE
:
1979 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_RANGE
;
1981 case LTTNG_EVENT_LOGLEVEL_SINGLE
:
1982 ust_loglevel_type
= LTTNG_UST_LOGLEVEL_SINGLE
;
1986 if (loglevel_type
!= LTTNG_EVENT_LOGLEVEL_ALL
) {
1987 status
= lttng_event_rule_tracepoint_get_log_level(
1989 assert(status
== LTTNG_EVENT_RULE_STATUS_OK
);
1993 trigger
->instrumentation
= LTTNG_UST_TRACEPOINT
;
1994 strncpy(trigger
->name
, pattern
, LTTNG_UST_SYM_NAME_LEN
- 1);
1995 trigger
->loglevel_type
= ust_loglevel_type
;
1996 trigger
->loglevel
= loglevel
;
2000 * Create the specified event rule token onto the UST tracer for a UST app.
2003 int create_ust_token_event_rule(struct ust_app
*app
, struct ust_app_token_event_rule
*ua_token
)
2006 struct lttng_ust_trigger trigger
;
2007 struct lttng_condition
*condition
= NULL
;
2008 struct lttng_event_rule
*event_rule
= NULL
;
2009 unsigned int capture_bytecode_count
= 0;
2011 health_code_update();
2012 assert(app
->token_communication
.handle
);
2014 condition
= lttng_trigger_get_condition(ua_token
->trigger
);
2016 assert(lttng_condition_get_type(condition
) == LTTNG_CONDITION_TYPE_EVENT_RULE_HIT
);
2018 lttng_condition_event_rule_get_rule_mutable(condition
, &event_rule
);
2020 assert(lttng_event_rule_get_type(event_rule
) == LTTNG_EVENT_RULE_TYPE_TRACEPOINT
);
2021 /* Should we also test for UST at this point, or do we trust all the
2024 init_ust_trigger_from_event_rule(event_rule
, &trigger
);
2026 trigger
.id
= ua_token
->token
;
2027 trigger
.error_counter_index
= ua_token
->error_counter_index
;
2029 /* Create UST trigger on tracer */
2030 pthread_mutex_lock(&app
->sock_lock
);
2031 ret
= ustctl_create_trigger(app
->sock
, &trigger
, app
->token_communication
.handle
, &ua_token
->obj
);
2032 pthread_mutex_unlock(&app
->sock_lock
);
2034 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2036 ERR("Error ustctl create trigger %s for app pid: %d with ret %d",
2037 trigger
.name
, app
->pid
, ret
);
2040 * This is normal behavior, an application can die during the
2041 * creation process. Don't report an error so the execution can
2042 * continue normally.
2045 DBG3("UST app create event failed. Application is dead.");
2050 ua_token
->handle
= ua_token
->obj
->handle
;
2052 DBG2("UST app event %s created successfully for pid:%d object: %p",
2053 trigger
.name
, app
->pid
, ua_token
->obj
);
2055 health_code_update();
2057 /* Set filter if one is present. */
2058 if (ua_token
->filter
) {
2059 ret
= set_ust_filter(app
, ua_token
->filter
, ua_token
->obj
);
2065 /* Set exclusions for the event */
2066 if (ua_token
->exclusion
) {
2067 ret
= set_ust_exclusions(app
, ua_token
->exclusion
, ua_token
->obj
);
2073 /* Set the capture bytecode
2074 * TODO: do we want to emulate what is done with exclusion and provide
2075 * and object with a count of capture bytecode? instead of multiple
2078 capture_bytecode_count
= lttng_trigger_get_capture_bytecode_count(ua_token
->trigger
);
2079 for (unsigned int i
= 0; i
< capture_bytecode_count
; i
++) {
2080 const struct lttng_bytecode
*capture_bytecode
= lttng_trigger_get_capture_bytecode_at_index(ua_token
->trigger
, i
);
2081 ret
= set_ust_capture(app
, capture_bytecode
, i
, ua_token
->obj
);
2088 * We now need to explicitly enable the event, since it
2089 * is disabled at creation.
2091 ret
= enable_ust_object(app
, ua_token
->obj
);
2094 * If we hit an EPERM, something is wrong with our enable call. If
2095 * we get an EEXIST, there is a problem on the tracer side since we
2099 case -LTTNG_UST_ERR_PERM
:
2100 /* Code flow problem */
2102 case -LTTNG_UST_ERR_EXIST
:
2103 /* It's OK for our use case. */
2111 ua_token
->enabled
= true;
2114 health_code_update();
2119 * Copy data between an UST app event and a LTT event.
2121 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2122 struct ltt_ust_event
*uevent
)
2124 size_t exclusion_alloc_size
;
2126 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2127 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2129 ua_event
->enabled
= uevent
->enabled
;
2131 /* Copy event attributes */
2132 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2134 /* Copy filter bytecode */
2135 if (uevent
->filter
) {
2136 ua_event
->filter
= bytecode_copy(uevent
->filter
);
2137 /* Filter might be NULL here in case of ENONEM. */
2140 /* Copy exclusion data */
2141 if (uevent
->exclusion
) {
2142 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2143 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2144 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2145 if (ua_event
->exclusion
== NULL
) {
2148 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2149 exclusion_alloc_size
);
2155 * Copy data between an UST app channel and a LTT channel.
2157 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2158 struct ltt_ust_channel
*uchan
)
2160 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2162 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2163 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2165 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2166 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2168 /* Copy event attributes since the layout is different. */
2169 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2170 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2171 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2172 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2173 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2174 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2175 ua_chan
->attr
.output
= uchan
->attr
.output
;
2176 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2179 * Note that the attribute channel type is not set since the channel on the
2180 * tracing registry side does not have this information.
2183 ua_chan
->enabled
= uchan
->enabled
;
2184 ua_chan
->tracing_channel_id
= uchan
->id
;
2186 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2190 * Copy data between a UST app session and a regular LTT session.
2192 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2193 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2195 struct tm
*timeinfo
;
2198 char tmp_shm_path
[PATH_MAX
];
2200 timeinfo
= localtime(&app
->registration_time
);
2201 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2203 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2205 ua_sess
->tracing_id
= usess
->id
;
2206 ua_sess
->id
= get_next_session_id();
2207 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2208 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2209 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2210 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2211 ua_sess
->buffer_type
= usess
->buffer_type
;
2212 ua_sess
->bits_per_long
= app
->bits_per_long
;
2214 /* There is only one consumer object per session possible. */
2215 consumer_output_get(usess
->consumer
);
2216 ua_sess
->consumer
= usess
->consumer
;
2218 ua_sess
->output_traces
= usess
->output_traces
;
2219 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2220 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2221 &usess
->metadata_attr
);
2223 switch (ua_sess
->buffer_type
) {
2224 case LTTNG_BUFFER_PER_PID
:
2225 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2226 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2229 case LTTNG_BUFFER_PER_UID
:
2230 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2231 DEFAULT_UST_TRACE_UID_PATH
,
2232 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2233 app
->bits_per_long
);
2240 PERROR("asprintf UST shadow copy session");
2245 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2246 sizeof(ua_sess
->root_shm_path
));
2247 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2248 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2249 sizeof(ua_sess
->shm_path
));
2250 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2251 if (ua_sess
->shm_path
[0]) {
2252 switch (ua_sess
->buffer_type
) {
2253 case LTTNG_BUFFER_PER_PID
:
2254 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2255 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2256 app
->name
, app
->pid
, datetime
);
2258 case LTTNG_BUFFER_PER_UID
:
2259 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2260 "/" DEFAULT_UST_TRACE_UID_PATH
,
2261 app
->uid
, app
->bits_per_long
);
2268 PERROR("sprintf UST shadow copy session");
2272 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2273 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2274 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2279 consumer_output_put(ua_sess
->consumer
);
2283 * Lookup sesison wrapper.
2286 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2287 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2289 /* Get right UST app session from app */
2290 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2294 * Return ust app session from the app session hashtable using the UST session
2297 static struct ust_app_session
*lookup_session_by_app(
2298 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2300 struct lttng_ht_iter iter
;
2301 struct lttng_ht_node_u64
*node
;
2303 __lookup_session_by_app(usess
, app
, &iter
);
2304 node
= lttng_ht_iter_get_node_u64(&iter
);
2309 return caa_container_of(node
, struct ust_app_session
, node
);
2316 * Setup buffer registry per PID for the given session and application. If none
2317 * is found, a new one is created, added to the global registry and
2318 * initialized. If regp is valid, it's set with the newly created object.
2320 * Return 0 on success or else a negative value.
2322 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2323 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2326 struct buffer_reg_pid
*reg_pid
;
2333 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2336 * This is the create channel path meaning that if there is NO
2337 * registry available, we have to create one for this session.
2339 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2340 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2348 /* Initialize registry. */
2349 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2350 app
->bits_per_long
, app
->uint8_t_alignment
,
2351 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2352 app
->uint64_t_alignment
, app
->long_alignment
,
2353 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2354 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2355 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2356 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2357 ua_sess
->tracing_id
,
2361 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2362 * destroy the buffer registry, because it is always expected
2363 * that if the buffer registry can be found, its ust registry is
2366 buffer_reg_pid_destroy(reg_pid
);
2370 buffer_reg_pid_add(reg_pid
);
2372 DBG3("UST app buffer registry per PID created successfully");
2384 * Setup buffer registry per UID for the given session and application. If none
2385 * is found, a new one is created, added to the global registry and
2386 * initialized. If regp is valid, it's set with the newly created object.
2388 * Return 0 on success or else a negative value.
2390 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2391 struct ust_app_session
*ua_sess
,
2392 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2395 struct buffer_reg_uid
*reg_uid
;
2402 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2405 * This is the create channel path meaning that if there is NO
2406 * registry available, we have to create one for this session.
2408 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2409 LTTNG_DOMAIN_UST
, ®_uid
,
2410 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2418 /* Initialize registry. */
2419 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2420 app
->bits_per_long
, app
->uint8_t_alignment
,
2421 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2422 app
->uint64_t_alignment
, app
->long_alignment
,
2423 app
->byte_order
, app
->version
.major
,
2424 app
->version
.minor
, reg_uid
->root_shm_path
,
2425 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2426 ua_sess
->tracing_id
, app
->uid
);
2429 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2430 * destroy the buffer registry, because it is always expected
2431 * that if the buffer registry can be found, its ust registry is
2434 buffer_reg_uid_destroy(reg_uid
, NULL
);
2437 /* Add node to teardown list of the session. */
2438 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2440 buffer_reg_uid_add(reg_uid
);
2442 DBG3("UST app buffer registry per UID created successfully");
2453 * Create a session on the tracer side for the given app.
2455 * On success, ua_sess_ptr is populated with the session pointer or else left
2456 * untouched. If the session was created, is_created is set to 1. On error,
2457 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2460 * Returns 0 on success or else a negative code which is either -ENOMEM or
2461 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2463 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2464 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2467 int ret
, created
= 0;
2468 struct ust_app_session
*ua_sess
;
2472 assert(ua_sess_ptr
);
2474 health_code_update();
2476 ua_sess
= lookup_session_by_app(usess
, app
);
2477 if (ua_sess
== NULL
) {
2478 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2479 app
->pid
, usess
->id
);
2480 ua_sess
= alloc_ust_app_session();
2481 if (ua_sess
== NULL
) {
2482 /* Only malloc can failed so something is really wrong */
2486 shadow_copy_session(ua_sess
, usess
, app
);
2490 switch (usess
->buffer_type
) {
2491 case LTTNG_BUFFER_PER_PID
:
2492 /* Init local registry. */
2493 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2495 delete_ust_app_session(-1, ua_sess
, app
);
2499 case LTTNG_BUFFER_PER_UID
:
2500 /* Look for a global registry. If none exists, create one. */
2501 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2503 delete_ust_app_session(-1, ua_sess
, app
);
2513 health_code_update();
2515 if (ua_sess
->handle
== -1) {
2516 pthread_mutex_lock(&app
->sock_lock
);
2517 ret
= ustctl_create_session(app
->sock
);
2518 pthread_mutex_unlock(&app
->sock_lock
);
2520 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2521 ERR("Creating session for app pid %d with ret %d",
2524 DBG("UST app creating session failed. Application is dead");
2526 * This is normal behavior, an application can die during the
2527 * creation process. Don't report an error so the execution can
2528 * continue normally. This will get flagged ENOTCONN and the
2529 * caller will handle it.
2533 delete_ust_app_session(-1, ua_sess
, app
);
2534 if (ret
!= -ENOMEM
) {
2536 * Tracer is probably gone or got an internal error so let's
2537 * behave like it will soon unregister or not usable.
2544 ua_sess
->handle
= ret
;
2546 /* Add ust app session to app's HT */
2547 lttng_ht_node_init_u64(&ua_sess
->node
,
2548 ua_sess
->tracing_id
);
2549 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2550 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2551 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2552 &ua_sess
->ust_objd_node
);
2554 DBG2("UST app session created successfully with handle %d", ret
);
2557 *ua_sess_ptr
= ua_sess
;
2559 *is_created
= created
;
2562 /* Everything went well. */
2566 health_code_update();
2571 * Match function for a hash table lookup of ust_app_ctx.
2573 * It matches an ust app context based on the context type and, in the case
2574 * of perf counters, their name.
2576 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2578 struct ust_app_ctx
*ctx
;
2579 const struct lttng_ust_context_attr
*key
;
2584 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2588 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2593 case LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
:
2594 if (strncmp(key
->u
.perf_counter
.name
,
2595 ctx
->ctx
.u
.perf_counter
.name
,
2596 sizeof(key
->u
.perf_counter
.name
))) {
2600 case LTTNG_UST_CONTEXT_APP_CONTEXT
:
2601 if (strcmp(key
->u
.app_ctx
.provider_name
,
2602 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2603 strcmp(key
->u
.app_ctx
.ctx_name
,
2604 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2620 * Lookup for an ust app context from an lttng_ust_context.
2622 * Must be called while holding RCU read side lock.
2623 * Return an ust_app_ctx object or NULL on error.
2626 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2627 struct lttng_ust_context_attr
*uctx
)
2629 struct lttng_ht_iter iter
;
2630 struct lttng_ht_node_ulong
*node
;
2631 struct ust_app_ctx
*app_ctx
= NULL
;
2636 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2637 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2638 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2639 node
= lttng_ht_iter_get_node_ulong(&iter
);
2644 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2651 * Create a context for the channel on the tracer.
2653 * Called with UST app session lock held and a RCU read side lock.
2656 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2657 struct lttng_ust_context_attr
*uctx
,
2658 struct ust_app
*app
)
2661 struct ust_app_ctx
*ua_ctx
;
2663 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2665 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2671 ua_ctx
= alloc_ust_app_ctx(uctx
);
2672 if (ua_ctx
== NULL
) {
2678 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2679 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2680 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2682 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2692 * Enable on the tracer side a ust app event for the session and channel.
2694 * Called with UST app session lock held.
2697 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2698 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2702 ret
= enable_ust_object(app
, ua_event
->obj
);
2707 ua_event
->enabled
= 1;
2714 * Disable on the tracer side a ust app event for the session and channel.
2716 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2717 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2721 ret
= disable_ust_object(app
, ua_event
->obj
);
2726 ua_event
->enabled
= 0;
2733 * Lookup ust app channel for session and disable it on the tracer side.
2736 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2737 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2741 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2746 ua_chan
->enabled
= 0;
2753 * Lookup ust app channel for session and enable it on the tracer side. This
2754 * MUST be called with a RCU read side lock acquired.
2756 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2757 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2760 struct lttng_ht_iter iter
;
2761 struct lttng_ht_node_str
*ua_chan_node
;
2762 struct ust_app_channel
*ua_chan
;
2764 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2765 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2766 if (ua_chan_node
== NULL
) {
2767 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2768 uchan
->name
, ua_sess
->tracing_id
);
2772 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2774 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2784 * Ask the consumer to create a channel and get it if successful.
2786 * Called with UST app session lock held.
2788 * Return 0 on success or else a negative value.
2790 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2791 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2792 int bitness
, struct ust_registry_session
*registry
,
2793 uint64_t trace_archive_id
)
2796 unsigned int nb_fd
= 0;
2797 struct consumer_socket
*socket
;
2805 health_code_update();
2807 /* Get the right consumer socket for the application. */
2808 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2814 health_code_update();
2816 /* Need one fd for the channel. */
2817 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2819 ERR("Exhausted number of available FD upon create channel");
2824 * Ask consumer to create channel. The consumer will return the number of
2825 * stream we have to expect.
2827 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2828 registry
, usess
->current_trace_chunk
);
2834 * Compute the number of fd needed before receiving them. It must be 2 per
2835 * stream (2 being the default value here).
2837 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2839 /* Reserve the amount of file descriptor we need. */
2840 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2842 ERR("Exhausted number of available FD upon create channel");
2843 goto error_fd_get_stream
;
2846 health_code_update();
2849 * Now get the channel from the consumer. This call wil populate the stream
2850 * list of that channel and set the ust objects.
2852 if (usess
->consumer
->enabled
) {
2853 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2863 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2864 error_fd_get_stream
:
2866 * Initiate a destroy channel on the consumer since we had an error
2867 * handling it on our side. The return value is of no importance since we
2868 * already have a ret value set by the previous error that we need to
2871 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2873 lttng_fd_put(LTTNG_FD_APPS
, 1);
2875 health_code_update();
2881 * Duplicate the ust data object of the ust app stream and save it in the
2882 * buffer registry stream.
2884 * Return 0 on success or else a negative value.
2886 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2887 struct ust_app_stream
*stream
)
2894 /* Reserve the amount of file descriptor we need. */
2895 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2897 ERR("Exhausted number of available FD upon duplicate stream");
2901 /* Duplicate object for stream once the original is in the registry. */
2902 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2903 reg_stream
->obj
.ust
);
2905 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2906 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2907 lttng_fd_put(LTTNG_FD_APPS
, 2);
2910 stream
->handle
= stream
->obj
->handle
;
2917 * Duplicate the ust data object of the ust app. channel and save it in the
2918 * buffer registry channel.
2920 * Return 0 on success or else a negative value.
2922 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2923 struct ust_app_channel
*ua_chan
)
2930 /* Need two fds for the channel. */
2931 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2933 ERR("Exhausted number of available FD upon duplicate channel");
2937 /* Duplicate object for stream once the original is in the registry. */
2938 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2940 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2941 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2944 ua_chan
->handle
= ua_chan
->obj
->handle
;
2949 lttng_fd_put(LTTNG_FD_APPS
, 1);
2955 * For a given channel buffer registry, setup all streams of the given ust
2956 * application channel.
2958 * Return 0 on success or else a negative value.
2960 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2961 struct ust_app_channel
*ua_chan
,
2962 struct ust_app
*app
)
2965 struct ust_app_stream
*stream
, *stmp
;
2970 DBG2("UST app setup buffer registry stream");
2972 /* Send all streams to application. */
2973 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2974 struct buffer_reg_stream
*reg_stream
;
2976 ret
= buffer_reg_stream_create(®_stream
);
2982 * Keep original pointer and nullify it in the stream so the delete
2983 * stream call does not release the object.
2985 reg_stream
->obj
.ust
= stream
->obj
;
2987 buffer_reg_stream_add(reg_stream
, reg_chan
);
2989 /* We don't need the streams anymore. */
2990 cds_list_del(&stream
->list
);
2991 delete_ust_app_stream(-1, stream
, app
);
2999 * Create a buffer registry channel for the given session registry and
3000 * application channel object. If regp pointer is valid, it's set with the
3001 * created object. Important, the created object is NOT added to the session
3002 * registry hash table.
3004 * Return 0 on success else a negative value.
3006 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3007 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3010 struct buffer_reg_channel
*reg_chan
= NULL
;
3015 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3017 /* Create buffer registry channel. */
3018 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
3023 reg_chan
->consumer_key
= ua_chan
->key
;
3024 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3025 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3027 /* Create and add a channel registry to session. */
3028 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3029 ua_chan
->tracing_channel_id
);
3033 buffer_reg_channel_add(reg_sess
, reg_chan
);
3042 /* Safe because the registry channel object was not added to any HT. */
3043 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3049 * Setup buffer registry channel for the given session registry and application
3050 * channel object. If regp pointer is valid, it's set with the created object.
3052 * Return 0 on success else a negative value.
3054 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3055 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
3056 struct ust_app
*app
)
3063 assert(ua_chan
->obj
);
3065 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3067 /* Setup all streams for the registry. */
3068 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
3073 reg_chan
->obj
.ust
= ua_chan
->obj
;
3074 ua_chan
->obj
= NULL
;
3079 buffer_reg_channel_remove(reg_sess
, reg_chan
);
3080 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3085 * Send buffer registry channel to the application.
3087 * Return 0 on success else a negative value.
3089 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
3090 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3091 struct ust_app_channel
*ua_chan
)
3094 struct buffer_reg_stream
*reg_stream
;
3101 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3103 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
3108 /* Send channel to the application. */
3109 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3110 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3111 ret
= -ENOTCONN
; /* Caused by app exiting. */
3113 } else if (ret
< 0) {
3117 health_code_update();
3119 /* Send all streams to application. */
3120 pthread_mutex_lock(®_chan
->stream_list_lock
);
3121 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
3122 struct ust_app_stream stream
;
3124 ret
= duplicate_stream_object(reg_stream
, &stream
);
3126 goto error_stream_unlock
;
3129 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3131 (void) release_ust_app_stream(-1, &stream
, app
);
3132 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3133 ret
= -ENOTCONN
; /* Caused by app exiting. */
3135 goto error_stream_unlock
;
3139 * The return value is not important here. This function will output an
3142 (void) release_ust_app_stream(-1, &stream
, app
);
3144 ua_chan
->is_sent
= 1;
3146 error_stream_unlock
:
3147 pthread_mutex_unlock(®_chan
->stream_list_lock
);
3153 * Create and send to the application the created buffers with per UID buffers.
3155 * This MUST be called with a RCU read side lock acquired.
3156 * The session list lock and the session's lock must be acquired.
3158 * Return 0 on success else a negative value.
3160 static int create_channel_per_uid(struct ust_app
*app
,
3161 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3162 struct ust_app_channel
*ua_chan
)
3165 struct buffer_reg_uid
*reg_uid
;
3166 struct buffer_reg_channel
*reg_chan
;
3167 struct ltt_session
*session
= NULL
;
3168 enum lttng_error_code notification_ret
;
3169 struct ust_registry_channel
*chan_reg
;
3176 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3178 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3180 * The session creation handles the creation of this global registry
3181 * object. If none can be find, there is a code flow problem or a
3186 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3192 /* Create the buffer registry channel object. */
3193 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
3195 ERR("Error creating the UST channel \"%s\" registry instance",
3200 session
= session_find_by_id(ua_sess
->tracing_id
);
3202 assert(pthread_mutex_trylock(&session
->lock
));
3203 assert(session_trylock_list());
3206 * Create the buffers on the consumer side. This call populates the
3207 * ust app channel object with all streams and data object.
3209 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3210 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3211 session
->most_recent_chunk_id
.value
);
3213 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3217 * Let's remove the previously created buffer registry channel so
3218 * it's not visible anymore in the session registry.
3220 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3221 ua_chan
->tracing_channel_id
, false);
3222 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
3223 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
3228 * Setup the streams and add it to the session registry.
3230 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3231 ua_chan
, reg_chan
, app
);
3233 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3237 /* Notify the notification subsystem of the channel's creation. */
3238 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3239 chan_reg
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3240 ua_chan
->tracing_channel_id
);
3242 chan_reg
->consumer_key
= ua_chan
->key
;
3244 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3246 notification_ret
= notification_thread_command_add_channel(
3247 notification_thread_handle
, session
->name
,
3248 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3249 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3251 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3252 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3253 if (notification_ret
!= LTTNG_OK
) {
3254 ret
= - (int) notification_ret
;
3255 ERR("Failed to add channel to notification thread");
3260 /* Send buffers to the application. */
3261 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
3263 if (ret
!= -ENOTCONN
) {
3264 ERR("Error sending channel to application");
3271 session_put(session
);
3277 * Create and send to the application the created buffers with per PID buffers.
3279 * Called with UST app session lock held.
3280 * The session list lock and the session's lock must be acquired.
3282 * Return 0 on success else a negative value.
3284 static int create_channel_per_pid(struct ust_app
*app
,
3285 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3286 struct ust_app_channel
*ua_chan
)
3289 struct ust_registry_session
*registry
;
3290 enum lttng_error_code cmd_ret
;
3291 struct ltt_session
*session
= NULL
;
3292 uint64_t chan_reg_key
;
3293 struct ust_registry_channel
*chan_reg
;
3300 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3304 registry
= get_session_registry(ua_sess
);
3305 /* The UST app session lock is held, registry shall not be null. */
3308 /* Create and add a new channel registry to session. */
3309 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3311 ERR("Error creating the UST channel \"%s\" registry instance",
3316 session
= session_find_by_id(ua_sess
->tracing_id
);
3319 assert(pthread_mutex_trylock(&session
->lock
));
3320 assert(session_trylock_list());
3322 /* Create and get channel on the consumer side. */
3323 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3324 app
->bits_per_long
, registry
,
3325 session
->most_recent_chunk_id
.value
);
3327 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3329 goto error_remove_from_registry
;
3332 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3334 if (ret
!= -ENOTCONN
) {
3335 ERR("Error sending channel to application");
3337 goto error_remove_from_registry
;
3340 chan_reg_key
= ua_chan
->key
;
3341 pthread_mutex_lock(®istry
->lock
);
3342 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
3344 chan_reg
->consumer_key
= ua_chan
->key
;
3345 pthread_mutex_unlock(®istry
->lock
);
3347 cmd_ret
= notification_thread_command_add_channel(
3348 notification_thread_handle
, session
->name
,
3349 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
3350 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
3352 ua_chan
->key
, LTTNG_DOMAIN_UST
,
3353 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3354 if (cmd_ret
!= LTTNG_OK
) {
3355 ret
= - (int) cmd_ret
;
3356 ERR("Failed to add channel to notification thread");
3357 goto error_remove_from_registry
;
3360 error_remove_from_registry
:
3362 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3367 session_put(session
);
3373 * From an already allocated ust app channel, create the channel buffers if
3374 * needed and send them to the application. This MUST be called with a RCU read
3375 * side lock acquired.
3377 * Called with UST app session lock held.
3379 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3380 * the application exited concurrently.
3382 static int ust_app_channel_send(struct ust_app
*app
,
3383 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3384 struct ust_app_channel
*ua_chan
)
3390 assert(usess
->active
);
3394 /* Handle buffer type before sending the channel to the application. */
3395 switch (usess
->buffer_type
) {
3396 case LTTNG_BUFFER_PER_UID
:
3398 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3404 case LTTNG_BUFFER_PER_PID
:
3406 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3418 /* Initialize ust objd object using the received handle and add it. */
3419 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3420 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3422 /* If channel is not enabled, disable it on the tracer */
3423 if (!ua_chan
->enabled
) {
3424 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3435 * Create UST app channel and return it through ua_chanp if not NULL.
3437 * Called with UST app session lock and RCU read-side lock held.
3439 * Return 0 on success or else a negative value.
3441 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3442 struct ltt_ust_channel
*uchan
,
3443 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
3444 struct ust_app_channel
**ua_chanp
)
3447 struct lttng_ht_iter iter
;
3448 struct lttng_ht_node_str
*ua_chan_node
;
3449 struct ust_app_channel
*ua_chan
;
3451 /* Lookup channel in the ust app session */
3452 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3453 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3454 if (ua_chan_node
!= NULL
) {
3455 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3459 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3460 if (ua_chan
== NULL
) {
3461 /* Only malloc can fail here */
3465 shadow_copy_channel(ua_chan
, uchan
);
3467 /* Set channel type. */
3468 ua_chan
->attr
.type
= type
;
3470 /* Only add the channel if successful on the tracer side. */
3471 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3474 *ua_chanp
= ua_chan
;
3477 /* Everything went well. */
3485 * Create UST app event and create it on the tracer side.
3487 * Called with ust app session mutex held.
3490 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3491 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3492 struct ust_app
*app
)
3495 struct ust_app_event
*ua_event
;
3497 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3498 if (ua_event
== NULL
) {
3499 /* Only failure mode of alloc_ust_app_event(). */
3503 shadow_copy_event(ua_event
, uevent
);
3505 /* Create it on the tracer side */
3506 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3509 * Not found previously means that it does not exist on the
3510 * tracer. If the application reports that the event existed,
3511 * it means there is a bug in the sessiond or lttng-ust
3512 * (or corruption, etc.)
3514 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3515 ERR("Tracer for application reported that an event being created already existed: "
3516 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3518 app
->pid
, app
->ppid
, app
->uid
,
3524 add_unique_ust_app_event(ua_chan
, ua_event
);
3526 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3533 /* Valid. Calling here is already in a read side lock */
3534 delete_ust_app_event(-1, ua_event
, app
);
3539 * Create UST app event and create it on the tracer side.
3541 * Called with ust app session mutex held.
3544 int create_ust_app_token_event_rule(struct lttng_trigger
*trigger
,
3545 struct ust_app
*app
)
3548 struct ust_app_token_event_rule
*ua_token
;
3550 ua_token
= alloc_ust_app_token_event_rule(trigger
);
3551 if (ua_token
== NULL
) {
3556 /* Create it on the tracer side */
3557 ret
= create_ust_token_event_rule(app
, ua_token
);
3560 * Not found previously means that it does not exist on the
3561 * tracer. If the application reports that the event existed,
3562 * it means there is a bug in the sessiond or lttng-ust
3563 * (or corruption, etc.)
3565 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3566 ERR("Tracer for application reported that a token event rule being created already existed: "
3567 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3568 lttng_trigger_get_tracer_token(trigger
),
3569 app
->pid
, app
->ppid
, app
->uid
,
3575 lttng_ht_add_unique_u64(app
->tokens_ht
, &ua_token
->node
);
3577 DBG2("UST app create token event rule %" PRIu64
" for PID %d completed", lttng_trigger_get_tracer_token(trigger
),
3583 /* Valid. Calling here is already in a read side lock */
3584 delete_ust_app_token_event_rule(-1, ua_token
, app
);
3590 * Create UST metadata and open it on the tracer side.
3592 * Called with UST app session lock held and RCU read side lock.
3594 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3595 struct ust_app
*app
, struct consumer_output
*consumer
)
3598 struct ust_app_channel
*metadata
;
3599 struct consumer_socket
*socket
;
3600 struct ust_registry_session
*registry
;
3601 struct ltt_session
*session
= NULL
;
3607 registry
= get_session_registry(ua_sess
);
3608 /* The UST app session is held registry shall not be null. */
3611 pthread_mutex_lock(®istry
->lock
);
3613 /* Metadata already exists for this registry or it was closed previously */
3614 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3619 /* Allocate UST metadata */
3620 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3622 /* malloc() failed */
3627 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3629 /* Need one fd for the channel. */
3630 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3632 ERR("Exhausted number of available FD upon create metadata");
3636 /* Get the right consumer socket for the application. */
3637 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3640 goto error_consumer
;
3644 * Keep metadata key so we can identify it on the consumer side. Assign it
3645 * to the registry *before* we ask the consumer so we avoid the race of the
3646 * consumer requesting the metadata and the ask_channel call on our side
3647 * did not returned yet.
3649 registry
->metadata_key
= metadata
->key
;
3651 session
= session_find_by_id(ua_sess
->tracing_id
);
3654 assert(pthread_mutex_trylock(&session
->lock
));
3655 assert(session_trylock_list());
3658 * Ask the metadata channel creation to the consumer. The metadata object
3659 * will be created by the consumer and kept their. However, the stream is
3660 * never added or monitored until we do a first push metadata to the
3663 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3664 registry
, session
->current_trace_chunk
);
3666 /* Nullify the metadata key so we don't try to close it later on. */
3667 registry
->metadata_key
= 0;
3668 goto error_consumer
;
3672 * The setup command will make the metadata stream be sent to the relayd,
3673 * if applicable, and the thread managing the metadatas. This is important
3674 * because after this point, if an error occurs, the only way the stream
3675 * can be deleted is to be monitored in the consumer.
3677 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3679 /* Nullify the metadata key so we don't try to close it later on. */
3680 registry
->metadata_key
= 0;
3681 goto error_consumer
;
3684 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3685 metadata
->key
, app
->pid
);
3688 lttng_fd_put(LTTNG_FD_APPS
, 1);
3689 delete_ust_app_channel(-1, metadata
, app
);
3691 pthread_mutex_unlock(®istry
->lock
);
3693 session_put(session
);
3699 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3700 * acquired before calling this function.
3702 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3704 struct ust_app
*app
= NULL
;
3705 struct lttng_ht_node_ulong
*node
;
3706 struct lttng_ht_iter iter
;
3708 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3709 node
= lttng_ht_iter_get_node_ulong(&iter
);
3711 DBG2("UST app no found with pid %d", pid
);
3715 DBG2("Found UST app by pid %d", pid
);
3717 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3724 * Allocate and init an UST app object using the registration information and
3725 * the command socket. This is called when the command socket connects to the
3728 * The object is returned on success or else NULL.
3730 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3732 struct ust_app
*lta
= NULL
;
3733 struct lttng_pipe
*trigger_event_source_pipe
= NULL
;
3738 DBG3("UST app creating application for socket %d", sock
);
3740 if ((msg
->bits_per_long
== 64 &&
3741 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3742 || (msg
->bits_per_long
== 32 &&
3743 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3744 ERR("Registration failed: application \"%s\" (pid: %d) has "
3745 "%d-bit long, but no consumerd for this size is available.\n",
3746 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3750 trigger_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3751 if (!trigger_event_source_pipe
) {
3752 PERROR("Open trigger pipe");
3756 lta
= zmalloc(sizeof(struct ust_app
));
3762 lta
->token_communication
.trigger_event_pipe
= trigger_event_source_pipe
;
3764 lta
->ppid
= msg
->ppid
;
3765 lta
->uid
= msg
->uid
;
3766 lta
->gid
= msg
->gid
;
3768 lta
->bits_per_long
= msg
->bits_per_long
;
3769 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3770 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3771 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3772 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3773 lta
->long_alignment
= msg
->long_alignment
;
3774 lta
->byte_order
= msg
->byte_order
;
3776 lta
->v_major
= msg
->major
;
3777 lta
->v_minor
= msg
->minor
;
3778 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3779 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3780 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3781 lta
->notify_sock
= -1;
3782 lta
->tokens_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3784 /* Copy name and make sure it's NULL terminated. */
3785 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3786 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3789 * Before this can be called, when receiving the registration information,
3790 * the application compatibility is checked. So, at this point, the
3791 * application can work with this session daemon.
3793 lta
->compatible
= 1;
3795 lta
->pid
= msg
->pid
;
3796 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3798 pthread_mutex_init(<a
->sock_lock
, NULL
);
3799 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3801 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3807 * For a given application object, add it to every hash table.
3809 void ust_app_add(struct ust_app
*app
)
3812 assert(app
->notify_sock
>= 0);
3814 app
->registration_time
= time(NULL
);
3819 * On a re-registration, we want to kick out the previous registration of
3822 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3825 * The socket _should_ be unique until _we_ call close. So, a add_unique
3826 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3827 * already in the table.
3829 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3831 /* Add application to the notify socket hash table. */
3832 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3833 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3835 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3836 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3837 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3844 * Set the application version into the object.
3846 * Return 0 on success else a negative value either an errno code or a
3847 * LTTng-UST error code.
3849 int ust_app_version(struct ust_app
*app
)
3855 pthread_mutex_lock(&app
->sock_lock
);
3856 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3857 pthread_mutex_unlock(&app
->sock_lock
);
3859 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3860 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3862 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3870 * Setup the base trigger group.
3872 * Return 0 on success else a negative value either an errno code or a
3873 * LTTng-UST error code.
3875 int ust_app_setup_trigger_group(struct ust_app
*app
)
3879 struct lttng_ust_object_data
*group
= NULL
;
3880 enum lttng_error_code lttng_ret
;
3881 enum trigger_error_accounting_status trigger_error_accounting_status
;
3885 /* Get the write side of the pipe */
3886 writefd
= lttng_pipe_get_writefd(app
->token_communication
.trigger_event_pipe
);
3888 pthread_mutex_lock(&app
->sock_lock
);
3889 ret
= ustctl_create_trigger_group(app
->sock
, writefd
, &group
);
3890 pthread_mutex_unlock(&app
->sock_lock
);
3892 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3893 ERR("UST app %d create_trigger_group failed with ret %d, trigger pipe %d", app
->sock
, ret
, writefd
);
3895 DBG("UST app %d create trigger group failed. Application is dead", app
->sock
);
3900 lttng_ret
= notification_thread_command_add_application(
3901 notification_thread_handle
, lttng_pipe_get_readfd(app
->token_communication
.trigger_event_pipe
), LTTNG_DOMAIN_UST
);
3902 if (lttng_ret
!= LTTNG_OK
) {
3905 ERR("Failed to add channel to notification thread");
3909 /* Assign handle only when the complete setup is valid */
3910 app
->token_communication
.handle
= group
;
3912 trigger_error_accounting_status
= trigger_error_accounting_register_app(app
);
3913 if (trigger_error_accounting_status
!= TRIGGER_ERROR_ACCOUNTING_STATUS_OK
) {
3914 ERR("Failed to setup trigger error accouting for app");
3925 * Unregister app by removing it from the global traceable app list and freeing
3928 * The socket is already closed at this point so no close to sock.
3930 void ust_app_unregister(int sock
)
3932 enum lttng_error_code ret_code
;
3933 struct ust_app
*lta
;
3934 struct lttng_ht_node_ulong
*node
;
3935 struct lttng_ht_iter ust_app_sock_iter
;
3936 struct lttng_ht_iter iter
;
3937 struct ust_app_session
*ua_sess
;
3942 /* Get the node reference for a call_rcu */
3943 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3944 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3947 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3948 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3951 * For per-PID buffers, perform "push metadata" and flush all
3952 * application streams before removing app from hash tables,
3953 * ensuring proper behavior of data_pending check.
3954 * Remove sessions so they are not visible during deletion.
3956 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3958 struct ust_registry_session
*registry
;
3960 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3962 /* The session was already removed so scheduled for teardown. */
3966 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3967 (void) ust_app_flush_app_session(lta
, ua_sess
);
3971 * Add session to list for teardown. This is safe since at this point we
3972 * are the only one using this list.
3974 pthread_mutex_lock(&ua_sess
->lock
);
3976 if (ua_sess
->deleted
) {
3977 pthread_mutex_unlock(&ua_sess
->lock
);
3982 * Normally, this is done in the delete session process which is
3983 * executed in the call rcu below. However, upon registration we can't
3984 * afford to wait for the grace period before pushing data or else the
3985 * data pending feature can race between the unregistration and stop
3986 * command where the data pending command is sent *before* the grace
3989 * The close metadata below nullifies the metadata pointer in the
3990 * session so the delete session will NOT push/close a second time.
3992 registry
= get_session_registry(ua_sess
);
3994 /* Push metadata for application before freeing the application. */
3995 (void) push_metadata(registry
, ua_sess
->consumer
);
3998 * Don't ask to close metadata for global per UID buffers. Close
3999 * metadata only on destroy trace session in this case. Also, the
4000 * previous push metadata could have flag the metadata registry to
4001 * close so don't send a close command if closed.
4003 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4004 /* And ask to close it for this session registry. */
4005 (void) close_metadata(registry
, ua_sess
->consumer
);
4008 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4010 pthread_mutex_unlock(&ua_sess
->lock
);
4013 /* Remove application from PID hash table */
4014 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4018 * Remove application from notify hash table. The thread handling the
4019 * notify socket could have deleted the node so ignore on error because
4020 * either way it's valid. The close of that socket is handled by the
4021 * apps_notify_thread.
4023 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4024 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4027 * Ignore return value since the node might have been removed before by an
4028 * add replace during app registration because the PID can be reassigned by
4031 iter
.iter
.node
= <a
->pid_n
.node
;
4032 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4034 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4038 /* trigger handle can be null in certain scenario such as a dead app */
4039 if (lta
->token_communication
.handle
) {
4040 int fd
= lttng_pipe_get_readfd(
4041 lta
->token_communication
.trigger_event_pipe
);
4043 ret_code
= notification_thread_command_remove_application(
4044 notification_thread_handle
,
4046 if (ret_code
!= LTTNG_OK
) {
4047 ERR("Failed to remove application from notification thread");
4052 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4059 * Fill events array with all events name of all registered apps.
4061 int ust_app_list_events(struct lttng_event
**events
)
4064 size_t nbmem
, count
= 0;
4065 struct lttng_ht_iter iter
;
4066 struct ust_app
*app
;
4067 struct lttng_event
*tmp_event
;
4069 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4070 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4071 if (tmp_event
== NULL
) {
4072 PERROR("zmalloc ust app events");
4079 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4080 struct lttng_ust_tracepoint_iter uiter
;
4082 health_code_update();
4084 if (!app
->compatible
) {
4086 * TODO: In time, we should notice the caller of this error by
4087 * telling him that this is a version error.
4091 pthread_mutex_lock(&app
->sock_lock
);
4092 handle
= ustctl_tracepoint_list(app
->sock
);
4094 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4095 ERR("UST app list events getting handle failed for app pid %d",
4098 pthread_mutex_unlock(&app
->sock_lock
);
4102 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
4103 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4104 /* Handle ustctl error. */
4108 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4109 ERR("UST app tp list get failed for app %d with ret %d",
4112 DBG3("UST app tp list get failed. Application is dead");
4114 * This is normal behavior, an application can die during the
4115 * creation process. Don't report an error so the execution can
4116 * continue normally. Continue normal execution.
4121 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4122 if (release_ret
< 0 &&
4123 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4124 release_ret
!= -EPIPE
) {
4125 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4127 pthread_mutex_unlock(&app
->sock_lock
);
4131 health_code_update();
4132 if (count
>= nbmem
) {
4133 /* In case the realloc fails, we free the memory */
4134 struct lttng_event
*new_tmp_event
;
4137 new_nbmem
= nbmem
<< 1;
4138 DBG2("Reallocating event list from %zu to %zu entries",
4140 new_tmp_event
= realloc(tmp_event
,
4141 new_nbmem
* sizeof(struct lttng_event
));
4142 if (new_tmp_event
== NULL
) {
4145 PERROR("realloc ust app events");
4148 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4149 if (release_ret
< 0 &&
4150 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4151 release_ret
!= -EPIPE
) {
4152 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4154 pthread_mutex_unlock(&app
->sock_lock
);
4157 /* Zero the new memory */
4158 memset(new_tmp_event
+ nbmem
, 0,
4159 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4161 tmp_event
= new_tmp_event
;
4163 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
4164 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4165 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
4166 tmp_event
[count
].pid
= app
->pid
;
4167 tmp_event
[count
].enabled
= -1;
4170 ret
= ustctl_release_handle(app
->sock
, handle
);
4171 pthread_mutex_unlock(&app
->sock_lock
);
4172 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4173 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4178 *events
= tmp_event
;
4180 DBG2("UST app list events done (%zu events)", count
);
4185 health_code_update();
4190 * Fill events array with all events name of all registered apps.
4192 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4195 size_t nbmem
, count
= 0;
4196 struct lttng_ht_iter iter
;
4197 struct ust_app
*app
;
4198 struct lttng_event_field
*tmp_event
;
4200 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4201 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4202 if (tmp_event
== NULL
) {
4203 PERROR("zmalloc ust app event fields");
4210 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4211 struct lttng_ust_field_iter uiter
;
4213 health_code_update();
4215 if (!app
->compatible
) {
4217 * TODO: In time, we should notice the caller of this error by
4218 * telling him that this is a version error.
4222 pthread_mutex_lock(&app
->sock_lock
);
4223 handle
= ustctl_tracepoint_field_list(app
->sock
);
4225 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4226 ERR("UST app list field getting handle failed for app pid %d",
4229 pthread_mutex_unlock(&app
->sock_lock
);
4233 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
4234 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4235 /* Handle ustctl error. */
4239 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4240 ERR("UST app tp list field failed for app %d with ret %d",
4243 DBG3("UST app tp list field failed. Application is dead");
4245 * This is normal behavior, an application can die during the
4246 * creation process. Don't report an error so the execution can
4247 * continue normally. Reset list and count for next app.
4252 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4253 pthread_mutex_unlock(&app
->sock_lock
);
4254 if (release_ret
< 0 &&
4255 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4256 release_ret
!= -EPIPE
) {
4257 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4262 health_code_update();
4263 if (count
>= nbmem
) {
4264 /* In case the realloc fails, we free the memory */
4265 struct lttng_event_field
*new_tmp_event
;
4268 new_nbmem
= nbmem
<< 1;
4269 DBG2("Reallocating event field list from %zu to %zu entries",
4271 new_tmp_event
= realloc(tmp_event
,
4272 new_nbmem
* sizeof(struct lttng_event_field
));
4273 if (new_tmp_event
== NULL
) {
4276 PERROR("realloc ust app event fields");
4279 release_ret
= ustctl_release_handle(app
->sock
, handle
);
4280 pthread_mutex_unlock(&app
->sock_lock
);
4282 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4283 release_ret
!= -EPIPE
) {
4284 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4288 /* Zero the new memory */
4289 memset(new_tmp_event
+ nbmem
, 0,
4290 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4292 tmp_event
= new_tmp_event
;
4295 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
4296 /* Mapping between these enums matches 1 to 1. */
4297 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4298 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4300 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
4301 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4302 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4303 tmp_event
[count
].event
.pid
= app
->pid
;
4304 tmp_event
[count
].event
.enabled
= -1;
4307 ret
= ustctl_release_handle(app
->sock
, handle
);
4308 pthread_mutex_unlock(&app
->sock_lock
);
4310 ret
!= -LTTNG_UST_ERR_EXITING
&&
4312 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4317 *fields
= tmp_event
;
4319 DBG2("UST app list event fields done (%zu events)", count
);
4324 health_code_update();
4329 * Free and clean all traceable apps of the global list.
4331 * Should _NOT_ be called with RCU read-side lock held.
4333 void ust_app_clean_list(void)
4336 struct ust_app
*app
;
4337 struct lttng_ht_iter iter
;
4339 DBG2("UST app cleaning registered apps hash table");
4343 /* Cleanup notify socket hash table */
4344 if (ust_app_ht_by_notify_sock
) {
4345 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4346 notify_sock_n
.node
) {
4347 struct cds_lfht_node
*node
;
4348 struct ust_app
*app
;
4350 node
= cds_lfht_iter_get_node(&iter
.iter
);
4355 app
= container_of(node
, struct ust_app
,
4356 notify_sock_n
.node
);
4357 ust_app_notify_sock_unregister(app
->notify_sock
);
4362 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4363 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4365 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4369 /* Cleanup socket hash table */
4370 if (ust_app_ht_by_sock
) {
4371 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4373 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4380 /* Destroy is done only when the ht is empty */
4382 ht_cleanup_push(ust_app_ht
);
4384 if (ust_app_ht_by_sock
) {
4385 ht_cleanup_push(ust_app_ht_by_sock
);
4387 if (ust_app_ht_by_notify_sock
) {
4388 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4393 * Init UST app hash table.
4395 int ust_app_ht_alloc(void)
4397 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4401 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4402 if (!ust_app_ht_by_sock
) {
4405 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4406 if (!ust_app_ht_by_notify_sock
) {
4413 * For a specific UST session, disable the channel for all registered apps.
4415 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4416 struct ltt_ust_channel
*uchan
)
4419 struct lttng_ht_iter iter
;
4420 struct lttng_ht_node_str
*ua_chan_node
;
4421 struct ust_app
*app
;
4422 struct ust_app_session
*ua_sess
;
4423 struct ust_app_channel
*ua_chan
;
4425 assert(usess
->active
);
4426 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4427 uchan
->name
, usess
->id
);
4431 /* For every registered applications */
4432 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4433 struct lttng_ht_iter uiter
;
4434 if (!app
->compatible
) {
4436 * TODO: In time, we should notice the caller of this error by
4437 * telling him that this is a version error.
4441 ua_sess
= lookup_session_by_app(usess
, app
);
4442 if (ua_sess
== NULL
) {
4447 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4448 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4449 /* If the session if found for the app, the channel must be there */
4450 assert(ua_chan_node
);
4452 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4453 /* The channel must not be already disabled */
4454 assert(ua_chan
->enabled
== 1);
4456 /* Disable channel onto application */
4457 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4459 /* XXX: We might want to report this error at some point... */
4469 * For a specific UST session, enable the channel for all registered apps.
4471 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4472 struct ltt_ust_channel
*uchan
)
4475 struct lttng_ht_iter iter
;
4476 struct ust_app
*app
;
4477 struct ust_app_session
*ua_sess
;
4479 assert(usess
->active
);
4480 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4481 uchan
->name
, usess
->id
);
4485 /* For every registered applications */
4486 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4487 if (!app
->compatible
) {
4489 * TODO: In time, we should notice the caller of this error by
4490 * telling him that this is a version error.
4494 ua_sess
= lookup_session_by_app(usess
, app
);
4495 if (ua_sess
== NULL
) {
4499 /* Enable channel onto application */
4500 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4502 /* XXX: We might want to report this error at some point... */
4512 * Disable an event in a channel and for a specific session.
4514 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4515 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4518 struct lttng_ht_iter iter
, uiter
;
4519 struct lttng_ht_node_str
*ua_chan_node
;
4520 struct ust_app
*app
;
4521 struct ust_app_session
*ua_sess
;
4522 struct ust_app_channel
*ua_chan
;
4523 struct ust_app_event
*ua_event
;
4525 assert(usess
->active
);
4526 DBG("UST app disabling event %s for all apps in channel "
4527 "%s for session id %" PRIu64
,
4528 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4532 /* For all registered applications */
4533 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4534 if (!app
->compatible
) {
4536 * TODO: In time, we should notice the caller of this error by
4537 * telling him that this is a version error.
4541 ua_sess
= lookup_session_by_app(usess
, app
);
4542 if (ua_sess
== NULL
) {
4547 /* Lookup channel in the ust app session */
4548 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4549 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4550 if (ua_chan_node
== NULL
) {
4551 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4552 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4555 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4557 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4558 uevent
->filter
, uevent
->attr
.loglevel
,
4560 if (ua_event
== NULL
) {
4561 DBG2("Event %s not found in channel %s for app pid %d."
4562 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4566 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4568 /* XXX: Report error someday... */
4577 /* The ua_sess lock must be held by the caller. */
4579 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4580 struct ust_app_session
*ua_sess
,
4581 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4582 struct ust_app_channel
**_ua_chan
)
4585 struct ust_app_channel
*ua_chan
= NULL
;
4588 ASSERT_LOCKED(ua_sess
->lock
);
4590 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4591 sizeof(uchan
->name
))) {
4592 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4596 struct ltt_ust_context
*uctx
= NULL
;
4599 * Create channel onto application and synchronize its
4602 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4603 LTTNG_UST_CHAN_PER_CPU
, usess
,
4609 ret
= ust_app_channel_send(app
, usess
,
4616 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4617 ret
= create_ust_app_channel_context(ua_chan
,
4630 * The application's socket is not valid. Either a bad socket
4631 * or a timeout on it. We can't inform the caller that for a
4632 * specific app, the session failed so lets continue here.
4634 ret
= 0; /* Not an error. */
4642 if (ret
== 0 && _ua_chan
) {
4644 * Only return the application's channel on success. Note
4645 * that the channel can still be part of the application's
4646 * channel hashtable on error.
4648 *_ua_chan
= ua_chan
;
4654 * Enable event for a specific session and channel on the tracer.
4656 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4657 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4660 struct lttng_ht_iter iter
, uiter
;
4661 struct lttng_ht_node_str
*ua_chan_node
;
4662 struct ust_app
*app
;
4663 struct ust_app_session
*ua_sess
;
4664 struct ust_app_channel
*ua_chan
;
4665 struct ust_app_event
*ua_event
;
4667 assert(usess
->active
);
4668 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4669 uevent
->attr
.name
, usess
->id
);
4672 * NOTE: At this point, this function is called only if the session and
4673 * channel passed are already created for all apps. and enabled on the
4679 /* For all registered applications */
4680 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4681 if (!app
->compatible
) {
4683 * TODO: In time, we should notice the caller of this error by
4684 * telling him that this is a version error.
4688 ua_sess
= lookup_session_by_app(usess
, app
);
4690 /* The application has problem or is probably dead. */
4694 pthread_mutex_lock(&ua_sess
->lock
);
4696 if (ua_sess
->deleted
) {
4697 pthread_mutex_unlock(&ua_sess
->lock
);
4701 /* Lookup channel in the ust app session */
4702 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4703 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4705 * It is possible that the channel cannot be found is
4706 * the channel/event creation occurs concurrently with
4707 * an application exit.
4709 if (!ua_chan_node
) {
4710 pthread_mutex_unlock(&ua_sess
->lock
);
4714 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4716 /* Get event node */
4717 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4718 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4719 if (ua_event
== NULL
) {
4720 DBG3("UST app enable event %s not found for app PID %d."
4721 "Skipping app", uevent
->attr
.name
, app
->pid
);
4725 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4727 pthread_mutex_unlock(&ua_sess
->lock
);
4731 pthread_mutex_unlock(&ua_sess
->lock
);
4740 * For a specific existing UST session and UST channel, creates the event for
4741 * all registered apps.
4743 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4744 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4747 struct lttng_ht_iter iter
, uiter
;
4748 struct lttng_ht_node_str
*ua_chan_node
;
4749 struct ust_app
*app
;
4750 struct ust_app_session
*ua_sess
;
4751 struct ust_app_channel
*ua_chan
;
4753 assert(usess
->active
);
4754 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4755 uevent
->attr
.name
, usess
->id
);
4759 /* For all registered applications */
4760 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4761 if (!app
->compatible
) {
4763 * TODO: In time, we should notice the caller of this error by
4764 * telling him that this is a version error.
4768 ua_sess
= lookup_session_by_app(usess
, app
);
4770 /* The application has problem or is probably dead. */
4774 pthread_mutex_lock(&ua_sess
->lock
);
4776 if (ua_sess
->deleted
) {
4777 pthread_mutex_unlock(&ua_sess
->lock
);
4781 /* Lookup channel in the ust app session */
4782 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4783 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4784 /* If the channel is not found, there is a code flow error */
4785 assert(ua_chan_node
);
4787 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4789 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4790 pthread_mutex_unlock(&ua_sess
->lock
);
4792 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4793 /* Possible value at this point: -ENOMEM. If so, we stop! */
4796 DBG2("UST app event %s already exist on app PID %d",
4797 uevent
->attr
.name
, app
->pid
);
4807 * Start tracing for a specific UST session and app.
4809 * Called with UST app session lock held.
4813 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4816 struct ust_app_session
*ua_sess
;
4818 DBG("Starting tracing for ust app pid %d", app
->pid
);
4822 if (!app
->compatible
) {
4826 ua_sess
= lookup_session_by_app(usess
, app
);
4827 if (ua_sess
== NULL
) {
4828 /* The session is in teardown process. Ignore and continue. */
4832 pthread_mutex_lock(&ua_sess
->lock
);
4834 if (ua_sess
->deleted
) {
4835 pthread_mutex_unlock(&ua_sess
->lock
);
4839 if (ua_sess
->enabled
) {
4840 pthread_mutex_unlock(&ua_sess
->lock
);
4844 /* Upon restart, we skip the setup, already done */
4845 if (ua_sess
->started
) {
4850 * Create the metadata for the application. This returns gracefully if a
4851 * metadata was already set for the session.
4853 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4858 health_code_update();
4861 /* This starts the UST tracing */
4862 pthread_mutex_lock(&app
->sock_lock
);
4863 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4864 pthread_mutex_unlock(&app
->sock_lock
);
4866 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4867 ERR("Error starting tracing for app pid: %d (ret: %d)",
4870 DBG("UST app start session failed. Application is dead.");
4872 * This is normal behavior, an application can die during the
4873 * creation process. Don't report an error so the execution can
4874 * continue normally.
4876 pthread_mutex_unlock(&ua_sess
->lock
);
4882 /* Indicate that the session has been started once */
4883 ua_sess
->started
= 1;
4884 ua_sess
->enabled
= 1;
4886 pthread_mutex_unlock(&ua_sess
->lock
);
4888 health_code_update();
4890 /* Quiescent wait after starting trace */
4891 pthread_mutex_lock(&app
->sock_lock
);
4892 ret
= ustctl_wait_quiescent(app
->sock
);
4893 pthread_mutex_unlock(&app
->sock_lock
);
4894 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4895 ERR("UST app wait quiescent failed for app pid %d ret %d",
4901 health_code_update();
4905 pthread_mutex_unlock(&ua_sess
->lock
);
4907 health_code_update();
4912 * Stop tracing for a specific UST session and app.
4915 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4918 struct ust_app_session
*ua_sess
;
4919 struct ust_registry_session
*registry
;
4921 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4925 if (!app
->compatible
) {
4926 goto end_no_session
;
4929 ua_sess
= lookup_session_by_app(usess
, app
);
4930 if (ua_sess
== NULL
) {
4931 goto end_no_session
;
4934 pthread_mutex_lock(&ua_sess
->lock
);
4936 if (ua_sess
->deleted
) {
4937 pthread_mutex_unlock(&ua_sess
->lock
);
4938 goto end_no_session
;
4942 * If started = 0, it means that stop trace has been called for a session
4943 * that was never started. It's possible since we can have a fail start
4944 * from either the application manager thread or the command thread. Simply
4945 * indicate that this is a stop error.
4947 if (!ua_sess
->started
) {
4948 goto error_rcu_unlock
;
4951 health_code_update();
4953 /* This inhibits UST tracing */
4954 pthread_mutex_lock(&app
->sock_lock
);
4955 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4956 pthread_mutex_unlock(&app
->sock_lock
);
4958 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4959 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4962 DBG("UST app stop session failed. Application is dead.");
4964 * This is normal behavior, an application can die during the
4965 * creation process. Don't report an error so the execution can
4966 * continue normally.
4970 goto error_rcu_unlock
;
4973 health_code_update();
4974 ua_sess
->enabled
= 0;
4976 /* Quiescent wait after stopping trace */
4977 pthread_mutex_lock(&app
->sock_lock
);
4978 ret
= ustctl_wait_quiescent(app
->sock
);
4979 pthread_mutex_unlock(&app
->sock_lock
);
4980 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4981 ERR("UST app wait quiescent failed for app pid %d ret %d",
4985 health_code_update();
4987 registry
= get_session_registry(ua_sess
);
4989 /* The UST app session is held registry shall not be null. */
4992 /* Push metadata for application before freeing the application. */
4993 (void) push_metadata(registry
, ua_sess
->consumer
);
4996 pthread_mutex_unlock(&ua_sess
->lock
);
4999 health_code_update();
5003 pthread_mutex_unlock(&ua_sess
->lock
);
5005 health_code_update();
5010 int ust_app_flush_app_session(struct ust_app
*app
,
5011 struct ust_app_session
*ua_sess
)
5013 int ret
, retval
= 0;
5014 struct lttng_ht_iter iter
;
5015 struct ust_app_channel
*ua_chan
;
5016 struct consumer_socket
*socket
;
5018 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5022 if (!app
->compatible
) {
5023 goto end_not_compatible
;
5026 pthread_mutex_lock(&ua_sess
->lock
);
5028 if (ua_sess
->deleted
) {
5032 health_code_update();
5034 /* Flushing buffers */
5035 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5038 /* Flush buffers and push metadata. */
5039 switch (ua_sess
->buffer_type
) {
5040 case LTTNG_BUFFER_PER_PID
:
5041 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5043 health_code_update();
5044 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5046 ERR("Error flushing consumer channel");
5052 case LTTNG_BUFFER_PER_UID
:
5058 health_code_update();
5061 pthread_mutex_unlock(&ua_sess
->lock
);
5065 health_code_update();
5070 * Flush buffers for all applications for a specific UST session.
5071 * Called with UST session lock held.
5074 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5079 DBG("Flushing session buffers for all ust apps");
5083 /* Flush buffers and push metadata. */
5084 switch (usess
->buffer_type
) {
5085 case LTTNG_BUFFER_PER_UID
:
5087 struct buffer_reg_uid
*reg
;
5088 struct lttng_ht_iter iter
;
5090 /* Flush all per UID buffers associated to that session. */
5091 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5092 struct ust_registry_session
*ust_session_reg
;
5093 struct buffer_reg_channel
*reg_chan
;
5094 struct consumer_socket
*socket
;
5096 /* Get consumer socket to use to push the metadata.*/
5097 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5100 /* Ignore request if no consumer is found for the session. */
5104 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5105 reg_chan
, node
.node
) {
5107 * The following call will print error values so the return
5108 * code is of little importance because whatever happens, we
5109 * have to try them all.
5111 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
5114 ust_session_reg
= reg
->registry
->reg
.ust
;
5115 /* Push metadata. */
5116 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5120 case LTTNG_BUFFER_PER_PID
:
5122 struct ust_app_session
*ua_sess
;
5123 struct lttng_ht_iter iter
;
5124 struct ust_app
*app
;
5126 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5127 ua_sess
= lookup_session_by_app(usess
, app
);
5128 if (ua_sess
== NULL
) {
5131 (void) ust_app_flush_app_session(app
, ua_sess
);
5142 health_code_update();
5147 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5148 struct ust_app_session
*ua_sess
)
5151 struct lttng_ht_iter iter
;
5152 struct ust_app_channel
*ua_chan
;
5153 struct consumer_socket
*socket
;
5155 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5159 if (!app
->compatible
) {
5160 goto end_not_compatible
;
5163 pthread_mutex_lock(&ua_sess
->lock
);
5165 if (ua_sess
->deleted
) {
5169 health_code_update();
5171 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5174 ERR("Failed to find consumer (%" PRIu32
") socket",
5175 app
->bits_per_long
);
5180 /* Clear quiescent state. */
5181 switch (ua_sess
->buffer_type
) {
5182 case LTTNG_BUFFER_PER_PID
:
5183 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5184 ua_chan
, node
.node
) {
5185 health_code_update();
5186 ret
= consumer_clear_quiescent_channel(socket
,
5189 ERR("Error clearing quiescent state for consumer channel");
5195 case LTTNG_BUFFER_PER_UID
:
5202 health_code_update();
5205 pthread_mutex_unlock(&ua_sess
->lock
);
5209 health_code_update();
5214 * Clear quiescent state in each stream for all applications for a
5215 * specific UST session.
5216 * Called with UST session lock held.
5219 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5224 DBG("Clearing stream quiescent state for all ust apps");
5228 switch (usess
->buffer_type
) {
5229 case LTTNG_BUFFER_PER_UID
:
5231 struct lttng_ht_iter iter
;
5232 struct buffer_reg_uid
*reg
;
5235 * Clear quiescent for all per UID buffers associated to
5238 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5239 struct consumer_socket
*socket
;
5240 struct buffer_reg_channel
*reg_chan
;
5242 /* Get associated consumer socket.*/
5243 socket
= consumer_find_socket_by_bitness(
5244 reg
->bits_per_long
, usess
->consumer
);
5247 * Ignore request if no consumer is found for
5253 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5254 &iter
.iter
, reg_chan
, node
.node
) {
5256 * The following call will print error values so
5257 * the return code is of little importance
5258 * because whatever happens, we have to try them
5261 (void) consumer_clear_quiescent_channel(socket
,
5262 reg_chan
->consumer_key
);
5267 case LTTNG_BUFFER_PER_PID
:
5269 struct ust_app_session
*ua_sess
;
5270 struct lttng_ht_iter iter
;
5271 struct ust_app
*app
;
5273 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5275 ua_sess
= lookup_session_by_app(usess
, app
);
5276 if (ua_sess
== NULL
) {
5279 (void) ust_app_clear_quiescent_app_session(app
,
5291 health_code_update();
5296 * Destroy a specific UST session in apps.
5298 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5301 struct ust_app_session
*ua_sess
;
5302 struct lttng_ht_iter iter
;
5303 struct lttng_ht_node_u64
*node
;
5305 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5309 if (!app
->compatible
) {
5313 __lookup_session_by_app(usess
, app
, &iter
);
5314 node
= lttng_ht_iter_get_node_u64(&iter
);
5316 /* Session is being or is deleted. */
5319 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5321 health_code_update();
5322 destroy_app_session(app
, ua_sess
);
5324 health_code_update();
5326 /* Quiescent wait after stopping trace */
5327 pthread_mutex_lock(&app
->sock_lock
);
5328 ret
= ustctl_wait_quiescent(app
->sock
);
5329 pthread_mutex_unlock(&app
->sock_lock
);
5330 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5331 ERR("UST app wait quiescent failed for app pid %d ret %d",
5336 health_code_update();
5341 * Start tracing for the UST session.
5343 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5345 struct lttng_ht_iter iter
;
5346 struct ust_app
*app
;
5348 DBG("Starting all UST traces");
5351 * Even though the start trace might fail, flag this session active so
5352 * other application coming in are started by default.
5359 * In a start-stop-start use-case, we need to clear the quiescent state
5360 * of each channel set by the prior stop command, thus ensuring that a
5361 * following stop or destroy is sure to grab a timestamp_end near those
5362 * operations, even if the packet is empty.
5364 (void) ust_app_clear_quiescent_session(usess
);
5366 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5367 ust_app_global_update(usess
, app
);
5376 * Start tracing for the UST session.
5377 * Called with UST session lock held.
5379 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5382 struct lttng_ht_iter iter
;
5383 struct ust_app
*app
;
5385 DBG("Stopping all UST traces");
5388 * Even though the stop trace might fail, flag this session inactive so
5389 * other application coming in are not started by default.
5395 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5396 ret
= ust_app_stop_trace(usess
, app
);
5398 /* Continue to next apps even on error */
5403 (void) ust_app_flush_session(usess
);
5411 * Destroy app UST session.
5413 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5416 struct lttng_ht_iter iter
;
5417 struct ust_app
*app
;
5419 DBG("Destroy all UST traces");
5423 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5424 ret
= destroy_trace(usess
, app
);
5426 /* Continue to next apps even on error */
5436 /* The ua_sess lock must be held by the caller. */
5438 int find_or_create_ust_app_channel(
5439 struct ltt_ust_session
*usess
,
5440 struct ust_app_session
*ua_sess
,
5441 struct ust_app
*app
,
5442 struct ltt_ust_channel
*uchan
,
5443 struct ust_app_channel
**ua_chan
)
5446 struct lttng_ht_iter iter
;
5447 struct lttng_ht_node_str
*ua_chan_node
;
5449 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5450 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5452 *ua_chan
= caa_container_of(ua_chan_node
,
5453 struct ust_app_channel
, node
);
5457 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5466 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5467 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5468 struct ust_app
*app
)
5471 struct ust_app_event
*ua_event
= NULL
;
5473 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5474 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5476 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5481 if (ua_event
->enabled
!= uevent
->enabled
) {
5482 ret
= uevent
->enabled
?
5483 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5484 disable_ust_app_event(ua_sess
, ua_event
, app
);
5493 void ust_app_synchronize_tokens(struct ust_app
*app
)
5496 enum lttng_error_code ret_code
;
5497 enum lttng_trigger_status t_status
;
5498 struct lttng_ht_iter app_trigger_iter
;
5499 struct lttng_triggers
*triggers
;
5500 struct ust_app_token_event_rule
*token_event_rule_element
;
5504 /* TODO: is this necessary to protect against new trigger being added ?
5505 * notification_trigger_tokens_ht is still the backing data structure
5506 * for this listing. Leave it there for now.
5508 pthread_mutex_lock(¬ification_trigger_tokens_ht_lock
);
5509 ret_code
= notification_thread_command_get_tokens(
5510 notification_thread_handle
, &triggers
);
5511 if (ret_code
!= LTTNG_OK
) {
5518 t_status
= lttng_triggers_get_count(triggers
, &count
);
5519 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5524 for (unsigned int i
= 0; i
< count
; i
++) {
5525 struct lttng_condition
*condition
;
5526 struct lttng_event_rule
*event_rule
;
5527 struct lttng_trigger
*trigger
;
5528 struct ust_app_token_event_rule
*ua_token
;
5531 trigger
= lttng_triggers_get_pointer_of_index(triggers
, i
);
5534 /* TODO: error checking and type checking */
5535 token
= lttng_trigger_get_tracer_token(trigger
);
5536 condition
= lttng_trigger_get_condition(trigger
);
5537 (void) lttng_condition_event_rule_get_rule_mutable(condition
, &event_rule
);
5539 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5540 /* Skip kernel related trigger */
5544 /* Iterate over all known token trigger */
5545 ua_token
= find_ust_app_token_event_rule(app
->tokens_ht
, token
);
5547 ret
= create_ust_app_token_event_rule(trigger
, app
);
5554 /* Remove all unknown trigger from the app
5555 * TODO find a way better way then this, do it on the unregister command
5556 * and be specific on the token to remove instead of going over all
5557 * trigger known to the app. This is sub optimal.
5559 cds_lfht_for_each_entry (app
->tokens_ht
->ht
, &app_trigger_iter
.iter
,
5560 token_event_rule_element
, node
.node
) {
5564 token
= token_event_rule_element
->token
;
5567 * Check if the app event trigger still exists on the
5568 * notification side.
5569 * TODO: might want to change the backing data struct of the
5570 * lttng_triggers object to allow quick lookup?
5571 * For kernel mostly all of this can be removed once we delete
5572 * on a per trigger basis.
5575 for (unsigned int i
= 0; i
< count
; i
++) {
5576 struct lttng_trigger
*trigger
;
5577 uint64_t inner_token
;
5579 trigger
= lttng_triggers_get_pointer_of_index(
5583 inner_token
= lttng_trigger_get_tracer_token(trigger
);
5585 if (inner_token
== token
) {
5596 /* TODO: This is fucking ugly API for fuck sake */
5597 assert(!lttng_ht_del(app
->tokens_ht
, &app_trigger_iter
));
5599 (void) disable_ust_object(app
, token_event_rule_element
->obj
);
5601 delete_ust_app_token_event_rule(app
->sock
, token_event_rule_element
, app
);
5604 lttng_triggers_destroy(triggers
);
5606 pthread_mutex_unlock(¬ification_trigger_tokens_ht_lock
);
5611 * The caller must ensure that the application is compatible and is tracked
5612 * by the process attribute trackers.
5615 void ust_app_synchronize(struct ltt_ust_session
*usess
,
5616 struct ust_app
*app
)
5619 struct cds_lfht_iter uchan_iter
;
5620 struct ltt_ust_channel
*uchan
;
5621 struct ust_app_session
*ua_sess
= NULL
;
5624 * The application's configuration should only be synchronized for
5627 assert(usess
->active
);
5629 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
5631 /* Tracer is probably gone or ENOMEM. */
5636 pthread_mutex_lock(&ua_sess
->lock
);
5637 if (ua_sess
->deleted
) {
5638 pthread_mutex_unlock(&ua_sess
->lock
);
5643 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5645 struct ust_app_channel
*ua_chan
;
5646 struct cds_lfht_iter uevent_iter
;
5647 struct ltt_ust_event
*uevent
;
5650 * Search for a matching ust_app_channel. If none is found,
5651 * create it. Creating the channel will cause the ua_chan
5652 * structure to be allocated, the channel buffers to be
5653 * allocated (if necessary) and sent to the application, and
5654 * all enabled contexts will be added to the channel.
5656 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5657 app
, uchan
, &ua_chan
);
5659 /* Tracer is probably gone or ENOMEM. */
5664 /* ua_chan will be NULL for the metadata channel */
5668 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5670 ret
= ust_app_channel_synchronize_event(ua_chan
,
5671 uevent
, ua_sess
, app
);
5677 if (ua_chan
->enabled
!= uchan
->enabled
) {
5678 ret
= uchan
->enabled
?
5679 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5680 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
5689 pthread_mutex_unlock(&ua_sess
->lock
);
5690 /* Everything went well at this point. */
5695 pthread_mutex_unlock(&ua_sess
->lock
);
5698 destroy_app_session(app
, ua_sess
);
5704 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5706 struct ust_app_session
*ua_sess
;
5708 ua_sess
= lookup_session_by_app(usess
, app
);
5709 if (ua_sess
== NULL
) {
5712 destroy_app_session(app
, ua_sess
);
5716 * Add channels/events from UST global domain to registered apps at sock.
5718 * Called with session lock held.
5719 * Called with RCU read-side lock held.
5721 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5724 assert(usess
->active
);
5726 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
5727 app
->sock
, usess
->id
);
5729 if (!app
->compatible
) {
5732 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
5734 trace_ust_id_tracker_lookup(
5735 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
5737 trace_ust_id_tracker_lookup(
5738 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
5741 * Synchronize the application's internal tracing configuration
5742 * and start tracing.
5744 ust_app_synchronize(usess
, app
);
5745 ust_app_start_trace(usess
, app
);
5747 ust_app_global_destroy(usess
, app
);
5751 void ust_app_global_update_tokens(struct ust_app
*app
)
5753 DBG2("UST app global update token for app sock %d", app
->sock
);
5755 if (!app
->compatible
) {
5758 if (app
->token_communication
.handle
== NULL
) {
5759 WARN("UST app global update token for app sock %d skipped since communcation handle is null", app
->sock
);
5763 ust_app_synchronize_tokens(app
);
5767 * Called with session lock held.
5769 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
5771 struct lttng_ht_iter iter
;
5772 struct ust_app
*app
;
5775 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5776 ust_app_global_update(usess
, app
);
5781 void ust_app_global_update_all_tokens(void)
5783 struct lttng_ht_iter iter
;
5784 struct ust_app
*app
;
5787 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5788 ust_app_global_update_tokens(app
);
5793 void ust_app_update_trigger_error_count(struct lttng_trigger
*trigger
)
5795 uint64_t error_count
= 0;
5796 enum trigger_error_accounting_status status
;
5798 status
= trigger_error_accounting_get_count(trigger
, &error_count
);
5799 if (status
!= TRIGGER_ERROR_ACCOUNTING_STATUS_OK
) {
5800 ERR("Error getting trigger error count");
5803 lttng_trigger_set_error_count(trigger
, error_count
);
5807 * Add context to a specific channel for global UST domain.
5809 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
5810 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
5813 struct lttng_ht_node_str
*ua_chan_node
;
5814 struct lttng_ht_iter iter
, uiter
;
5815 struct ust_app_channel
*ua_chan
= NULL
;
5816 struct ust_app_session
*ua_sess
;
5817 struct ust_app
*app
;
5819 assert(usess
->active
);
5822 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5823 if (!app
->compatible
) {
5825 * TODO: In time, we should notice the caller of this error by
5826 * telling him that this is a version error.
5830 ua_sess
= lookup_session_by_app(usess
, app
);
5831 if (ua_sess
== NULL
) {
5835 pthread_mutex_lock(&ua_sess
->lock
);
5837 if (ua_sess
->deleted
) {
5838 pthread_mutex_unlock(&ua_sess
->lock
);
5842 /* Lookup channel in the ust app session */
5843 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5844 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5845 if (ua_chan_node
== NULL
) {
5848 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
5850 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
5855 pthread_mutex_unlock(&ua_sess
->lock
);
5863 * Receive registration and populate the given msg structure.
5865 * On success return 0 else a negative value returned by the ustctl call.
5867 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5870 uint32_t pid
, ppid
, uid
, gid
;
5874 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5875 &pid
, &ppid
, &uid
, &gid
,
5876 &msg
->bits_per_long
,
5877 &msg
->uint8_t_alignment
,
5878 &msg
->uint16_t_alignment
,
5879 &msg
->uint32_t_alignment
,
5880 &msg
->uint64_t_alignment
,
5881 &msg
->long_alignment
,
5888 case LTTNG_UST_ERR_EXITING
:
5889 DBG3("UST app recv reg message failed. Application died");
5891 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5892 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5893 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5894 LTTNG_UST_ABI_MINOR_VERSION
);
5897 ERR("UST app recv reg message failed with ret %d", ret
);
5902 msg
->pid
= (pid_t
) pid
;
5903 msg
->ppid
= (pid_t
) ppid
;
5904 msg
->uid
= (uid_t
) uid
;
5905 msg
->gid
= (gid_t
) gid
;
5912 * Return a ust app session object using the application object and the
5913 * session object descriptor has a key. If not found, NULL is returned.
5914 * A RCU read side lock MUST be acquired when calling this function.
5916 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5919 struct lttng_ht_node_ulong
*node
;
5920 struct lttng_ht_iter iter
;
5921 struct ust_app_session
*ua_sess
= NULL
;
5925 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5926 node
= lttng_ht_iter_get_node_ulong(&iter
);
5928 DBG2("UST app session find by objd %d not found", objd
);
5932 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5939 * Return a ust app channel object using the application object and the channel
5940 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5941 * lock MUST be acquired before calling this function.
5943 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5946 struct lttng_ht_node_ulong
*node
;
5947 struct lttng_ht_iter iter
;
5948 struct ust_app_channel
*ua_chan
= NULL
;
5952 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5953 node
= lttng_ht_iter_get_node_ulong(&iter
);
5955 DBG2("UST app channel find by objd %d not found", objd
);
5959 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5966 * Reply to a register channel notification from an application on the notify
5967 * socket. The channel metadata is also created.
5969 * The session UST registry lock is acquired in this function.
5971 * On success 0 is returned else a negative value.
5973 static int reply_ust_register_channel(int sock
, int cobjd
,
5974 size_t nr_fields
, struct ustctl_field
*fields
)
5976 int ret
, ret_code
= 0;
5978 uint64_t chan_reg_key
;
5979 enum ustctl_channel_header type
;
5980 struct ust_app
*app
;
5981 struct ust_app_channel
*ua_chan
;
5982 struct ust_app_session
*ua_sess
;
5983 struct ust_registry_session
*registry
;
5984 struct ust_registry_channel
*chan_reg
;
5988 /* Lookup application. If not found, there is a code flow error. */
5989 app
= find_app_by_notify_sock(sock
);
5991 DBG("Application socket %d is being torn down. Abort event notify",
5994 goto error_rcu_unlock
;
5997 /* Lookup channel by UST object descriptor. */
5998 ua_chan
= find_channel_by_objd(app
, cobjd
);
6000 DBG("Application channel is being torn down. Abort event notify");
6002 goto error_rcu_unlock
;
6005 assert(ua_chan
->session
);
6006 ua_sess
= ua_chan
->session
;
6008 /* Get right session registry depending on the session buffer type. */
6009 registry
= get_session_registry(ua_sess
);
6011 DBG("Application session is being torn down. Abort event notify");
6013 goto error_rcu_unlock
;
6016 /* Depending on the buffer type, a different channel key is used. */
6017 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6018 chan_reg_key
= ua_chan
->tracing_channel_id
;
6020 chan_reg_key
= ua_chan
->key
;
6023 pthread_mutex_lock(®istry
->lock
);
6025 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
6028 if (!chan_reg
->register_done
) {
6030 * TODO: eventually use the registry event count for
6031 * this channel to better guess header type for per-pid
6034 type
= USTCTL_CHANNEL_HEADER_LARGE
;
6035 chan_reg
->nr_ctx_fields
= nr_fields
;
6036 chan_reg
->ctx_fields
= fields
;
6038 chan_reg
->header_type
= type
;
6040 /* Get current already assigned values. */
6041 type
= chan_reg
->header_type
;
6043 /* Channel id is set during the object creation. */
6044 chan_id
= chan_reg
->chan_id
;
6046 /* Append to metadata */
6047 if (!chan_reg
->metadata_dumped
) {
6048 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
6050 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6056 DBG3("UST app replying to register channel key %" PRIu64
6057 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
6060 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6062 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6063 ERR("UST app reply channel failed with ret %d", ret
);
6065 DBG3("UST app reply channel failed. Application died");
6070 /* This channel registry registration is completed. */
6071 chan_reg
->register_done
= 1;
6074 pthread_mutex_unlock(®istry
->lock
);
6082 * Add event to the UST channel registry. When the event is added to the
6083 * registry, the metadata is also created. Once done, this replies to the
6084 * application with the appropriate error code.
6086 * The session UST registry lock is acquired in the function.
6088 * On success 0 is returned else a negative value.
6090 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6091 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
6092 int loglevel_value
, char *model_emf_uri
)
6095 uint32_t event_id
= 0;
6096 uint64_t chan_reg_key
;
6097 struct ust_app
*app
;
6098 struct ust_app_channel
*ua_chan
;
6099 struct ust_app_session
*ua_sess
;
6100 struct ust_registry_session
*registry
;
6104 /* Lookup application. If not found, there is a code flow error. */
6105 app
= find_app_by_notify_sock(sock
);
6107 DBG("Application socket %d is being torn down. Abort event notify",
6110 goto error_rcu_unlock
;
6113 /* Lookup channel by UST object descriptor. */
6114 ua_chan
= find_channel_by_objd(app
, cobjd
);
6116 DBG("Application channel is being torn down. Abort event notify");
6118 goto error_rcu_unlock
;
6121 assert(ua_chan
->session
);
6122 ua_sess
= ua_chan
->session
;
6124 registry
= get_session_registry(ua_sess
);
6126 DBG("Application session is being torn down. Abort event notify");
6128 goto error_rcu_unlock
;
6131 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6132 chan_reg_key
= ua_chan
->tracing_channel_id
;
6134 chan_reg_key
= ua_chan
->key
;
6137 pthread_mutex_lock(®istry
->lock
);
6140 * From this point on, this call acquires the ownership of the sig, fields
6141 * and model_emf_uri meaning any free are done inside it if needed. These
6142 * three variables MUST NOT be read/write after this.
6144 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6145 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6146 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6150 model_emf_uri
= NULL
;
6153 * The return value is returned to ustctl so in case of an error, the
6154 * application can be notified. In case of an error, it's important not to
6155 * return a negative error or else the application will get closed.
6157 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
6159 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6160 ERR("UST app reply event failed with ret %d", ret
);
6162 DBG3("UST app reply event failed. Application died");
6165 * No need to wipe the create event since the application socket will
6166 * get close on error hence cleaning up everything by itself.
6171 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6175 pthread_mutex_unlock(®istry
->lock
);
6180 free(model_emf_uri
);
6185 * Add enum to the UST session registry. Once done, this replies to the
6186 * application with the appropriate error code.
6188 * The session UST registry lock is acquired within this function.
6190 * On success 0 is returned else a negative value.
6192 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6193 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
6195 int ret
= 0, ret_code
;
6196 struct ust_app
*app
;
6197 struct ust_app_session
*ua_sess
;
6198 struct ust_registry_session
*registry
;
6199 uint64_t enum_id
= -1ULL;
6203 /* Lookup application. If not found, there is a code flow error. */
6204 app
= find_app_by_notify_sock(sock
);
6206 /* Return an error since this is not an error */
6207 DBG("Application socket %d is being torn down. Aborting enum registration",
6210 goto error_rcu_unlock
;
6213 /* Lookup session by UST object descriptor. */
6214 ua_sess
= find_session_by_objd(app
, sobjd
);
6216 /* Return an error since this is not an error */
6217 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6219 goto error_rcu_unlock
;
6222 registry
= get_session_registry(ua_sess
);
6224 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6226 goto error_rcu_unlock
;
6229 pthread_mutex_lock(®istry
->lock
);
6232 * From this point on, the callee acquires the ownership of
6233 * entries. The variable entries MUST NOT be read/written after
6236 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6237 entries
, nr_entries
, &enum_id
);
6241 * The return value is returned to ustctl so in case of an error, the
6242 * application can be notified. In case of an error, it's important not to
6243 * return a negative error or else the application will get closed.
6245 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
6247 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6248 ERR("UST app reply enum failed with ret %d", ret
);
6250 DBG3("UST app reply enum failed. Application died");
6253 * No need to wipe the create enum since the application socket will
6254 * get close on error hence cleaning up everything by itself.
6259 DBG3("UST registry enum %s added successfully or already found", name
);
6262 pthread_mutex_unlock(®istry
->lock
);
6269 * Handle application notification through the given notify socket.
6271 * Return 0 on success or else a negative value.
6273 int ust_app_recv_notify(int sock
)
6276 enum ustctl_notify_cmd cmd
;
6278 DBG3("UST app receiving notify from sock %d", sock
);
6280 ret
= ustctl_recv_notify(sock
, &cmd
);
6282 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6283 ERR("UST app recv notify failed with ret %d", ret
);
6285 DBG3("UST app recv notify failed. Application died");
6291 case USTCTL_NOTIFY_CMD_EVENT
:
6293 int sobjd
, cobjd
, loglevel_value
;
6294 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6296 struct ustctl_field
*fields
;
6298 DBG2("UST app ustctl register event received");
6300 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6301 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6304 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6305 ERR("UST app recv event failed with ret %d", ret
);
6307 DBG3("UST app recv event failed. Application died");
6313 * Add event to the UST registry coming from the notify socket. This
6314 * call will free if needed the sig, fields and model_emf_uri. This
6315 * code path loses the ownsership of these variables and transfer them
6316 * to the this function.
6318 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6319 fields
, loglevel_value
, model_emf_uri
);
6326 case USTCTL_NOTIFY_CMD_CHANNEL
:
6330 struct ustctl_field
*fields
;
6332 DBG2("UST app ustctl register channel received");
6334 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6337 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6338 ERR("UST app recv channel failed with ret %d", ret
);
6340 DBG3("UST app recv channel failed. Application died");
6346 * The fields ownership are transfered to this function call meaning
6347 * that if needed it will be freed. After this, it's invalid to access
6348 * fields or clean it up.
6350 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6358 case USTCTL_NOTIFY_CMD_ENUM
:
6361 char name
[LTTNG_UST_SYM_NAME_LEN
];
6363 struct ustctl_enum_entry
*entries
;
6365 DBG2("UST app ustctl register enum received");
6367 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
6368 &entries
, &nr_entries
);
6370 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
6371 ERR("UST app recv enum failed with ret %d", ret
);
6373 DBG3("UST app recv enum failed. Application died");
6378 /* Callee assumes ownership of entries */
6379 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6380 entries
, nr_entries
);
6388 /* Should NEVER happen. */
6397 * Once the notify socket hangs up, this is called. First, it tries to find the
6398 * corresponding application. On failure, the call_rcu to close the socket is
6399 * executed. If an application is found, it tries to delete it from the notify
6400 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6402 * Note that an object needs to be allocated here so on ENOMEM failure, the
6403 * call RCU is not done but the rest of the cleanup is.
6405 void ust_app_notify_sock_unregister(int sock
)
6408 struct lttng_ht_iter iter
;
6409 struct ust_app
*app
;
6410 struct ust_app_notify_sock_obj
*obj
;
6416 obj
= zmalloc(sizeof(*obj
));
6419 * An ENOMEM is kind of uncool. If this strikes we continue the
6420 * procedure but the call_rcu will not be called. In this case, we
6421 * accept the fd leak rather than possibly creating an unsynchronized
6422 * state between threads.
6424 * TODO: The notify object should be created once the notify socket is
6425 * registered and stored independantely from the ust app object. The
6426 * tricky part is to synchronize the teardown of the application and
6427 * this notify object. Let's keep that in mind so we can avoid this
6428 * kind of shenanigans with ENOMEM in the teardown path.
6435 DBG("UST app notify socket unregister %d", sock
);
6438 * Lookup application by notify socket. If this fails, this means that the
6439 * hash table delete has already been done by the application
6440 * unregistration process so we can safely close the notify socket in a
6443 app
= find_app_by_notify_sock(sock
);
6448 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6451 * Whatever happens here either we fail or succeed, in both cases we have
6452 * to close the socket after a grace period to continue to the call RCU
6453 * here. If the deletion is successful, the application is not visible
6454 * anymore by other threads and is it fails it means that it was already
6455 * deleted from the hash table so either way we just have to close the
6458 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6464 * Close socket after a grace period to avoid for the socket to be reused
6465 * before the application object is freed creating potential race between
6466 * threads trying to add unique in the global hash table.
6469 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6474 * Destroy a ust app data structure and free its memory.
6476 void ust_app_destroy(struct ust_app
*app
)
6482 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6486 * Take a snapshot for a given UST session. The snapshot is sent to the given
6489 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6491 enum lttng_error_code
ust_app_snapshot_record(
6492 const struct ltt_ust_session
*usess
,
6493 const struct consumer_output
*output
, int wait
,
6494 uint64_t nb_packets_per_stream
)
6497 enum lttng_error_code status
= LTTNG_OK
;
6498 struct lttng_ht_iter iter
;
6499 struct ust_app
*app
;
6500 char *trace_path
= NULL
;
6507 switch (usess
->buffer_type
) {
6508 case LTTNG_BUFFER_PER_UID
:
6510 struct buffer_reg_uid
*reg
;
6512 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6513 struct buffer_reg_channel
*reg_chan
;
6514 struct consumer_socket
*socket
;
6515 char pathname
[PATH_MAX
];
6516 size_t consumer_path_offset
= 0;
6518 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6519 /* Skip since no metadata is present */
6523 /* Get consumer socket to use to push the metadata.*/
6524 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6527 status
= LTTNG_ERR_INVALID
;
6531 memset(pathname
, 0, sizeof(pathname
));
6532 ret
= snprintf(pathname
, sizeof(pathname
),
6533 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
6534 reg
->uid
, reg
->bits_per_long
);
6536 PERROR("snprintf snapshot path");
6537 status
= LTTNG_ERR_INVALID
;
6540 /* Free path allowed on previous iteration. */
6542 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6543 &consumer_path_offset
);
6545 status
= LTTNG_ERR_INVALID
;
6548 /* Add the UST default trace dir to path. */
6549 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6550 reg_chan
, node
.node
) {
6551 status
= consumer_snapshot_channel(socket
,
6552 reg_chan
->consumer_key
,
6553 output
, 0, usess
->uid
,
6554 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6555 nb_packets_per_stream
);
6556 if (status
!= LTTNG_OK
) {
6560 status
= consumer_snapshot_channel(socket
,
6561 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6562 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6564 if (status
!= LTTNG_OK
) {
6570 case LTTNG_BUFFER_PER_PID
:
6572 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6573 struct consumer_socket
*socket
;
6574 struct lttng_ht_iter chan_iter
;
6575 struct ust_app_channel
*ua_chan
;
6576 struct ust_app_session
*ua_sess
;
6577 struct ust_registry_session
*registry
;
6578 char pathname
[PATH_MAX
];
6579 size_t consumer_path_offset
= 0;
6581 ua_sess
= lookup_session_by_app(usess
, app
);
6583 /* Session not associated with this app. */
6587 /* Get the right consumer socket for the application. */
6588 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6591 status
= LTTNG_ERR_INVALID
;
6595 /* Add the UST default trace dir to path. */
6596 memset(pathname
, 0, sizeof(pathname
));
6597 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
6600 status
= LTTNG_ERR_INVALID
;
6601 PERROR("snprintf snapshot path");
6604 /* Free path allowed on previous iteration. */
6606 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6607 &consumer_path_offset
);
6609 status
= LTTNG_ERR_INVALID
;
6612 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6613 ua_chan
, node
.node
) {
6614 status
= consumer_snapshot_channel(socket
,
6615 ua_chan
->key
, output
, 0,
6616 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6617 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6618 &trace_path
[consumer_path_offset
], wait
,
6619 nb_packets_per_stream
);
6623 case LTTNG_ERR_CHAN_NOT_FOUND
:
6630 registry
= get_session_registry(ua_sess
);
6632 DBG("Application session is being torn down. Skip application.");
6635 status
= consumer_snapshot_channel(socket
,
6636 registry
->metadata_key
, output
, 1,
6637 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6638 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6639 &trace_path
[consumer_path_offset
], wait
, 0);
6643 case LTTNG_ERR_CHAN_NOT_FOUND
:
6663 * Return the size taken by one more packet per stream.
6665 uint64_t ust_app_get_size_one_more_packet_per_stream(
6666 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
6668 uint64_t tot_size
= 0;
6669 struct ust_app
*app
;
6670 struct lttng_ht_iter iter
;
6674 switch (usess
->buffer_type
) {
6675 case LTTNG_BUFFER_PER_UID
:
6677 struct buffer_reg_uid
*reg
;
6679 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6680 struct buffer_reg_channel
*reg_chan
;
6683 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6684 reg_chan
, node
.node
) {
6685 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
6687 * Don't take channel into account if we
6688 * already grab all its packets.
6692 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
6698 case LTTNG_BUFFER_PER_PID
:
6701 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6702 struct ust_app_channel
*ua_chan
;
6703 struct ust_app_session
*ua_sess
;
6704 struct lttng_ht_iter chan_iter
;
6706 ua_sess
= lookup_session_by_app(usess
, app
);
6708 /* Session not associated with this app. */
6712 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6713 ua_chan
, node
.node
) {
6714 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
6716 * Don't take channel into account if we
6717 * already grab all its packets.
6721 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
6735 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
6736 struct cds_list_head
*buffer_reg_uid_list
,
6737 struct consumer_output
*consumer
, uint64_t uchan_id
,
6738 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
6741 uint64_t consumer_chan_key
;
6746 ret
= buffer_reg_uid_consumer_channel_key(
6747 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
6755 ret
= consumer_get_lost_packets(ust_session_id
,
6756 consumer_chan_key
, consumer
, lost
);
6758 ret
= consumer_get_discarded_events(ust_session_id
,
6759 consumer_chan_key
, consumer
, discarded
);
6766 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
6767 struct ltt_ust_channel
*uchan
,
6768 struct consumer_output
*consumer
, int overwrite
,
6769 uint64_t *discarded
, uint64_t *lost
)
6772 struct lttng_ht_iter iter
;
6773 struct lttng_ht_node_str
*ua_chan_node
;
6774 struct ust_app
*app
;
6775 struct ust_app_session
*ua_sess
;
6776 struct ust_app_channel
*ua_chan
;
6783 * Iterate over every registered applications. Sum counters for
6784 * all applications containing requested session and channel.
6786 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6787 struct lttng_ht_iter uiter
;
6789 ua_sess
= lookup_session_by_app(usess
, app
);
6790 if (ua_sess
== NULL
) {
6795 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
6796 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6797 /* If the session is found for the app, the channel must be there */
6798 assert(ua_chan_node
);
6800 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
6805 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
6812 uint64_t _discarded
;
6814 ret
= consumer_get_discarded_events(usess
->id
,
6815 ua_chan
->key
, consumer
, &_discarded
);
6819 (*discarded
) += _discarded
;
6828 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
6829 struct ust_app
*app
)
6832 struct ust_app_session
*ua_sess
;
6834 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
6838 ua_sess
= lookup_session_by_app(usess
, app
);
6839 if (ua_sess
== NULL
) {
6840 /* The session is in teardown process. Ignore and continue. */
6844 pthread_mutex_lock(&ua_sess
->lock
);
6846 if (ua_sess
->deleted
) {
6850 pthread_mutex_lock(&app
->sock_lock
);
6851 ret
= ustctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
6852 pthread_mutex_unlock(&app
->sock_lock
);
6855 pthread_mutex_unlock(&ua_sess
->lock
);
6859 health_code_update();
6864 * Regenerate the statedump for each app in the session.
6866 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
6869 struct lttng_ht_iter iter
;
6870 struct ust_app
*app
;
6872 DBG("Regenerating the metadata for all UST apps");
6876 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6877 if (!app
->compatible
) {
6881 ret
= ust_app_regenerate_statedump(usess
, app
);
6883 /* Continue to the next app even on error */
6894 * Rotate all the channels of a session.
6896 * Return LTTNG_OK on success or else an LTTng error code.
6898 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
6901 enum lttng_error_code cmd_ret
= LTTNG_OK
;
6902 struct lttng_ht_iter iter
;
6903 struct ust_app
*app
;
6904 struct ltt_ust_session
*usess
= session
->ust_session
;
6910 switch (usess
->buffer_type
) {
6911 case LTTNG_BUFFER_PER_UID
:
6913 struct buffer_reg_uid
*reg
;
6915 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6916 struct buffer_reg_channel
*reg_chan
;
6917 struct consumer_socket
*socket
;
6919 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6920 /* Skip since no metadata is present */
6924 /* Get consumer socket to use to push the metadata.*/
6925 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6928 cmd_ret
= LTTNG_ERR_INVALID
;
6932 /* Rotate the data channels. */
6933 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6934 reg_chan
, node
.node
) {
6935 ret
= consumer_rotate_channel(socket
,
6936 reg_chan
->consumer_key
,
6937 usess
->uid
, usess
->gid
,
6939 /* is_metadata_channel */ false);
6941 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6946 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
6948 ret
= consumer_rotate_channel(socket
,
6949 reg
->registry
->reg
.ust
->metadata_key
,
6950 usess
->uid
, usess
->gid
,
6952 /* is_metadata_channel */ true);
6954 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
6960 case LTTNG_BUFFER_PER_PID
:
6962 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6963 struct consumer_socket
*socket
;
6964 struct lttng_ht_iter chan_iter
;
6965 struct ust_app_channel
*ua_chan
;
6966 struct ust_app_session
*ua_sess
;
6967 struct ust_registry_session
*registry
;
6969 ua_sess
= lookup_session_by_app(usess
, app
);
6971 /* Session not associated with this app. */
6975 /* Get the right consumer socket for the application. */
6976 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6979 cmd_ret
= LTTNG_ERR_INVALID
;
6983 registry
= get_session_registry(ua_sess
);
6985 DBG("Application session is being torn down. Skip application.");
6989 /* Rotate the data channels. */
6990 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
6991 ua_chan
, node
.node
) {
6992 ret
= consumer_rotate_channel(socket
,
6994 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
6995 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
6997 /* is_metadata_channel */ false);
6999 /* Per-PID buffer and application going away. */
7000 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7002 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7007 /* Rotate the metadata channel. */
7008 (void) push_metadata(registry
, usess
->consumer
);
7009 ret
= consumer_rotate_channel(socket
,
7010 registry
->metadata_key
,
7011 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7012 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7014 /* is_metadata_channel */ true);
7016 /* Per-PID buffer and application going away. */
7017 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7019 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7037 enum lttng_error_code
ust_app_create_channel_subdirectories(
7038 const struct ltt_ust_session
*usess
)
7040 enum lttng_error_code ret
= LTTNG_OK
;
7041 struct lttng_ht_iter iter
;
7042 enum lttng_trace_chunk_status chunk_status
;
7043 char *pathname_index
;
7046 assert(usess
->current_trace_chunk
);
7049 switch (usess
->buffer_type
) {
7050 case LTTNG_BUFFER_PER_UID
:
7052 struct buffer_reg_uid
*reg
;
7054 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7055 fmt_ret
= asprintf(&pathname_index
,
7056 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7057 reg
->uid
, reg
->bits_per_long
);
7059 ERR("Failed to format channel index directory");
7060 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7065 * Create the index subdirectory which will take care
7066 * of implicitly creating the channel's path.
7068 chunk_status
= lttng_trace_chunk_create_subdirectory(
7069 usess
->current_trace_chunk
,
7071 free(pathname_index
);
7072 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7073 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7079 case LTTNG_BUFFER_PER_PID
:
7081 struct ust_app
*app
;
7084 * Create the toplevel ust/ directory in case no apps are running.
7086 chunk_status
= lttng_trace_chunk_create_subdirectory(
7087 usess
->current_trace_chunk
,
7088 DEFAULT_UST_TRACE_DIR
);
7089 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7090 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7094 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7096 struct ust_app_session
*ua_sess
;
7097 struct ust_registry_session
*registry
;
7099 ua_sess
= lookup_session_by_app(usess
, app
);
7101 /* Session not associated with this app. */
7105 registry
= get_session_registry(ua_sess
);
7107 DBG("Application session is being torn down. Skip application.");
7111 fmt_ret
= asprintf(&pathname_index
,
7112 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7115 ERR("Failed to format channel index directory");
7116 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7120 * Create the index subdirectory which will take care
7121 * of implicitly creating the channel's path.
7123 chunk_status
= lttng_trace_chunk_create_subdirectory(
7124 usess
->current_trace_chunk
,
7126 free(pathname_index
);
7127 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7128 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7145 * Clear all the channels of a session.
7147 * Return LTTNG_OK on success or else an LTTng error code.
7149 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7152 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7153 struct lttng_ht_iter iter
;
7154 struct ust_app
*app
;
7155 struct ltt_ust_session
*usess
= session
->ust_session
;
7161 if (usess
->active
) {
7162 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7163 cmd_ret
= LTTNG_ERR_FATAL
;
7167 switch (usess
->buffer_type
) {
7168 case LTTNG_BUFFER_PER_UID
:
7170 struct buffer_reg_uid
*reg
;
7172 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7173 struct buffer_reg_channel
*reg_chan
;
7174 struct consumer_socket
*socket
;
7176 /* Get consumer socket to use to push the metadata.*/
7177 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7180 cmd_ret
= LTTNG_ERR_INVALID
;
7184 /* Clear the data channels. */
7185 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7186 reg_chan
, node
.node
) {
7187 ret
= consumer_clear_channel(socket
,
7188 reg_chan
->consumer_key
);
7194 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7197 * Clear the metadata channel.
7198 * Metadata channel is not cleared per se but we still need to
7199 * perform a rotation operation on it behind the scene.
7201 ret
= consumer_clear_channel(socket
,
7202 reg
->registry
->reg
.ust
->metadata_key
);
7209 case LTTNG_BUFFER_PER_PID
:
7211 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7212 struct consumer_socket
*socket
;
7213 struct lttng_ht_iter chan_iter
;
7214 struct ust_app_channel
*ua_chan
;
7215 struct ust_app_session
*ua_sess
;
7216 struct ust_registry_session
*registry
;
7218 ua_sess
= lookup_session_by_app(usess
, app
);
7220 /* Session not associated with this app. */
7224 /* Get the right consumer socket for the application. */
7225 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7228 cmd_ret
= LTTNG_ERR_INVALID
;
7232 registry
= get_session_registry(ua_sess
);
7234 DBG("Application session is being torn down. Skip application.");
7238 /* Clear the data channels. */
7239 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7240 ua_chan
, node
.node
) {
7241 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7243 /* Per-PID buffer and application going away. */
7244 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7251 (void) push_metadata(registry
, usess
->consumer
);
7254 * Clear the metadata channel.
7255 * Metadata channel is not cleared per se but we still need to
7256 * perform rotation operation on it behind the scene.
7258 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7260 /* Per-PID buffer and application going away. */
7261 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7279 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7280 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7283 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7293 * This function skips the metadata channel as the begin/end timestamps of a
7294 * metadata packet are useless.
7296 * Moreover, opening a packet after a "clear" will cause problems for live
7297 * sessions as it will introduce padding that was not part of the first trace
7298 * chunk. The relay daemon expects the content of the metadata stream of
7299 * successive metadata trace chunks to be strict supersets of one another.
7301 * For example, flushing a packet at the beginning of the metadata stream of
7302 * a trace chunk resulting from a "clear" session command will cause the
7303 * size of the metadata stream of the new trace chunk to not match the size of
7304 * the metadata stream of the original chunk. This will confuse the relay
7305 * daemon as the same "offset" in a metadata stream will no longer point
7306 * to the same content.
7308 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7310 enum lttng_error_code ret
= LTTNG_OK
;
7311 struct lttng_ht_iter iter
;
7312 struct ltt_ust_session
*usess
= session
->ust_session
;
7318 switch (usess
->buffer_type
) {
7319 case LTTNG_BUFFER_PER_UID
:
7321 struct buffer_reg_uid
*reg
;
7323 cds_list_for_each_entry (
7324 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7325 struct buffer_reg_channel
*reg_chan
;
7326 struct consumer_socket
*socket
;
7328 socket
= consumer_find_socket_by_bitness(
7329 reg
->bits_per_long
, usess
->consumer
);
7331 ret
= LTTNG_ERR_FATAL
;
7335 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7336 &iter
.iter
, reg_chan
, node
.node
) {
7337 const int open_ret
=
7338 consumer_open_channel_packets(
7340 reg_chan
->consumer_key
);
7343 ret
= LTTNG_ERR_UNK
;
7350 case LTTNG_BUFFER_PER_PID
:
7352 struct ust_app
*app
;
7354 cds_lfht_for_each_entry (
7355 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7356 struct consumer_socket
*socket
;
7357 struct lttng_ht_iter chan_iter
;
7358 struct ust_app_channel
*ua_chan
;
7359 struct ust_app_session
*ua_sess
;
7360 struct ust_registry_session
*registry
;
7362 ua_sess
= lookup_session_by_app(usess
, app
);
7364 /* Session not associated with this app. */
7368 /* Get the right consumer socket for the application. */
7369 socket
= consumer_find_socket_by_bitness(
7370 app
->bits_per_long
, usess
->consumer
);
7372 ret
= LTTNG_ERR_FATAL
;
7376 registry
= get_session_registry(ua_sess
);
7378 DBG("Application session is being torn down. Skip application.");
7382 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7383 &chan_iter
.iter
, ua_chan
, node
.node
) {
7384 const int open_ret
=
7385 consumer_open_channel_packets(
7391 * Per-PID buffer and application going
7394 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7398 ret
= LTTNG_ERR_UNK
;