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/compat/errno.h>
26 #include <common/common.h>
27 #include <common/hashtable/utils.h>
28 #include <lttng/event-rule/event-rule.h>
29 #include <lttng/event-rule/event-rule-internal.h>
30 #include <lttng/event-rule/user-tracepoint.h>
31 #include <lttng/condition/condition.h>
32 #include <lttng/condition/event-rule-matches-internal.h>
33 #include <lttng/condition/event-rule-matches.h>
34 #include <lttng/trigger/trigger-internal.h>
35 #include <common/sessiond-comm/sessiond-comm.h>
37 #include "buffer-registry.h"
38 #include "condition-internal.h"
40 #include "health-sessiond.h"
42 #include "ust-consumer.h"
43 #include "lttng-ust-ctl.h"
44 #include "lttng-ust-error.h"
47 #include "lttng-sessiond.h"
48 #include "notification-thread-commands.h"
51 #include "event-notifier-error-accounting.h"
54 struct lttng_ht
*ust_app_ht
;
55 struct lttng_ht
*ust_app_ht_by_sock
;
56 struct lttng_ht
*ust_app_ht_by_notify_sock
;
59 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
61 /* Next available channel key. Access under next_channel_key_lock. */
62 static uint64_t _next_channel_key
;
63 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
65 /* Next available session ID. Access under next_session_id_lock. */
66 static uint64_t _next_session_id
;
67 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
70 * Return the incremented value of next_channel_key.
72 static uint64_t get_next_channel_key(void)
76 pthread_mutex_lock(&next_channel_key_lock
);
77 ret
= ++_next_channel_key
;
78 pthread_mutex_unlock(&next_channel_key_lock
);
83 * Return the atomically incremented value of next_session_id.
85 static uint64_t get_next_session_id(void)
89 pthread_mutex_lock(&next_session_id_lock
);
90 ret
= ++_next_session_id
;
91 pthread_mutex_unlock(&next_session_id_lock
);
95 static void copy_channel_attr_to_ustctl(
96 struct lttng_ust_ctl_consumer_channel_attr
*attr
,
97 struct lttng_ust_abi_channel_attr
*uattr
)
99 /* Copy event attributes since the layout is different. */
100 attr
->subbuf_size
= uattr
->subbuf_size
;
101 attr
->num_subbuf
= uattr
->num_subbuf
;
102 attr
->overwrite
= uattr
->overwrite
;
103 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
104 attr
->read_timer_interval
= uattr
->read_timer_interval
;
105 attr
->output
= uattr
->output
;
106 attr
->blocking_timeout
= uattr
->u
.s
.blocking_timeout
;
110 * Match function for the hash table lookup.
112 * It matches an ust app event based on three attributes which are the event
113 * name, the filter bytecode and the loglevel.
115 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
117 struct ust_app_event
*event
;
118 const struct ust_app_ht_key
*key
;
119 int ev_loglevel_value
;
124 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
126 ev_loglevel_value
= event
->attr
.loglevel
;
128 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
131 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
135 /* Event loglevel. */
136 if (ev_loglevel_value
!= key
->loglevel_type
) {
137 if (event
->attr
.loglevel_type
== LTTNG_UST_ABI_LOGLEVEL_ALL
138 && key
->loglevel_type
== 0 &&
139 ev_loglevel_value
== -1) {
141 * Match is accepted. This is because on event creation, the
142 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
143 * -1 are accepted for this loglevel type since 0 is the one set by
144 * the API when receiving an enable event.
151 /* One of the filters is NULL, fail. */
152 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
156 if (key
->filter
&& event
->filter
) {
157 /* Both filters exists, check length followed by the bytecode. */
158 if (event
->filter
->len
!= key
->filter
->len
||
159 memcmp(event
->filter
->data
, key
->filter
->data
,
160 event
->filter
->len
) != 0) {
165 /* One of the exclusions is NULL, fail. */
166 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
170 if (key
->exclusion
&& event
->exclusion
) {
171 /* Both exclusions exists, check count followed by the names. */
172 if (event
->exclusion
->count
!= key
->exclusion
->count
||
173 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
174 event
->exclusion
->count
* LTTNG_UST_ABI_SYM_NAME_LEN
) != 0) {
188 * Unique add of an ust app event in the given ht. This uses the custom
189 * ht_match_ust_app_event match function and the event name as hash.
191 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
192 struct ust_app_event
*event
)
194 struct cds_lfht_node
*node_ptr
;
195 struct ust_app_ht_key key
;
198 LTTNG_ASSERT(ua_chan
);
199 LTTNG_ASSERT(ua_chan
->events
);
202 ht
= ua_chan
->events
;
203 key
.name
= event
->attr
.name
;
204 key
.filter
= event
->filter
;
205 key
.loglevel_type
= event
->attr
.loglevel
;
206 key
.exclusion
= event
->exclusion
;
208 node_ptr
= cds_lfht_add_unique(ht
->ht
,
209 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
210 ht_match_ust_app_event
, &key
, &event
->node
.node
);
211 LTTNG_ASSERT(node_ptr
== &event
->node
.node
);
215 * Close the notify socket from the given RCU head object. This MUST be called
216 * through a call_rcu().
218 static void close_notify_sock_rcu(struct rcu_head
*head
)
221 struct ust_app_notify_sock_obj
*obj
=
222 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
224 /* Must have a valid fd here. */
225 LTTNG_ASSERT(obj
->fd
>= 0);
227 ret
= close(obj
->fd
);
229 ERR("close notify sock %d RCU", obj
->fd
);
231 lttng_fd_put(LTTNG_FD_APPS
, 1);
237 * Return the session registry according to the buffer type of the given
240 * A registry per UID object MUST exists before calling this function or else
241 * it LTTNG_ASSERT() if not found. RCU read side lock must be acquired.
243 static struct ust_registry_session
*get_session_registry(
244 struct ust_app_session
*ua_sess
)
246 struct ust_registry_session
*registry
= NULL
;
248 LTTNG_ASSERT(ua_sess
);
250 switch (ua_sess
->buffer_type
) {
251 case LTTNG_BUFFER_PER_PID
:
253 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
257 registry
= reg_pid
->registry
->reg
.ust
;
260 case LTTNG_BUFFER_PER_UID
:
262 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
263 ua_sess
->tracing_id
, ua_sess
->bits_per_long
,
264 lttng_credentials_get_uid(&ua_sess
->real_credentials
));
268 registry
= reg_uid
->registry
->reg
.ust
;
280 * Delete ust context safely. RCU read lock must be held before calling
284 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
289 LTTNG_ASSERT(ua_ctx
);
292 pthread_mutex_lock(&app
->sock_lock
);
293 ret
= lttng_ust_ctl_release_object(sock
, ua_ctx
->obj
);
294 pthread_mutex_unlock(&app
->sock_lock
);
296 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
297 DBG3("UST app release ctx failed. Application is dead: pid = %d, sock = %d",
298 app
->pid
, app
->sock
);
299 } else if (ret
== -EAGAIN
) {
300 WARN("UST app release ctx failed. Communication time out: pid = %d, sock = %d",
301 app
->pid
, app
->sock
);
303 ERR("UST app release ctx obj handle %d failed with ret %d: pid = %d, sock = %d",
304 ua_ctx
->obj
->handle
, ret
,
305 app
->pid
, app
->sock
);
314 * Delete ust app event safely. RCU read lock must be held before calling
318 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
323 LTTNG_ASSERT(ua_event
);
325 free(ua_event
->filter
);
326 if (ua_event
->exclusion
!= NULL
)
327 free(ua_event
->exclusion
);
328 if (ua_event
->obj
!= NULL
) {
329 pthread_mutex_lock(&app
->sock_lock
);
330 ret
= lttng_ust_ctl_release_object(sock
, ua_event
->obj
);
331 pthread_mutex_unlock(&app
->sock_lock
);
333 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
334 DBG3("UST app release event failed. Application is dead: pid = %d, sock = %d",
335 app
->pid
, app
->sock
);
336 } else if (ret
== -EAGAIN
) {
337 WARN("UST app release event failed. Communication time out: pid = %d, sock = %d",
338 app
->pid
, app
->sock
);
340 ERR("UST app release event obj failed with ret %d: pid = %d, sock = %d",
341 ret
, app
->pid
, app
->sock
);
350 * Delayed reclaim of a ust_app_event_notifier_rule object. This MUST be called
351 * through a call_rcu().
354 void free_ust_app_event_notifier_rule_rcu(struct rcu_head
*head
)
356 struct ust_app_event_notifier_rule
*obj
= caa_container_of(
357 head
, struct ust_app_event_notifier_rule
, rcu_head
);
363 * Delete ust app event notifier rule safely.
365 static void delete_ust_app_event_notifier_rule(int sock
,
366 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
,
371 LTTNG_ASSERT(ua_event_notifier_rule
);
373 if (ua_event_notifier_rule
->exclusion
!= NULL
) {
374 free(ua_event_notifier_rule
->exclusion
);
377 if (ua_event_notifier_rule
->obj
!= NULL
) {
378 pthread_mutex_lock(&app
->sock_lock
);
379 ret
= lttng_ust_ctl_release_object(sock
, ua_event_notifier_rule
->obj
);
380 pthread_mutex_unlock(&app
->sock_lock
);
382 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
383 DBG3("UST app release event notifier failed. Application is dead: pid = %d, sock = %d",
384 app
->pid
, app
->sock
);
385 } else if (ret
== -EAGAIN
) {
386 WARN("UST app release event notifier failed. Communication time out: pid = %d, sock = %d",
387 app
->pid
, app
->sock
);
389 ERR("UST app release event notifier failed with ret %d: pid = %d, sock = %d",
390 ret
, app
->pid
, app
->sock
);
394 free(ua_event_notifier_rule
->obj
);
397 lttng_trigger_put(ua_event_notifier_rule
->trigger
);
398 call_rcu(&ua_event_notifier_rule
->rcu_head
,
399 free_ust_app_event_notifier_rule_rcu
);
403 * Release ust data object of the given stream.
405 * Return 0 on success or else a negative value.
407 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
412 LTTNG_ASSERT(stream
);
415 pthread_mutex_lock(&app
->sock_lock
);
416 ret
= lttng_ust_ctl_release_object(sock
, stream
->obj
);
417 pthread_mutex_unlock(&app
->sock_lock
);
419 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
420 DBG3("UST app release stream failed. Application is dead: pid = %d, sock = %d",
421 app
->pid
, app
->sock
);
422 } else if (ret
== -EAGAIN
) {
423 WARN("UST app release stream failed. Communication time out: pid = %d, sock = %d",
424 app
->pid
, app
->sock
);
426 ERR("UST app release stream obj failed with ret %d: pid = %d, sock = %d",
427 ret
, app
->pid
, app
->sock
);
430 lttng_fd_put(LTTNG_FD_APPS
, 2);
438 * Delete ust app stream safely. RCU read lock must be held before calling
442 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
445 LTTNG_ASSERT(stream
);
447 (void) release_ust_app_stream(sock
, stream
, app
);
452 * We need to execute ht_destroy outside of RCU read-side critical
453 * section and outside of call_rcu thread, so we postpone its execution
454 * using ht_cleanup_push. It is simpler than to change the semantic of
455 * the many callers of delete_ust_app_session().
458 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
460 struct ust_app_channel
*ua_chan
=
461 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
463 ht_cleanup_push(ua_chan
->ctx
);
464 ht_cleanup_push(ua_chan
->events
);
469 * Extract the lost packet or discarded events counter when the channel is
470 * being deleted and store the value in the parent channel so we can
471 * access it from lttng list and at stop/destroy.
473 * The session list lock must be held by the caller.
476 void save_per_pid_lost_discarded_counters(struct ust_app_channel
*ua_chan
)
478 uint64_t discarded
= 0, lost
= 0;
479 struct ltt_session
*session
;
480 struct ltt_ust_channel
*uchan
;
482 if (ua_chan
->attr
.type
!= LTTNG_UST_ABI_CHAN_PER_CPU
) {
487 session
= session_find_by_id(ua_chan
->session
->tracing_id
);
488 if (!session
|| !session
->ust_session
) {
490 * Not finding the session is not an error because there are
491 * multiple ways the channels can be torn down.
493 * 1) The session daemon can initiate the destruction of the
494 * ust app session after receiving a destroy command or
495 * during its shutdown/teardown.
496 * 2) The application, since we are in per-pid tracing, is
497 * unregistering and tearing down its ust app session.
499 * Both paths are protected by the session list lock which
500 * ensures that the accounting of lost packets and discarded
501 * events is done exactly once. The session is then unpublished
502 * from the session list, resulting in this condition.
507 if (ua_chan
->attr
.overwrite
) {
508 consumer_get_lost_packets(ua_chan
->session
->tracing_id
,
509 ua_chan
->key
, session
->ust_session
->consumer
,
512 consumer_get_discarded_events(ua_chan
->session
->tracing_id
,
513 ua_chan
->key
, session
->ust_session
->consumer
,
516 uchan
= trace_ust_find_channel_by_name(
517 session
->ust_session
->domain_global
.channels
,
520 ERR("Missing UST channel to store discarded counters");
524 uchan
->per_pid_closed_app_discarded
+= discarded
;
525 uchan
->per_pid_closed_app_lost
+= lost
;
530 session_put(session
);
535 * Delete ust app channel safely. RCU read lock must be held before calling
538 * The session list lock must be held by the caller.
541 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
545 struct lttng_ht_iter iter
;
546 struct ust_app_event
*ua_event
;
547 struct ust_app_ctx
*ua_ctx
;
548 struct ust_app_stream
*stream
, *stmp
;
549 struct ust_registry_session
*registry
;
551 LTTNG_ASSERT(ua_chan
);
553 DBG3("UST app deleting channel %s", ua_chan
->name
);
556 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
557 cds_list_del(&stream
->list
);
558 delete_ust_app_stream(sock
, stream
, app
);
562 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
563 cds_list_del(&ua_ctx
->list
);
564 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
566 delete_ust_app_ctx(sock
, ua_ctx
, app
);
570 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
572 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
574 delete_ust_app_event(sock
, ua_event
, app
);
577 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
578 /* Wipe and free registry from session registry. */
579 registry
= get_session_registry(ua_chan
->session
);
581 ust_registry_channel_del_free(registry
, ua_chan
->key
,
585 * A negative socket can be used by the caller when
586 * cleaning-up a ua_chan in an error path. Skip the
587 * accounting in this case.
590 save_per_pid_lost_discarded_counters(ua_chan
);
594 if (ua_chan
->obj
!= NULL
) {
595 /* Remove channel from application UST object descriptor. */
596 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
597 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
599 pthread_mutex_lock(&app
->sock_lock
);
600 ret
= lttng_ust_ctl_release_object(sock
, ua_chan
->obj
);
601 pthread_mutex_unlock(&app
->sock_lock
);
603 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
604 DBG3("UST app channel %s release failed. Application is dead: pid = %d, sock = %d",
605 ua_chan
->name
, app
->pid
,
607 } else if (ret
== -EAGAIN
) {
608 WARN("UST app channel %s release failed. Communication time out: pid = %d, sock = %d",
609 ua_chan
->name
, app
->pid
,
612 ERR("UST app channel %s release failed with ret %d: pid = %d, sock = %d",
613 ua_chan
->name
, ret
, app
->pid
,
617 lttng_fd_put(LTTNG_FD_APPS
, 1);
620 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
623 int ust_app_register_done(struct ust_app
*app
)
627 pthread_mutex_lock(&app
->sock_lock
);
628 ret
= lttng_ust_ctl_register_done(app
->sock
);
629 pthread_mutex_unlock(&app
->sock_lock
);
633 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_abi_object_data
*data
)
638 pthread_mutex_lock(&app
->sock_lock
);
643 ret
= lttng_ust_ctl_release_object(sock
, data
);
645 pthread_mutex_unlock(&app
->sock_lock
);
651 * Push metadata to consumer socket.
653 * RCU read-side lock must be held to guarantee existance of socket.
654 * Must be called with the ust app session lock held.
655 * Must be called with the registry lock held.
657 * On success, return the len of metadata pushed or else a negative value.
658 * Returning a -EPIPE return value means we could not send the metadata,
659 * but it can be caused by recoverable errors (e.g. the application has
660 * terminated concurrently).
662 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
663 struct consumer_socket
*socket
, int send_zero_data
)
666 char *metadata_str
= NULL
;
667 size_t len
, offset
, new_metadata_len_sent
;
669 uint64_t metadata_key
, metadata_version
;
671 LTTNG_ASSERT(registry
);
672 LTTNG_ASSERT(socket
);
674 metadata_key
= registry
->metadata_key
;
677 * Means that no metadata was assigned to the session. This can
678 * happens if no start has been done previously.
684 offset
= registry
->metadata_len_sent
;
685 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
686 new_metadata_len_sent
= registry
->metadata_len
;
687 metadata_version
= registry
->metadata_version
;
689 DBG3("No metadata to push for metadata key %" PRIu64
,
690 registry
->metadata_key
);
692 if (send_zero_data
) {
693 DBG("No metadata to push");
699 /* Allocate only what we have to send. */
700 metadata_str
= zmalloc(len
);
702 PERROR("zmalloc ust app metadata string");
706 /* Copy what we haven't sent out. */
707 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
710 pthread_mutex_unlock(®istry
->lock
);
712 * We need to unlock the registry while we push metadata to
713 * break a circular dependency between the consumerd metadata
714 * lock and the sessiond registry lock. Indeed, pushing metadata
715 * to the consumerd awaits that it gets pushed all the way to
716 * relayd, but doing so requires grabbing the metadata lock. If
717 * a concurrent metadata request is being performed by
718 * consumerd, this can try to grab the registry lock on the
719 * sessiond while holding the metadata lock on the consumer
720 * daemon. Those push and pull schemes are performed on two
721 * different bidirectionnal communication sockets.
723 ret
= consumer_push_metadata(socket
, metadata_key
,
724 metadata_str
, len
, offset
, metadata_version
);
725 pthread_mutex_lock(®istry
->lock
);
728 * There is an acceptable race here between the registry
729 * metadata key assignment and the creation on the
730 * consumer. The session daemon can concurrently push
731 * metadata for this registry while being created on the
732 * consumer since the metadata key of the registry is
733 * assigned *before* it is setup to avoid the consumer
734 * to ask for metadata that could possibly be not found
735 * in the session daemon.
737 * The metadata will get pushed either by the session
738 * being stopped or the consumer requesting metadata if
739 * that race is triggered.
741 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
744 ERR("Error pushing metadata to consumer");
750 * Metadata may have been concurrently pushed, since
751 * we're not holding the registry lock while pushing to
752 * consumer. This is handled by the fact that we send
753 * the metadata content, size, and the offset at which
754 * that metadata belongs. This may arrive out of order
755 * on the consumer side, and the consumer is able to
756 * deal with overlapping fragments. The consumer
757 * supports overlapping fragments, which must be
758 * contiguous starting from offset 0. We keep the
759 * largest metadata_len_sent value of the concurrent
762 registry
->metadata_len_sent
=
763 max_t(size_t, registry
->metadata_len_sent
,
764 new_metadata_len_sent
);
773 * On error, flag the registry that the metadata is
774 * closed. We were unable to push anything and this
775 * means that either the consumer is not responding or
776 * the metadata cache has been destroyed on the
779 registry
->metadata_closed
= 1;
787 * For a given application and session, push metadata to consumer.
788 * Either sock or consumer is required : if sock is NULL, the default
789 * socket to send the metadata is retrieved from consumer, if sock
790 * is not NULL we use it to send the metadata.
791 * RCU read-side lock must be held while calling this function,
792 * therefore ensuring existance of registry. It also ensures existance
793 * of socket throughout this function.
795 * Return 0 on success else a negative error.
796 * Returning a -EPIPE return value means we could not send the metadata,
797 * but it can be caused by recoverable errors (e.g. the application has
798 * terminated concurrently).
800 static int push_metadata(struct ust_registry_session
*registry
,
801 struct consumer_output
*consumer
)
805 struct consumer_socket
*socket
;
807 LTTNG_ASSERT(registry
);
808 LTTNG_ASSERT(consumer
);
810 pthread_mutex_lock(®istry
->lock
);
811 if (registry
->metadata_closed
) {
816 /* Get consumer socket to use to push the metadata.*/
817 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
824 ret
= ust_app_push_metadata(registry
, socket
, 0);
829 pthread_mutex_unlock(®istry
->lock
);
833 pthread_mutex_unlock(®istry
->lock
);
838 * Send to the consumer a close metadata command for the given session. Once
839 * done, the metadata channel is deleted and the session metadata pointer is
840 * nullified. The session lock MUST be held unless the application is
841 * in the destroy path.
843 * Do not hold the registry lock while communicating with the consumerd, because
844 * doing so causes inter-process deadlocks between consumerd and sessiond with
845 * the metadata request notification.
847 * Return 0 on success else a negative value.
849 static int close_metadata(struct ust_registry_session
*registry
,
850 struct consumer_output
*consumer
)
853 struct consumer_socket
*socket
;
854 uint64_t metadata_key
;
855 bool registry_was_already_closed
;
857 LTTNG_ASSERT(registry
);
858 LTTNG_ASSERT(consumer
);
862 pthread_mutex_lock(®istry
->lock
);
863 metadata_key
= registry
->metadata_key
;
864 registry_was_already_closed
= registry
->metadata_closed
;
865 if (metadata_key
!= 0) {
867 * Metadata closed. Even on error this means that the consumer
868 * is not responding or not found so either way a second close
869 * should NOT be emit for this registry.
871 registry
->metadata_closed
= 1;
873 pthread_mutex_unlock(®istry
->lock
);
875 if (metadata_key
== 0 || registry_was_already_closed
) {
880 /* Get consumer socket to use to push the metadata.*/
881 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
888 ret
= consumer_close_metadata(socket
, metadata_key
);
899 * We need to execute ht_destroy outside of RCU read-side critical
900 * section and outside of call_rcu thread, so we postpone its execution
901 * using ht_cleanup_push. It is simpler than to change the semantic of
902 * the many callers of delete_ust_app_session().
905 void delete_ust_app_session_rcu(struct rcu_head
*head
)
907 struct ust_app_session
*ua_sess
=
908 caa_container_of(head
, struct ust_app_session
, rcu_head
);
910 ht_cleanup_push(ua_sess
->channels
);
915 * Delete ust app session safely. RCU read lock must be held before calling
918 * The session list lock must be held by the caller.
921 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
925 struct lttng_ht_iter iter
;
926 struct ust_app_channel
*ua_chan
;
927 struct ust_registry_session
*registry
;
929 LTTNG_ASSERT(ua_sess
);
931 pthread_mutex_lock(&ua_sess
->lock
);
933 LTTNG_ASSERT(!ua_sess
->deleted
);
934 ua_sess
->deleted
= true;
936 registry
= get_session_registry(ua_sess
);
937 /* Registry can be null on error path during initialization. */
939 /* Push metadata for application before freeing the application. */
940 (void) push_metadata(registry
, ua_sess
->consumer
);
943 * Don't ask to close metadata for global per UID buffers. Close
944 * metadata only on destroy trace session in this case. Also, the
945 * previous push metadata could have flag the metadata registry to
946 * close so don't send a close command if closed.
948 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
949 /* And ask to close it for this session registry. */
950 (void) close_metadata(registry
, ua_sess
->consumer
);
954 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
956 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
958 delete_ust_app_channel(sock
, ua_chan
, app
);
961 /* In case of per PID, the registry is kept in the session. */
962 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
963 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
966 * Registry can be null on error path during
969 buffer_reg_pid_remove(reg_pid
);
970 buffer_reg_pid_destroy(reg_pid
);
974 if (ua_sess
->handle
!= -1) {
975 pthread_mutex_lock(&app
->sock_lock
);
976 ret
= lttng_ust_ctl_release_handle(sock
, ua_sess
->handle
);
977 pthread_mutex_unlock(&app
->sock_lock
);
979 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
980 DBG3("UST app release session handle failed. Application is dead: pid = %d, sock = %d",
981 app
->pid
, app
->sock
);
982 } else if (ret
== -EAGAIN
) {
983 WARN("UST app release session handle failed. Communication time out: pid = %d, sock = %d",
984 app
->pid
, app
->sock
);
986 ERR("UST app release session handle failed with ret %d: pid = %d, sock = %d",
987 ret
, app
->pid
, app
->sock
);
991 /* Remove session from application UST object descriptor. */
992 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
993 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
997 pthread_mutex_unlock(&ua_sess
->lock
);
999 consumer_output_put(ua_sess
->consumer
);
1001 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
1005 * Delete a traceable application structure from the global list. Never call
1006 * this function outside of a call_rcu call.
1008 * RCU read side lock should _NOT_ be held when calling this function.
1011 void delete_ust_app(struct ust_app
*app
)
1014 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
1015 struct lttng_ht_iter iter
;
1016 struct ust_app_event_notifier_rule
*event_notifier_rule
;
1017 bool event_notifier_write_fd_is_open
;
1020 * The session list lock must be held during this function to guarantee
1021 * the existence of ua_sess.
1023 session_lock_list();
1024 /* Delete ust app sessions info */
1029 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
1031 /* Free every object in the session and the session. */
1033 delete_ust_app_session(sock
, ua_sess
, app
);
1037 /* Remove the event notifier rules associated with this app. */
1039 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
1040 &iter
.iter
, event_notifier_rule
, node
.node
) {
1041 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
, &iter
);
1044 delete_ust_app_event_notifier_rule(
1045 app
->sock
, event_notifier_rule
, app
);
1050 ht_cleanup_push(app
->sessions
);
1051 ht_cleanup_push(app
->ust_sessions_objd
);
1052 ht_cleanup_push(app
->ust_objd
);
1053 ht_cleanup_push(app
->token_to_event_notifier_rule_ht
);
1056 * This could be NULL if the event notifier setup failed (e.g the app
1057 * was killed or the tracer does not support this feature).
1059 if (app
->event_notifier_group
.object
) {
1060 enum lttng_error_code ret_code
;
1061 enum event_notifier_error_accounting_status status
;
1063 const int event_notifier_read_fd
= lttng_pipe_get_readfd(
1064 app
->event_notifier_group
.event_pipe
);
1066 ret_code
= notification_thread_command_remove_tracer_event_source(
1067 the_notification_thread_handle
,
1068 event_notifier_read_fd
);
1069 if (ret_code
!= LTTNG_OK
) {
1070 ERR("Failed to remove application tracer event source from notification thread");
1073 status
= event_notifier_error_accounting_unregister_app(app
);
1074 if (status
!= EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
) {
1075 ERR("Error unregistering app from event notifier error accounting");
1078 lttng_ust_ctl_release_object(sock
, app
->event_notifier_group
.object
);
1079 free(app
->event_notifier_group
.object
);
1082 event_notifier_write_fd_is_open
= lttng_pipe_is_write_open(
1083 app
->event_notifier_group
.event_pipe
);
1084 lttng_pipe_destroy(app
->event_notifier_group
.event_pipe
);
1086 * Release the file descriptors reserved for the event notifier pipe.
1087 * The app could be destroyed before the write end of the pipe could be
1088 * passed to the application (and closed). In that case, both file
1089 * descriptors must be released.
1091 lttng_fd_put(LTTNG_FD_APPS
, event_notifier_write_fd_is_open
? 2 : 1);
1094 * Wait until we have deleted the application from the sock hash table
1095 * before closing this socket, otherwise an application could re-use the
1096 * socket ID and race with the teardown, using the same hash table entry.
1098 * It's OK to leave the close in call_rcu. We want it to stay unique for
1099 * all RCU readers that could run concurrently with unregister app,
1100 * therefore we _need_ to only close that socket after a grace period. So
1101 * it should stay in this RCU callback.
1103 * This close() is a very important step of the synchronization model so
1104 * every modification to this function must be carefully reviewed.
1110 lttng_fd_put(LTTNG_FD_APPS
, 1);
1112 DBG2("UST app pid %d deleted", app
->pid
);
1114 session_unlock_list();
1118 * URCU intermediate call to delete an UST app.
1121 void delete_ust_app_rcu(struct rcu_head
*head
)
1123 struct lttng_ht_node_ulong
*node
=
1124 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
1125 struct ust_app
*app
=
1126 caa_container_of(node
, struct ust_app
, pid_n
);
1128 DBG3("Call RCU deleting app PID %d", app
->pid
);
1129 delete_ust_app(app
);
1133 * Delete the session from the application ht and delete the data structure by
1134 * freeing every object inside and releasing them.
1136 * The session list lock must be held by the caller.
1138 static void destroy_app_session(struct ust_app
*app
,
1139 struct ust_app_session
*ua_sess
)
1142 struct lttng_ht_iter iter
;
1145 LTTNG_ASSERT(ua_sess
);
1147 iter
.iter
.node
= &ua_sess
->node
.node
;
1148 ret
= lttng_ht_del(app
->sessions
, &iter
);
1150 /* Already scheduled for teardown. */
1154 /* Once deleted, free the data structure. */
1155 delete_ust_app_session(app
->sock
, ua_sess
, app
);
1162 * Alloc new UST app session.
1165 struct ust_app_session
*alloc_ust_app_session(void)
1167 struct ust_app_session
*ua_sess
;
1169 /* Init most of the default value by allocating and zeroing */
1170 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
1171 if (ua_sess
== NULL
) {
1176 ua_sess
->handle
= -1;
1177 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1178 ua_sess
->metadata_attr
.type
= LTTNG_UST_ABI_CHAN_METADATA
;
1179 pthread_mutex_init(&ua_sess
->lock
, NULL
);
1188 * Alloc new UST app channel.
1191 struct ust_app_channel
*alloc_ust_app_channel(const char *name
,
1192 struct ust_app_session
*ua_sess
,
1193 struct lttng_ust_abi_channel_attr
*attr
)
1195 struct ust_app_channel
*ua_chan
;
1197 /* Init most of the default value by allocating and zeroing */
1198 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
1199 if (ua_chan
== NULL
) {
1204 /* Setup channel name */
1205 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
1206 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1208 ua_chan
->enabled
= 1;
1209 ua_chan
->handle
= -1;
1210 ua_chan
->session
= ua_sess
;
1211 ua_chan
->key
= get_next_channel_key();
1212 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
1213 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
1214 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
1216 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
1217 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
1219 /* Copy attributes */
1221 /* Translate from lttng_ust_channel to lttng_ust_ctl_consumer_channel_attr. */
1222 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
1223 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
1224 ua_chan
->attr
.overwrite
= attr
->overwrite
;
1225 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
1226 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
1227 ua_chan
->attr
.output
= attr
->output
;
1228 ua_chan
->attr
.blocking_timeout
= attr
->u
.s
.blocking_timeout
;
1230 /* By default, the channel is a per cpu channel. */
1231 ua_chan
->attr
.type
= LTTNG_UST_ABI_CHAN_PER_CPU
;
1233 DBG3("UST app channel %s allocated", ua_chan
->name
);
1242 * Allocate and initialize a UST app stream.
1244 * Return newly allocated stream pointer or NULL on error.
1246 struct ust_app_stream
*ust_app_alloc_stream(void)
1248 struct ust_app_stream
*stream
= NULL
;
1250 stream
= zmalloc(sizeof(*stream
));
1251 if (stream
== NULL
) {
1252 PERROR("zmalloc ust app stream");
1256 /* Zero could be a valid value for a handle so flag it to -1. */
1257 stream
->handle
= -1;
1264 * Alloc new UST app event.
1267 struct ust_app_event
*alloc_ust_app_event(char *name
,
1268 struct lttng_ust_abi_event
*attr
)
1270 struct ust_app_event
*ua_event
;
1272 /* Init most of the default value by allocating and zeroing */
1273 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1274 if (ua_event
== NULL
) {
1275 PERROR("Failed to allocate ust_app_event structure");
1279 ua_event
->enabled
= 1;
1280 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1281 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1282 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1284 /* Copy attributes */
1286 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1289 DBG3("UST app event %s allocated", ua_event
->name
);
1298 * Allocate a new UST app event notifier rule.
1300 static struct ust_app_event_notifier_rule
*alloc_ust_app_event_notifier_rule(
1301 struct lttng_trigger
*trigger
)
1303 enum lttng_event_rule_generate_exclusions_status
1304 generate_exclusion_status
;
1305 enum lttng_condition_status cond_status
;
1306 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
1307 struct lttng_condition
*condition
= NULL
;
1308 const struct lttng_event_rule
*event_rule
= NULL
;
1310 ua_event_notifier_rule
= zmalloc(sizeof(struct ust_app_event_notifier_rule
));
1311 if (ua_event_notifier_rule
== NULL
) {
1312 PERROR("Failed to allocate ust_app_event_notifier_rule structure");
1316 ua_event_notifier_rule
->enabled
= 1;
1317 ua_event_notifier_rule
->token
= lttng_trigger_get_tracer_token(trigger
);
1318 lttng_ht_node_init_u64(&ua_event_notifier_rule
->node
,
1319 ua_event_notifier_rule
->token
);
1321 condition
= lttng_trigger_get_condition(trigger
);
1322 LTTNG_ASSERT(condition
);
1323 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
1324 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
1326 cond_status
= lttng_condition_event_rule_matches_get_rule(
1327 condition
, &event_rule
);
1328 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
1329 LTTNG_ASSERT(event_rule
);
1331 ua_event_notifier_rule
->error_counter_index
=
1332 lttng_condition_event_rule_matches_get_error_counter_index(condition
);
1333 /* Acquire the event notifier's reference to the trigger. */
1334 lttng_trigger_get(trigger
);
1336 ua_event_notifier_rule
->trigger
= trigger
;
1337 ua_event_notifier_rule
->filter
= lttng_event_rule_get_filter_bytecode(event_rule
);
1338 generate_exclusion_status
= lttng_event_rule_generate_exclusions(
1339 event_rule
, &ua_event_notifier_rule
->exclusion
);
1340 switch (generate_exclusion_status
) {
1341 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_OK
:
1342 case LTTNG_EVENT_RULE_GENERATE_EXCLUSIONS_STATUS_NONE
:
1345 /* Error occured. */
1346 ERR("Failed to generate exclusions from trigger while allocating an event notifier rule");
1347 goto error_put_trigger
;
1350 DBG3("UST app event notifier rule allocated: token = %" PRIu64
,
1351 ua_event_notifier_rule
->token
);
1353 return ua_event_notifier_rule
;
1356 lttng_trigger_put(trigger
);
1358 free(ua_event_notifier_rule
);
1363 * Alloc new UST app context.
1366 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context_attr
*uctx
)
1368 struct ust_app_ctx
*ua_ctx
;
1370 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1371 if (ua_ctx
== NULL
) {
1375 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1378 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1379 if (uctx
->ctx
== LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
) {
1380 char *provider_name
= NULL
, *ctx_name
= NULL
;
1382 provider_name
= strdup(uctx
->u
.app_ctx
.provider_name
);
1383 ctx_name
= strdup(uctx
->u
.app_ctx
.ctx_name
);
1384 if (!provider_name
|| !ctx_name
) {
1385 free(provider_name
);
1390 ua_ctx
->ctx
.u
.app_ctx
.provider_name
= provider_name
;
1391 ua_ctx
->ctx
.u
.app_ctx
.ctx_name
= ctx_name
;
1395 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1403 * Create a liblttng-ust filter bytecode from given bytecode.
1405 * Return allocated filter or NULL on error.
1407 static struct lttng_ust_abi_filter_bytecode
*create_ust_filter_bytecode_from_bytecode(
1408 const struct lttng_bytecode
*orig_f
)
1410 struct lttng_ust_abi_filter_bytecode
*filter
= NULL
;
1412 /* Copy filter bytecode. */
1413 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1415 PERROR("Failed to allocate lttng_ust_filter_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1419 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1420 sizeof(struct lttng_ust_abi_filter_bytecode
));
1421 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1427 * Create a liblttng-ust capture bytecode from given bytecode.
1429 * Return allocated filter or NULL on error.
1431 static struct lttng_ust_abi_capture_bytecode
*
1432 create_ust_capture_bytecode_from_bytecode(const struct lttng_bytecode
*orig_f
)
1434 struct lttng_ust_abi_capture_bytecode
*capture
= NULL
;
1436 /* Copy capture bytecode. */
1437 capture
= zmalloc(sizeof(*capture
) + orig_f
->len
);
1439 PERROR("Failed to allocate lttng_ust_abi_capture_bytecode: bytecode len = %" PRIu32
" bytes", orig_f
->len
);
1443 LTTNG_ASSERT(sizeof(struct lttng_bytecode
) ==
1444 sizeof(struct lttng_ust_abi_capture_bytecode
));
1445 memcpy(capture
, orig_f
, sizeof(*capture
) + orig_f
->len
);
1451 * Find an ust_app using the sock and return it. RCU read side lock must be
1452 * held before calling this helper function.
1454 struct ust_app
*ust_app_find_by_sock(int sock
)
1456 struct lttng_ht_node_ulong
*node
;
1457 struct lttng_ht_iter iter
;
1459 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1460 node
= lttng_ht_iter_get_node_ulong(&iter
);
1462 DBG2("UST app find by sock %d not found", sock
);
1466 return caa_container_of(node
, struct ust_app
, sock_n
);
1473 * Find an ust_app using the notify sock and return it. RCU read side lock must
1474 * be held before calling this helper function.
1476 static struct ust_app
*find_app_by_notify_sock(int sock
)
1478 struct lttng_ht_node_ulong
*node
;
1479 struct lttng_ht_iter iter
;
1481 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1483 node
= lttng_ht_iter_get_node_ulong(&iter
);
1485 DBG2("UST app find by notify sock %d not found", sock
);
1489 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1496 * Lookup for an ust app event based on event name, filter bytecode and the
1499 * Return an ust_app_event object or NULL on error.
1501 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1502 const char *name
, const struct lttng_bytecode
*filter
,
1504 const struct lttng_event_exclusion
*exclusion
)
1506 struct lttng_ht_iter iter
;
1507 struct lttng_ht_node_str
*node
;
1508 struct ust_app_event
*event
= NULL
;
1509 struct ust_app_ht_key key
;
1514 /* Setup key for event lookup. */
1516 key
.filter
= filter
;
1517 key
.loglevel_type
= loglevel_value
;
1518 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1519 key
.exclusion
= exclusion
;
1521 /* Lookup using the event name as hash and a custom match fct. */
1522 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1523 ht_match_ust_app_event
, &key
, &iter
.iter
);
1524 node
= lttng_ht_iter_get_node_str(&iter
);
1529 event
= caa_container_of(node
, struct ust_app_event
, node
);
1536 * Look-up an event notifier rule based on its token id.
1538 * Must be called with the RCU read lock held.
1539 * Return an ust_app_event_notifier_rule object or NULL on error.
1541 static struct ust_app_event_notifier_rule
*find_ust_app_event_notifier_rule(
1542 struct lttng_ht
*ht
, uint64_t token
)
1544 struct lttng_ht_iter iter
;
1545 struct lttng_ht_node_u64
*node
;
1546 struct ust_app_event_notifier_rule
*event_notifier_rule
= NULL
;
1550 lttng_ht_lookup(ht
, &token
, &iter
);
1551 node
= lttng_ht_iter_get_node_u64(&iter
);
1553 DBG2("UST app event notifier rule token not found: token = %" PRIu64
,
1558 event_notifier_rule
= caa_container_of(
1559 node
, struct ust_app_event_notifier_rule
, node
);
1561 return event_notifier_rule
;
1565 * Create the channel context on the tracer.
1567 * Called with UST app session lock held.
1570 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1571 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1575 health_code_update();
1577 pthread_mutex_lock(&app
->sock_lock
);
1578 ret
= lttng_ust_ctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1579 ua_chan
->obj
, &ua_ctx
->obj
);
1580 pthread_mutex_unlock(&app
->sock_lock
);
1582 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1584 DBG3("UST app create channel context failed. Application is dead: pid = %d, sock = %d",
1585 app
->pid
, app
->sock
);
1586 } else if (ret
== -EAGAIN
) {
1588 WARN("UST app create channel context failed. Communication time out: pid = %d, sock = %d",
1589 app
->pid
, app
->sock
);
1591 ERR("UST app create channel context failed with ret %d: pid = %d, sock = %d",
1592 ret
, app
->pid
, app
->sock
);
1597 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1599 DBG2("UST app context handle %d created successfully for channel %s",
1600 ua_ctx
->handle
, ua_chan
->name
);
1603 health_code_update();
1608 * Set the filter on the tracer.
1610 static int set_ust_object_filter(struct ust_app
*app
,
1611 const struct lttng_bytecode
*bytecode
,
1612 struct lttng_ust_abi_object_data
*ust_object
)
1615 struct lttng_ust_abi_filter_bytecode
*ust_bytecode
= NULL
;
1617 health_code_update();
1619 ust_bytecode
= create_ust_filter_bytecode_from_bytecode(bytecode
);
1620 if (!ust_bytecode
) {
1621 ret
= -LTTNG_ERR_NOMEM
;
1624 pthread_mutex_lock(&app
->sock_lock
);
1625 ret
= lttng_ust_ctl_set_filter(app
->sock
, ust_bytecode
,
1627 pthread_mutex_unlock(&app
->sock_lock
);
1629 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1631 DBG3("UST app set filter failed. Application is dead: pid = %d, sock = %d",
1632 app
->pid
, app
->sock
);
1633 } else if (ret
== -EAGAIN
) {
1635 WARN("UST app set filter failed. Communication time out: pid = %d, sock = %d",
1636 app
->pid
, app
->sock
);
1638 ERR("UST app set filter failed with ret %d: pid = %d, sock = %d, object = %p",
1639 ret
, app
->pid
, app
->sock
, ust_object
);
1644 DBG2("UST filter successfully set: object = %p", ust_object
);
1647 health_code_update();
1653 * Set a capture bytecode for the passed object.
1654 * The sequence number enforces the ordering at runtime and on reception of
1655 * the captured payloads.
1657 static int set_ust_capture(struct ust_app
*app
,
1658 const struct lttng_bytecode
*bytecode
,
1659 unsigned int capture_seqnum
,
1660 struct lttng_ust_abi_object_data
*ust_object
)
1663 struct lttng_ust_abi_capture_bytecode
*ust_bytecode
= NULL
;
1665 health_code_update();
1667 ust_bytecode
= create_ust_capture_bytecode_from_bytecode(bytecode
);
1668 if (!ust_bytecode
) {
1669 ret
= -LTTNG_ERR_NOMEM
;
1674 * Set the sequence number to ensure the capture of fields is ordered.
1676 ust_bytecode
->seqnum
= capture_seqnum
;
1678 pthread_mutex_lock(&app
->sock_lock
);
1679 ret
= lttng_ust_ctl_set_capture(app
->sock
, ust_bytecode
,
1681 pthread_mutex_unlock(&app
->sock_lock
);
1683 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1685 DBG3("UST app set capture failed. Application is dead: pid = %d, sock = %d",
1686 app
->pid
, app
->sock
);
1687 } else if (ret
== -EAGAIN
) {
1689 DBG3("UST app set capture failed. Communication timeout: pid = %d, sock = %d",
1690 app
->pid
, app
->sock
);
1692 ERR("UST app event set capture failed with ret %d: pid = %d, sock = %d",
1700 DBG2("UST capture successfully set: object = %p", ust_object
);
1703 health_code_update();
1709 struct lttng_ust_abi_event_exclusion
*create_ust_exclusion_from_exclusion(
1710 const struct lttng_event_exclusion
*exclusion
)
1712 struct lttng_ust_abi_event_exclusion
*ust_exclusion
= NULL
;
1713 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_abi_event_exclusion
) +
1714 LTTNG_UST_ABI_SYM_NAME_LEN
* exclusion
->count
;
1716 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1717 if (!ust_exclusion
) {
1722 LTTNG_ASSERT(sizeof(struct lttng_event_exclusion
) ==
1723 sizeof(struct lttng_ust_abi_event_exclusion
));
1724 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1726 return ust_exclusion
;
1730 * Set event exclusions on the tracer.
1732 static int set_ust_object_exclusions(struct ust_app
*app
,
1733 const struct lttng_event_exclusion
*exclusions
,
1734 struct lttng_ust_abi_object_data
*ust_object
)
1737 struct lttng_ust_abi_event_exclusion
*ust_exclusions
= NULL
;
1739 LTTNG_ASSERT(exclusions
&& exclusions
->count
> 0);
1741 health_code_update();
1743 ust_exclusions
= create_ust_exclusion_from_exclusion(
1745 if (!ust_exclusions
) {
1746 ret
= -LTTNG_ERR_NOMEM
;
1749 pthread_mutex_lock(&app
->sock_lock
);
1750 ret
= lttng_ust_ctl_set_exclusion(app
->sock
, ust_exclusions
, ust_object
);
1751 pthread_mutex_unlock(&app
->sock_lock
);
1753 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1755 DBG3("UST app event exclusion failed. Application is dead: pid = %d, sock = %d",
1756 app
->pid
, app
->sock
);
1757 } else if (ret
== -EAGAIN
) {
1759 WARN("UST app event exclusion failed. Communication time out(pid: %d, sock = %d",
1760 app
->pid
, app
->sock
);
1762 ERR("UST app event exclusions failed with ret %d: pid = %d, sock = %d, object = %p",
1763 ret
, app
->pid
, app
->sock
, ust_object
);
1768 DBG2("UST exclusions set successfully for object %p", ust_object
);
1771 health_code_update();
1772 free(ust_exclusions
);
1777 * Disable the specified event on to UST tracer for the UST session.
1779 static int disable_ust_object(struct ust_app
*app
,
1780 struct lttng_ust_abi_object_data
*object
)
1784 health_code_update();
1786 pthread_mutex_lock(&app
->sock_lock
);
1787 ret
= lttng_ust_ctl_disable(app
->sock
, object
);
1788 pthread_mutex_unlock(&app
->sock_lock
);
1790 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1792 DBG3("UST app disable object failed. Application is dead: pid = %d, sock = %d",
1793 app
->pid
, app
->sock
);
1794 } else if (ret
== -EAGAIN
) {
1796 WARN("UST app disable object failed. Communication time out: pid = %d, sock = %d",
1797 app
->pid
, app
->sock
);
1799 ERR("UST app disable object failed with ret %d: pid = %d, sock = %d, object = %p",
1800 ret
, app
->pid
, app
->sock
, object
);
1805 DBG2("UST app object %p disabled successfully for app: pid = %d",
1809 health_code_update();
1814 * Disable the specified channel on to UST tracer for the UST session.
1816 static int disable_ust_channel(struct ust_app
*app
,
1817 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1821 health_code_update();
1823 pthread_mutex_lock(&app
->sock_lock
);
1824 ret
= lttng_ust_ctl_disable(app
->sock
, ua_chan
->obj
);
1825 pthread_mutex_unlock(&app
->sock_lock
);
1827 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1829 DBG3("UST app disable channel failed. Application is dead: pid = %d, sock = %d",
1830 app
->pid
, app
->sock
);
1831 } else if (ret
== -EAGAIN
) {
1833 WARN("UST app disable channel failed. Communication time out: pid = %d, sock = %d",
1834 app
->pid
, app
->sock
);
1836 ERR("UST app channel %s disable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1837 ua_chan
->name
, ua_sess
->handle
, ret
,
1838 app
->pid
, app
->sock
);
1843 DBG2("UST app channel %s disabled successfully for app: pid = %d",
1844 ua_chan
->name
, app
->pid
);
1847 health_code_update();
1852 * Enable the specified channel on to UST tracer for the UST session.
1854 static int enable_ust_channel(struct ust_app
*app
,
1855 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1859 health_code_update();
1861 pthread_mutex_lock(&app
->sock_lock
);
1862 ret
= lttng_ust_ctl_enable(app
->sock
, ua_chan
->obj
);
1863 pthread_mutex_unlock(&app
->sock_lock
);
1865 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1867 DBG3("UST app channel %s enable failed. Application is dead: pid = %d, sock = %d",
1868 ua_chan
->name
, app
->pid
, app
->sock
);
1869 } else if (ret
== -EAGAIN
) {
1871 WARN("UST app channel %s enable failed. Communication time out: pid = %d, sock = %d",
1872 ua_chan
->name
, app
->pid
, app
->sock
);
1874 ERR("UST app channel %s enable failed, session handle %d, with ret %d: pid = %d, sock = %d",
1875 ua_chan
->name
, ua_sess
->handle
, ret
,
1876 app
->pid
, app
->sock
);
1881 ua_chan
->enabled
= 1;
1883 DBG2("UST app channel %s enabled successfully for app: pid = %d",
1884 ua_chan
->name
, app
->pid
);
1887 health_code_update();
1892 * Enable the specified event on to UST tracer for the UST session.
1894 static int enable_ust_object(
1895 struct ust_app
*app
, struct lttng_ust_abi_object_data
*ust_object
)
1899 health_code_update();
1901 pthread_mutex_lock(&app
->sock_lock
);
1902 ret
= lttng_ust_ctl_enable(app
->sock
, ust_object
);
1903 pthread_mutex_unlock(&app
->sock_lock
);
1905 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1907 DBG3("UST app enable object failed. Application is dead: pid = %d, sock = %d",
1908 app
->pid
, app
->sock
);
1909 } else if (ret
== -EAGAIN
) {
1911 WARN("UST app enable object failed. Communication time out: pid = %d, sock = %d",
1912 app
->pid
, app
->sock
);
1914 ERR("UST app enable object failed with ret %d: pid = %d, sock = %d, object = %p",
1915 ret
, app
->pid
, app
->sock
, ust_object
);
1920 DBG2("UST app object %p enabled successfully for app: pid = %d",
1921 ust_object
, app
->pid
);
1924 health_code_update();
1929 * Send channel and stream buffer to application.
1931 * Return 0 on success. On error, a negative value is returned.
1933 static int send_channel_pid_to_ust(struct ust_app
*app
,
1934 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1937 struct ust_app_stream
*stream
, *stmp
;
1940 LTTNG_ASSERT(ua_sess
);
1941 LTTNG_ASSERT(ua_chan
);
1943 health_code_update();
1945 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1948 /* Send channel to the application. */
1949 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1950 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1951 ret
= -ENOTCONN
; /* Caused by app exiting. */
1953 } else if (ret
== -EAGAIN
) {
1954 /* Caused by timeout. */
1955 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
"\".",
1956 app
->pid
, ua_chan
->name
, ua_sess
->tracing_id
);
1957 /* Treat this the same way as an application that is exiting. */
1960 } else if (ret
< 0) {
1964 health_code_update();
1966 /* Send all streams to application. */
1967 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1968 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1969 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1970 ret
= -ENOTCONN
; /* Caused by app exiting. */
1972 } else if (ret
== -EAGAIN
) {
1973 /* Caused by timeout. */
1974 WARN("Communication with application %d timed out on send_stream for stream \"%s\" of channel \"%s\" of session \"%" PRIu64
"\".",
1975 app
->pid
, stream
->name
, ua_chan
->name
,
1976 ua_sess
->tracing_id
);
1977 /* Treat this the same way as an application that is
1980 } else if (ret
< 0) {
1983 /* We don't need the stream anymore once sent to the tracer. */
1984 cds_list_del(&stream
->list
);
1985 delete_ust_app_stream(-1, stream
, app
);
1987 /* Flag the channel that it is sent to the application. */
1988 ua_chan
->is_sent
= 1;
1991 health_code_update();
1996 * Create the specified event onto the UST tracer for a UST session.
1998 * Should be called with session mutex held.
2001 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2002 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
2006 health_code_update();
2008 /* Create UST event on tracer */
2009 pthread_mutex_lock(&app
->sock_lock
);
2010 ret
= lttng_ust_ctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
2012 pthread_mutex_unlock(&app
->sock_lock
);
2014 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2016 DBG3("UST app create event failed. Application is dead: pid = %d, sock = %d",
2017 app
->pid
, app
->sock
);
2018 } else if (ret
== -EAGAIN
) {
2020 WARN("UST app create event failed. Communication time out: pid = %d, sock = %d",
2021 app
->pid
, app
->sock
);
2023 ERR("UST app create event '%s' failed with ret %d: pid = %d, sock = %d",
2024 ua_event
->attr
.name
, ret
, app
->pid
,
2030 ua_event
->handle
= ua_event
->obj
->handle
;
2032 DBG2("UST app event %s created successfully for pid:%d object = %p",
2033 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
2035 health_code_update();
2037 /* Set filter if one is present. */
2038 if (ua_event
->filter
) {
2039 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
2045 /* Set exclusions for the event */
2046 if (ua_event
->exclusion
) {
2047 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
2053 /* If event not enabled, disable it on the tracer */
2054 if (ua_event
->enabled
) {
2056 * We now need to explicitly enable the event, since it
2057 * is now disabled at creation.
2059 ret
= enable_ust_object(app
, ua_event
->obj
);
2062 * If we hit an EPERM, something is wrong with our enable call. If
2063 * we get an EEXIST, there is a problem on the tracer side since we
2067 case -LTTNG_UST_ERR_PERM
:
2068 /* Code flow problem */
2070 case -LTTNG_UST_ERR_EXIST
:
2071 /* It's OK for our use case. */
2082 health_code_update();
2086 static int init_ust_event_notifier_from_event_rule(
2087 const struct lttng_event_rule
*rule
,
2088 struct lttng_ust_abi_event_notifier
*event_notifier
)
2090 enum lttng_event_rule_status status
;
2091 enum lttng_ust_abi_loglevel_type ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2092 int loglevel
= -1, ret
= 0;
2093 const char *pattern
;
2096 memset(event_notifier
, 0, sizeof(*event_notifier
));
2098 if (lttng_event_rule_targets_agent_domain(rule
)) {
2100 * Special event for agents
2101 * The actual meat of the event is in the filter that will be
2102 * attached later on.
2103 * Set the default values for the agent event.
2105 pattern
= event_get_default_agent_ust_name(
2106 lttng_event_rule_get_domain_type(rule
));
2108 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2110 const struct lttng_log_level_rule
*log_level_rule
;
2112 LTTNG_ASSERT(lttng_event_rule_get_type(rule
) ==
2113 LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
);
2115 status
= lttng_event_rule_user_tracepoint_get_name_pattern(rule
, &pattern
);
2116 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2117 /* At this point, this is a fatal error. */
2121 status
= lttng_event_rule_user_tracepoint_get_log_level_rule(
2122 rule
, &log_level_rule
);
2123 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
2124 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2125 } else if (status
== LTTNG_EVENT_RULE_STATUS_OK
) {
2126 enum lttng_log_level_rule_status llr_status
;
2128 switch (lttng_log_level_rule_get_type(log_level_rule
)) {
2129 case LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
:
2130 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_SINGLE
;
2131 llr_status
= lttng_log_level_rule_exactly_get_level(
2132 log_level_rule
, &loglevel
);
2134 case LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
:
2135 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_RANGE
;
2136 llr_status
= lttng_log_level_rule_at_least_as_severe_as_get_level(
2137 log_level_rule
, &loglevel
);
2143 LTTNG_ASSERT(llr_status
== LTTNG_LOG_LEVEL_RULE_STATUS_OK
);
2145 /* At this point this is a fatal error. */
2150 event_notifier
->event
.instrumentation
= LTTNG_UST_ABI_TRACEPOINT
;
2151 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
2152 LTTNG_UST_ABI_SYM_NAME_LEN
- 1);
2154 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
2159 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2160 event_notifier
->event
.loglevel
= loglevel
;
2166 * Create the specified event notifier against the user space tracer of a
2167 * given application.
2169 static int create_ust_event_notifier(struct ust_app
*app
,
2170 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2173 enum lttng_condition_status condition_status
;
2174 const struct lttng_condition
*condition
= NULL
;
2175 struct lttng_ust_abi_event_notifier event_notifier
;
2176 const struct lttng_event_rule
*event_rule
= NULL
;
2177 unsigned int capture_bytecode_count
= 0, i
;
2178 enum lttng_condition_status cond_status
;
2179 enum lttng_event_rule_type event_rule_type
;
2181 health_code_update();
2182 LTTNG_ASSERT(app
->event_notifier_group
.object
);
2184 condition
= lttng_trigger_get_const_condition(
2185 ua_event_notifier_rule
->trigger
);
2186 LTTNG_ASSERT(condition
);
2187 LTTNG_ASSERT(lttng_condition_get_type(condition
) ==
2188 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
2190 condition_status
= lttng_condition_event_rule_matches_get_rule(
2191 condition
, &event_rule
);
2192 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2194 LTTNG_ASSERT(event_rule
);
2196 event_rule_type
= lttng_event_rule_get_type(event_rule
);
2197 LTTNG_ASSERT(event_rule_type
== LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
||
2198 event_rule_type
== LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
||
2200 LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
||
2202 LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
);
2204 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2205 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2206 event_notifier
.error_counter_index
= ua_event_notifier_rule
->error_counter_index
;
2208 /* Create UST event notifier against the tracer. */
2209 pthread_mutex_lock(&app
->sock_lock
);
2210 ret
= lttng_ust_ctl_create_event_notifier(app
->sock
, &event_notifier
,
2211 app
->event_notifier_group
.object
,
2212 &ua_event_notifier_rule
->obj
);
2213 pthread_mutex_unlock(&app
->sock_lock
);
2215 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2217 DBG3("UST app create event notifier failed. Application is dead: pid = %d, sock = %d",
2218 app
->pid
, app
->sock
);
2219 } else if (ret
== -EAGAIN
) {
2221 WARN("UST app create event notifier failed. Communication time out: pid = %d, sock = %d",
2222 app
->pid
, app
->sock
);
2224 ERR("UST app create event notifier '%s' failed with ret %d: pid = %d, sock = %d",
2225 event_notifier
.event
.name
, ret
, app
->pid
,
2231 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2233 DBG2("UST app event notifier %s created successfully: app = '%s': pid = %d), object = %p",
2234 event_notifier
.event
.name
, app
->name
, app
->pid
,
2235 ua_event_notifier_rule
->obj
);
2237 health_code_update();
2239 /* Set filter if one is present. */
2240 if (ua_event_notifier_rule
->filter
) {
2241 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2242 ua_event_notifier_rule
->obj
);
2248 /* Set exclusions for the event. */
2249 if (ua_event_notifier_rule
->exclusion
) {
2250 ret
= set_ust_object_exclusions(app
,
2251 ua_event_notifier_rule
->exclusion
,
2252 ua_event_notifier_rule
->obj
);
2258 /* Set the capture bytecodes. */
2259 cond_status
= lttng_condition_event_rule_matches_get_capture_descriptor_count(
2260 condition
, &capture_bytecode_count
);
2261 LTTNG_ASSERT(cond_status
== LTTNG_CONDITION_STATUS_OK
);
2263 for (i
= 0; i
< capture_bytecode_count
; i
++) {
2264 const struct lttng_bytecode
*capture_bytecode
=
2265 lttng_condition_event_rule_matches_get_capture_bytecode_at_index(
2268 ret
= set_ust_capture(app
, capture_bytecode
, i
,
2269 ua_event_notifier_rule
->obj
);
2276 * We now need to explicitly enable the event, since it
2277 * is disabled at creation.
2279 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2282 * If we hit an EPERM, something is wrong with our enable call.
2283 * If we get an EEXIST, there is a problem on the tracer side
2284 * since we just created it.
2287 case -LTTNG_UST_ERR_PERM
:
2288 /* Code flow problem. */
2290 case -LTTNG_UST_ERR_EXIST
:
2291 /* It's OK for our use case. */
2301 ua_event_notifier_rule
->enabled
= true;
2304 health_code_update();
2309 * Copy data between an UST app event and a LTT event.
2311 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2312 struct ltt_ust_event
*uevent
)
2314 size_t exclusion_alloc_size
;
2316 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2317 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2319 ua_event
->enabled
= uevent
->enabled
;
2321 /* Copy event attributes */
2322 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2324 /* Copy filter bytecode */
2325 if (uevent
->filter
) {
2326 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2327 /* Filter might be NULL here in case of ENONEM. */
2330 /* Copy exclusion data */
2331 if (uevent
->exclusion
) {
2332 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2333 LTTNG_UST_ABI_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2334 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2335 if (ua_event
->exclusion
== NULL
) {
2338 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2339 exclusion_alloc_size
);
2345 * Copy data between an UST app channel and a LTT channel.
2347 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2348 struct ltt_ust_channel
*uchan
)
2350 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2352 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2353 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2355 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2356 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2358 /* Copy event attributes since the layout is different. */
2359 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2360 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2361 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2362 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2363 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2364 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2365 ua_chan
->attr
.output
= uchan
->attr
.output
;
2366 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2369 * Note that the attribute channel type is not set since the channel on the
2370 * tracing registry side does not have this information.
2373 ua_chan
->enabled
= uchan
->enabled
;
2374 ua_chan
->tracing_channel_id
= uchan
->id
;
2376 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2380 * Copy data between a UST app session and a regular LTT session.
2382 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2383 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2385 struct tm
*timeinfo
;
2388 char tmp_shm_path
[PATH_MAX
];
2390 timeinfo
= localtime(&app
->registration_time
);
2391 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2393 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2395 ua_sess
->tracing_id
= usess
->id
;
2396 ua_sess
->id
= get_next_session_id();
2397 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2398 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2399 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2400 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2401 ua_sess
->buffer_type
= usess
->buffer_type
;
2402 ua_sess
->bits_per_long
= app
->bits_per_long
;
2404 /* There is only one consumer object per session possible. */
2405 consumer_output_get(usess
->consumer
);
2406 ua_sess
->consumer
= usess
->consumer
;
2408 ua_sess
->output_traces
= usess
->output_traces
;
2409 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2410 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2411 &usess
->metadata_attr
);
2413 switch (ua_sess
->buffer_type
) {
2414 case LTTNG_BUFFER_PER_PID
:
2415 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2416 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2419 case LTTNG_BUFFER_PER_UID
:
2420 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2421 DEFAULT_UST_TRACE_UID_PATH
,
2422 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2423 app
->bits_per_long
);
2430 PERROR("asprintf UST shadow copy session");
2435 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2436 sizeof(ua_sess
->root_shm_path
));
2437 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2438 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2439 sizeof(ua_sess
->shm_path
));
2440 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2441 if (ua_sess
->shm_path
[0]) {
2442 switch (ua_sess
->buffer_type
) {
2443 case LTTNG_BUFFER_PER_PID
:
2444 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2445 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2446 app
->name
, app
->pid
, datetime
);
2448 case LTTNG_BUFFER_PER_UID
:
2449 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2450 "/" DEFAULT_UST_TRACE_UID_PATH
,
2451 app
->uid
, app
->bits_per_long
);
2458 PERROR("sprintf UST shadow copy session");
2462 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2463 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2464 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2469 consumer_output_put(ua_sess
->consumer
);
2473 * Lookup sesison wrapper.
2476 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2477 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2479 /* Get right UST app session from app */
2480 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2484 * Return ust app session from the app session hashtable using the UST session
2487 static struct ust_app_session
*lookup_session_by_app(
2488 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2490 struct lttng_ht_iter iter
;
2491 struct lttng_ht_node_u64
*node
;
2493 __lookup_session_by_app(usess
, app
, &iter
);
2494 node
= lttng_ht_iter_get_node_u64(&iter
);
2499 return caa_container_of(node
, struct ust_app_session
, node
);
2506 * Setup buffer registry per PID for the given session and application. If none
2507 * is found, a new one is created, added to the global registry and
2508 * initialized. If regp is valid, it's set with the newly created object.
2510 * Return 0 on success or else a negative value.
2512 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2513 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2516 struct buffer_reg_pid
*reg_pid
;
2518 LTTNG_ASSERT(ua_sess
);
2523 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2526 * This is the create channel path meaning that if there is NO
2527 * registry available, we have to create one for this session.
2529 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2530 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2538 /* Initialize registry. */
2539 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2540 app
->bits_per_long
, app
->uint8_t_alignment
,
2541 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2542 app
->uint64_t_alignment
, app
->long_alignment
,
2543 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2544 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2545 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2546 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2547 ua_sess
->tracing_id
,
2551 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2552 * destroy the buffer registry, because it is always expected
2553 * that if the buffer registry can be found, its ust registry is
2556 buffer_reg_pid_destroy(reg_pid
);
2560 buffer_reg_pid_add(reg_pid
);
2562 DBG3("UST app buffer registry per PID created successfully");
2574 * Setup buffer registry per UID for the given session and application. If none
2575 * is found, a new one is created, added to the global registry and
2576 * initialized. If regp is valid, it's set with the newly created object.
2578 * Return 0 on success or else a negative value.
2580 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2581 struct ust_app_session
*ua_sess
,
2582 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2585 struct buffer_reg_uid
*reg_uid
;
2587 LTTNG_ASSERT(usess
);
2592 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2595 * This is the create channel path meaning that if there is NO
2596 * registry available, we have to create one for this session.
2598 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2599 LTTNG_DOMAIN_UST
, ®_uid
,
2600 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2608 /* Initialize registry. */
2609 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2610 app
->bits_per_long
, app
->uint8_t_alignment
,
2611 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2612 app
->uint64_t_alignment
, app
->long_alignment
,
2613 app
->byte_order
, app
->version
.major
,
2614 app
->version
.minor
, reg_uid
->root_shm_path
,
2615 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2616 ua_sess
->tracing_id
, app
->uid
);
2619 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2620 * destroy the buffer registry, because it is always expected
2621 * that if the buffer registry can be found, its ust registry is
2624 buffer_reg_uid_destroy(reg_uid
, NULL
);
2627 /* Add node to teardown list of the session. */
2628 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2630 buffer_reg_uid_add(reg_uid
);
2632 DBG3("UST app buffer registry per UID created successfully");
2643 * Create a session on the tracer side for the given app.
2645 * On success, ua_sess_ptr is populated with the session pointer or else left
2646 * untouched. If the session was created, is_created is set to 1. On error,
2647 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2650 * Returns 0 on success or else a negative code which is either -ENOMEM or
2651 * -ENOTCONN which is the default code if the lttng_ust_ctl_create_session fails.
2653 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2654 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2657 int ret
, created
= 0;
2658 struct ust_app_session
*ua_sess
;
2660 LTTNG_ASSERT(usess
);
2662 LTTNG_ASSERT(ua_sess_ptr
);
2664 health_code_update();
2666 ua_sess
= lookup_session_by_app(usess
, app
);
2667 if (ua_sess
== NULL
) {
2668 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2669 app
->pid
, usess
->id
);
2670 ua_sess
= alloc_ust_app_session();
2671 if (ua_sess
== NULL
) {
2672 /* Only malloc can failed so something is really wrong */
2676 shadow_copy_session(ua_sess
, usess
, app
);
2680 switch (usess
->buffer_type
) {
2681 case LTTNG_BUFFER_PER_PID
:
2682 /* Init local registry. */
2683 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2685 delete_ust_app_session(-1, ua_sess
, app
);
2689 case LTTNG_BUFFER_PER_UID
:
2690 /* Look for a global registry. If none exists, create one. */
2691 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2693 delete_ust_app_session(-1, ua_sess
, app
);
2703 health_code_update();
2705 if (ua_sess
->handle
== -1) {
2706 pthread_mutex_lock(&app
->sock_lock
);
2707 ret
= lttng_ust_ctl_create_session(app
->sock
);
2708 pthread_mutex_unlock(&app
->sock_lock
);
2710 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2711 DBG("UST app creating session failed. Application is dead: pid = %d, sock = %d",
2712 app
->pid
, app
->sock
);
2714 } else if (ret
== -EAGAIN
) {
2715 DBG("UST app creating session failed. Communication time out: pid = %d, sock = %d",
2716 app
->pid
, app
->sock
);
2719 ERR("UST app creating session failed with ret %d: pid = %d, sock =%d",
2720 ret
, app
->pid
, app
->sock
);
2722 delete_ust_app_session(-1, ua_sess
, app
);
2723 if (ret
!= -ENOMEM
) {
2725 * Tracer is probably gone or got an internal error so let's
2726 * behave like it will soon unregister or not usable.
2733 ua_sess
->handle
= ret
;
2735 /* Add ust app session to app's HT */
2736 lttng_ht_node_init_u64(&ua_sess
->node
,
2737 ua_sess
->tracing_id
);
2738 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2739 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2740 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2741 &ua_sess
->ust_objd_node
);
2743 DBG2("UST app session created successfully with handle %d", ret
);
2746 *ua_sess_ptr
= ua_sess
;
2748 *is_created
= created
;
2751 /* Everything went well. */
2755 health_code_update();
2760 * Match function for a hash table lookup of ust_app_ctx.
2762 * It matches an ust app context based on the context type and, in the case
2763 * of perf counters, their name.
2765 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2767 struct ust_app_ctx
*ctx
;
2768 const struct lttng_ust_context_attr
*key
;
2773 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2777 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2782 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
2783 if (strncmp(key
->u
.perf_counter
.name
,
2784 ctx
->ctx
.u
.perf_counter
.name
,
2785 sizeof(key
->u
.perf_counter
.name
))) {
2789 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
2790 if (strcmp(key
->u
.app_ctx
.provider_name
,
2791 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2792 strcmp(key
->u
.app_ctx
.ctx_name
,
2793 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2809 * Lookup for an ust app context from an lttng_ust_context.
2811 * Must be called while holding RCU read side lock.
2812 * Return an ust_app_ctx object or NULL on error.
2815 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2816 struct lttng_ust_context_attr
*uctx
)
2818 struct lttng_ht_iter iter
;
2819 struct lttng_ht_node_ulong
*node
;
2820 struct ust_app_ctx
*app_ctx
= NULL
;
2825 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2826 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2827 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2828 node
= lttng_ht_iter_get_node_ulong(&iter
);
2833 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2840 * Create a context for the channel on the tracer.
2842 * Called with UST app session lock held and a RCU read side lock.
2845 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2846 struct lttng_ust_context_attr
*uctx
,
2847 struct ust_app
*app
)
2850 struct ust_app_ctx
*ua_ctx
;
2852 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2854 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2860 ua_ctx
= alloc_ust_app_ctx(uctx
);
2861 if (ua_ctx
== NULL
) {
2867 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2868 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2869 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2871 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2881 * Enable on the tracer side a ust app event for the session and channel.
2883 * Called with UST app session lock held.
2886 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2887 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2891 ret
= enable_ust_object(app
, ua_event
->obj
);
2896 ua_event
->enabled
= 1;
2903 * Disable on the tracer side a ust app event for the session and channel.
2905 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2906 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2910 ret
= disable_ust_object(app
, ua_event
->obj
);
2915 ua_event
->enabled
= 0;
2922 * Lookup ust app channel for session and disable it on the tracer side.
2925 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2926 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2930 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2935 ua_chan
->enabled
= 0;
2942 * Lookup ust app channel for session and enable it on the tracer side. This
2943 * MUST be called with a RCU read side lock acquired.
2945 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2946 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2949 struct lttng_ht_iter iter
;
2950 struct lttng_ht_node_str
*ua_chan_node
;
2951 struct ust_app_channel
*ua_chan
;
2953 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2954 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2955 if (ua_chan_node
== NULL
) {
2956 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2957 uchan
->name
, ua_sess
->tracing_id
);
2961 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2963 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2973 * Ask the consumer to create a channel and get it if successful.
2975 * Called with UST app session lock held.
2977 * Return 0 on success or else a negative value.
2979 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2980 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2981 int bitness
, struct ust_registry_session
*registry
,
2982 uint64_t trace_archive_id
)
2985 unsigned int nb_fd
= 0;
2986 struct consumer_socket
*socket
;
2988 LTTNG_ASSERT(usess
);
2989 LTTNG_ASSERT(ua_sess
);
2990 LTTNG_ASSERT(ua_chan
);
2991 LTTNG_ASSERT(registry
);
2994 health_code_update();
2996 /* Get the right consumer socket for the application. */
2997 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
3003 health_code_update();
3005 /* Need one fd for the channel. */
3006 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3008 ERR("Exhausted number of available FD upon create channel");
3013 * Ask consumer to create channel. The consumer will return the number of
3014 * stream we have to expect.
3016 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
3017 registry
, usess
->current_trace_chunk
);
3023 * Compute the number of fd needed before receiving them. It must be 2 per
3024 * stream (2 being the default value here).
3026 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
3028 /* Reserve the amount of file descriptor we need. */
3029 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
3031 ERR("Exhausted number of available FD upon create channel");
3032 goto error_fd_get_stream
;
3035 health_code_update();
3038 * Now get the channel from the consumer. This call will populate the stream
3039 * list of that channel and set the ust objects.
3041 if (usess
->consumer
->enabled
) {
3042 ret
= ust_consumer_get_channel(socket
, ua_chan
);
3052 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
3053 error_fd_get_stream
:
3055 * Initiate a destroy channel on the consumer since we had an error
3056 * handling it on our side. The return value is of no importance since we
3057 * already have a ret value set by the previous error that we need to
3060 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
3062 lttng_fd_put(LTTNG_FD_APPS
, 1);
3064 health_code_update();
3070 * Duplicate the ust data object of the ust app stream and save it in the
3071 * buffer registry stream.
3073 * Return 0 on success or else a negative value.
3075 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
3076 struct ust_app_stream
*stream
)
3080 LTTNG_ASSERT(reg_stream
);
3081 LTTNG_ASSERT(stream
);
3083 /* Duplicating a stream requires 2 new fds. Reserve them. */
3084 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3086 ERR("Exhausted number of available FD upon duplicate stream");
3090 /* Duplicate object for stream once the original is in the registry. */
3091 ret
= lttng_ust_ctl_duplicate_ust_object_data(&stream
->obj
,
3092 reg_stream
->obj
.ust
);
3094 ERR("Duplicate stream obj from %p to %p failed with ret %d",
3095 reg_stream
->obj
.ust
, stream
->obj
, ret
);
3096 lttng_fd_put(LTTNG_FD_APPS
, 2);
3099 stream
->handle
= stream
->obj
->handle
;
3106 * Duplicate the ust data object of the ust app. channel and save it in the
3107 * buffer registry channel.
3109 * Return 0 on success or else a negative value.
3111 static int duplicate_channel_object(struct buffer_reg_channel
*buf_reg_chan
,
3112 struct ust_app_channel
*ua_chan
)
3116 LTTNG_ASSERT(buf_reg_chan
);
3117 LTTNG_ASSERT(ua_chan
);
3119 /* Duplicating a channel requires 1 new fd. Reserve it. */
3120 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3122 ERR("Exhausted number of available FD upon duplicate channel");
3126 /* Duplicate object for stream once the original is in the registry. */
3127 ret
= lttng_ust_ctl_duplicate_ust_object_data(&ua_chan
->obj
, buf_reg_chan
->obj
.ust
);
3129 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3130 buf_reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
3133 ua_chan
->handle
= ua_chan
->obj
->handle
;
3138 lttng_fd_put(LTTNG_FD_APPS
, 1);
3144 * For a given channel buffer registry, setup all streams of the given ust
3145 * application channel.
3147 * Return 0 on success or else a negative value.
3149 static int setup_buffer_reg_streams(struct buffer_reg_channel
*buf_reg_chan
,
3150 struct ust_app_channel
*ua_chan
,
3151 struct ust_app
*app
)
3154 struct ust_app_stream
*stream
, *stmp
;
3156 LTTNG_ASSERT(buf_reg_chan
);
3157 LTTNG_ASSERT(ua_chan
);
3159 DBG2("UST app setup buffer registry stream");
3161 /* Send all streams to application. */
3162 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3163 struct buffer_reg_stream
*reg_stream
;
3165 ret
= buffer_reg_stream_create(®_stream
);
3171 * Keep original pointer and nullify it in the stream so the delete
3172 * stream call does not release the object.
3174 reg_stream
->obj
.ust
= stream
->obj
;
3176 buffer_reg_stream_add(reg_stream
, buf_reg_chan
);
3178 /* We don't need the streams anymore. */
3179 cds_list_del(&stream
->list
);
3180 delete_ust_app_stream(-1, stream
, app
);
3188 * Create a buffer registry channel for the given session registry and
3189 * application channel object. If regp pointer is valid, it's set with the
3190 * created object. Important, the created object is NOT added to the session
3191 * registry hash table.
3193 * Return 0 on success else a negative value.
3195 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3196 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3199 struct buffer_reg_channel
*buf_reg_chan
= NULL
;
3201 LTTNG_ASSERT(reg_sess
);
3202 LTTNG_ASSERT(ua_chan
);
3204 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3206 /* Create buffer registry channel. */
3207 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, &buf_reg_chan
);
3211 LTTNG_ASSERT(buf_reg_chan
);
3212 buf_reg_chan
->consumer_key
= ua_chan
->key
;
3213 buf_reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3214 buf_reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3216 /* Create and add a channel registry to session. */
3217 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3218 ua_chan
->tracing_channel_id
);
3222 buffer_reg_channel_add(reg_sess
, buf_reg_chan
);
3225 *regp
= buf_reg_chan
;
3231 /* Safe because the registry channel object was not added to any HT. */
3232 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3238 * Setup buffer registry channel for the given session registry and application
3239 * channel object. If regp pointer is valid, it's set with the created object.
3241 * Return 0 on success else a negative value.
3243 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3244 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*buf_reg_chan
,
3245 struct ust_app
*app
)
3249 LTTNG_ASSERT(reg_sess
);
3250 LTTNG_ASSERT(buf_reg_chan
);
3251 LTTNG_ASSERT(ua_chan
);
3252 LTTNG_ASSERT(ua_chan
->obj
);
3254 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3256 /* Setup all streams for the registry. */
3257 ret
= setup_buffer_reg_streams(buf_reg_chan
, ua_chan
, app
);
3262 buf_reg_chan
->obj
.ust
= ua_chan
->obj
;
3263 ua_chan
->obj
= NULL
;
3268 buffer_reg_channel_remove(reg_sess
, buf_reg_chan
);
3269 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3274 * Send buffer registry channel to the application.
3276 * Return 0 on success else a negative value.
3278 static int send_channel_uid_to_ust(struct buffer_reg_channel
*buf_reg_chan
,
3279 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3280 struct ust_app_channel
*ua_chan
)
3283 struct buffer_reg_stream
*reg_stream
;
3285 LTTNG_ASSERT(buf_reg_chan
);
3287 LTTNG_ASSERT(ua_sess
);
3288 LTTNG_ASSERT(ua_chan
);
3290 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3292 ret
= duplicate_channel_object(buf_reg_chan
, ua_chan
);
3297 /* Send channel to the application. */
3298 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3299 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3300 ret
= -ENOTCONN
; /* Caused by app exiting. */
3302 } else if (ret
== -EAGAIN
) {
3303 /* Caused by timeout. */
3304 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
"\".",
3305 app
->pid
, ua_chan
->name
, ua_sess
->tracing_id
);
3306 /* Treat this the same way as an application that is exiting. */
3309 } else if (ret
< 0) {
3313 health_code_update();
3315 /* Send all streams to application. */
3316 pthread_mutex_lock(&buf_reg_chan
->stream_list_lock
);
3317 cds_list_for_each_entry(reg_stream
, &buf_reg_chan
->streams
, lnode
) {
3318 struct ust_app_stream stream
;
3320 ret
= duplicate_stream_object(reg_stream
, &stream
);
3322 goto error_stream_unlock
;
3325 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3327 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3328 ret
= -ENOTCONN
; /* Caused by app exiting. */
3329 } else if (ret
== -EAGAIN
) {
3331 * Caused by timeout.
3332 * Treat this the same way as an application
3335 WARN("Communication with application %d timed out on send_stream for stream \"%s\" of channel \"%s\" of session \"%" PRIu64
"\".",
3336 app
->pid
, stream
.name
,
3338 ua_sess
->tracing_id
);
3341 (void) release_ust_app_stream(-1, &stream
, app
);
3342 goto error_stream_unlock
;
3346 * The return value is not important here. This function will output an
3349 (void) release_ust_app_stream(-1, &stream
, app
);
3351 ua_chan
->is_sent
= 1;
3353 error_stream_unlock
:
3354 pthread_mutex_unlock(&buf_reg_chan
->stream_list_lock
);
3360 * Create and send to the application the created buffers with per UID buffers.
3362 * This MUST be called with a RCU read side lock acquired.
3363 * The session list lock and the session's lock must be acquired.
3365 * Return 0 on success else a negative value.
3367 static int create_channel_per_uid(struct ust_app
*app
,
3368 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3369 struct ust_app_channel
*ua_chan
)
3372 struct buffer_reg_uid
*reg_uid
;
3373 struct buffer_reg_channel
*buf_reg_chan
;
3374 struct ltt_session
*session
= NULL
;
3375 enum lttng_error_code notification_ret
;
3376 struct ust_registry_channel
*ust_reg_chan
;
3379 LTTNG_ASSERT(usess
);
3380 LTTNG_ASSERT(ua_sess
);
3381 LTTNG_ASSERT(ua_chan
);
3383 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3385 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3387 * The session creation handles the creation of this global registry
3388 * object. If none can be find, there is a code flow problem or a
3391 LTTNG_ASSERT(reg_uid
);
3393 buf_reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3399 /* Create the buffer registry channel object. */
3400 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, &buf_reg_chan
);
3402 ERR("Error creating the UST channel \"%s\" registry instance",
3407 session
= session_find_by_id(ua_sess
->tracing_id
);
3408 LTTNG_ASSERT(session
);
3409 LTTNG_ASSERT(pthread_mutex_trylock(&session
->lock
));
3410 LTTNG_ASSERT(session_trylock_list());
3413 * Create the buffers on the consumer side. This call populates the
3414 * ust app channel object with all streams and data object.
3416 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3417 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3418 session
->most_recent_chunk_id
.value
);
3420 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3424 * Let's remove the previously created buffer registry channel so
3425 * it's not visible anymore in the session registry.
3427 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3428 ua_chan
->tracing_channel_id
, false);
3429 buffer_reg_channel_remove(reg_uid
->registry
, buf_reg_chan
);
3430 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3435 * Setup the streams and add it to the session registry.
3437 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3438 ua_chan
, buf_reg_chan
, app
);
3440 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3444 /* Notify the notification subsystem of the channel's creation. */
3445 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3446 ust_reg_chan
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3447 ua_chan
->tracing_channel_id
);
3448 LTTNG_ASSERT(ust_reg_chan
);
3449 ust_reg_chan
->consumer_key
= ua_chan
->key
;
3450 ust_reg_chan
= NULL
;
3451 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3453 notification_ret
= notification_thread_command_add_channel(
3454 the_notification_thread_handle
, session
->name
,
3455 lttng_credentials_get_uid(
3456 &ua_sess
->effective_credentials
),
3457 lttng_credentials_get_gid(
3458 &ua_sess
->effective_credentials
),
3459 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3460 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3461 if (notification_ret
!= LTTNG_OK
) {
3462 ret
= - (int) notification_ret
;
3463 ERR("Failed to add channel to notification thread");
3468 /* Send buffers to the application. */
3469 ret
= send_channel_uid_to_ust(buf_reg_chan
, app
, ua_sess
, ua_chan
);
3471 if (ret
!= -ENOTCONN
) {
3472 ERR("Error sending channel to application");
3479 session_put(session
);
3485 * Create and send to the application the created buffers with per PID buffers.
3487 * Called with UST app session lock held.
3488 * The session list lock and the session's lock must be acquired.
3490 * Return 0 on success else a negative value.
3492 static int create_channel_per_pid(struct ust_app
*app
,
3493 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3494 struct ust_app_channel
*ua_chan
)
3497 struct ust_registry_session
*registry
;
3498 enum lttng_error_code cmd_ret
;
3499 struct ltt_session
*session
= NULL
;
3500 uint64_t chan_reg_key
;
3501 struct ust_registry_channel
*ust_reg_chan
;
3504 LTTNG_ASSERT(usess
);
3505 LTTNG_ASSERT(ua_sess
);
3506 LTTNG_ASSERT(ua_chan
);
3508 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3512 registry
= get_session_registry(ua_sess
);
3513 /* The UST app session lock is held, registry shall not be null. */
3514 LTTNG_ASSERT(registry
);
3516 /* Create and add a new channel registry to session. */
3517 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3519 ERR("Error creating the UST channel \"%s\" registry instance",
3524 session
= session_find_by_id(ua_sess
->tracing_id
);
3525 LTTNG_ASSERT(session
);
3527 LTTNG_ASSERT(pthread_mutex_trylock(&session
->lock
));
3528 LTTNG_ASSERT(session_trylock_list());
3530 /* Create and get channel on the consumer side. */
3531 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3532 app
->bits_per_long
, registry
,
3533 session
->most_recent_chunk_id
.value
);
3535 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3537 goto error_remove_from_registry
;
3540 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3542 if (ret
!= -ENOTCONN
) {
3543 ERR("Error sending channel to application");
3545 goto error_remove_from_registry
;
3548 chan_reg_key
= ua_chan
->key
;
3549 pthread_mutex_lock(®istry
->lock
);
3550 ust_reg_chan
= ust_registry_channel_find(registry
, chan_reg_key
);
3551 LTTNG_ASSERT(ust_reg_chan
);
3552 ust_reg_chan
->consumer_key
= ua_chan
->key
;
3553 pthread_mutex_unlock(®istry
->lock
);
3555 cmd_ret
= notification_thread_command_add_channel(
3556 the_notification_thread_handle
, session
->name
,
3557 lttng_credentials_get_uid(
3558 &ua_sess
->effective_credentials
),
3559 lttng_credentials_get_gid(
3560 &ua_sess
->effective_credentials
),
3561 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3562 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3563 if (cmd_ret
!= LTTNG_OK
) {
3564 ret
= - (int) cmd_ret
;
3565 ERR("Failed to add channel to notification thread");
3566 goto error_remove_from_registry
;
3569 error_remove_from_registry
:
3571 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3576 session_put(session
);
3582 * From an already allocated ust app channel, create the channel buffers if
3583 * needed and send them to the application. This MUST be called with a RCU read
3584 * side lock acquired.
3586 * Called with UST app session lock held.
3588 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3589 * the application exited concurrently.
3591 static int ust_app_channel_send(struct ust_app
*app
,
3592 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3593 struct ust_app_channel
*ua_chan
)
3598 LTTNG_ASSERT(usess
);
3599 LTTNG_ASSERT(usess
->active
);
3600 LTTNG_ASSERT(ua_sess
);
3601 LTTNG_ASSERT(ua_chan
);
3603 /* Handle buffer type before sending the channel to the application. */
3604 switch (usess
->buffer_type
) {
3605 case LTTNG_BUFFER_PER_UID
:
3607 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3613 case LTTNG_BUFFER_PER_PID
:
3615 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3627 /* Initialize ust objd object using the received handle and add it. */
3628 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3629 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3631 /* If channel is not enabled, disable it on the tracer */
3632 if (!ua_chan
->enabled
) {
3633 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3644 * Create UST app channel and return it through ua_chanp if not NULL.
3646 * Called with UST app session lock and RCU read-side lock held.
3648 * Return 0 on success or else a negative value.
3650 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3651 struct ltt_ust_channel
*uchan
,
3652 enum lttng_ust_abi_chan_type type
, struct ltt_ust_session
*usess
,
3653 struct ust_app_channel
**ua_chanp
)
3656 struct lttng_ht_iter iter
;
3657 struct lttng_ht_node_str
*ua_chan_node
;
3658 struct ust_app_channel
*ua_chan
;
3660 /* Lookup channel in the ust app session */
3661 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3662 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3663 if (ua_chan_node
!= NULL
) {
3664 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3668 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3669 if (ua_chan
== NULL
) {
3670 /* Only malloc can fail here */
3674 shadow_copy_channel(ua_chan
, uchan
);
3676 /* Set channel type. */
3677 ua_chan
->attr
.type
= type
;
3679 /* Only add the channel if successful on the tracer side. */
3680 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3683 *ua_chanp
= ua_chan
;
3686 /* Everything went well. */
3694 * Create UST app event and create it on the tracer side.
3696 * Must be called with the RCU read side lock held.
3697 * Called with ust app session mutex held.
3700 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3701 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3702 struct ust_app
*app
)
3705 struct ust_app_event
*ua_event
;
3707 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3708 if (ua_event
== NULL
) {
3709 /* Only failure mode of alloc_ust_app_event(). */
3713 shadow_copy_event(ua_event
, uevent
);
3715 /* Create it on the tracer side */
3716 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3719 * Not found previously means that it does not exist on the
3720 * tracer. If the application reports that the event existed,
3721 * it means there is a bug in the sessiond or lttng-ust
3722 * (or corruption, etc.)
3724 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3725 ERR("Tracer for application reported that an event being created already existed: "
3726 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3728 app
->pid
, app
->ppid
, app
->uid
,
3734 add_unique_ust_app_event(ua_chan
, ua_event
);
3736 DBG2("UST app create event completed: app = '%s' pid = %d",
3737 app
->name
, app
->pid
);
3743 /* Valid. Calling here is already in a read side lock */
3744 delete_ust_app_event(-1, ua_event
, app
);
3749 * Create UST app event notifier rule and create it on the tracer side.
3751 * Must be called with the RCU read side lock held.
3752 * Called with ust app session mutex held.
3755 int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
,
3756 struct ust_app
*app
)
3759 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3761 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3762 if (ua_event_notifier_rule
== NULL
) {
3767 /* Create it on the tracer side. */
3768 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3771 * Not found previously means that it does not exist on the
3772 * tracer. If the application reports that the event existed,
3773 * it means there is a bug in the sessiond or lttng-ust
3774 * (or corruption, etc.)
3776 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3777 ERR("Tracer for application reported that an event notifier being created already exists: "
3778 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3779 lttng_trigger_get_tracer_token(trigger
),
3780 app
->pid
, app
->ppid
, app
->uid
,
3786 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3787 &ua_event_notifier_rule
->node
);
3789 DBG2("UST app create token event rule completed: app = '%s', pid = %d), token = %" PRIu64
,
3790 app
->name
, app
->pid
, lttng_trigger_get_tracer_token(trigger
));
3795 /* The RCU read side lock is already being held by the caller. */
3796 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3802 * Create UST metadata and open it on the tracer side.
3804 * Called with UST app session lock held and RCU read side lock.
3806 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3807 struct ust_app
*app
, struct consumer_output
*consumer
)
3810 struct ust_app_channel
*metadata
;
3811 struct consumer_socket
*socket
;
3812 struct ust_registry_session
*registry
;
3813 struct ltt_session
*session
= NULL
;
3815 LTTNG_ASSERT(ua_sess
);
3817 LTTNG_ASSERT(consumer
);
3819 registry
= get_session_registry(ua_sess
);
3820 /* The UST app session is held registry shall not be null. */
3821 LTTNG_ASSERT(registry
);
3823 pthread_mutex_lock(®istry
->lock
);
3825 /* Metadata already exists for this registry or it was closed previously */
3826 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3831 /* Allocate UST metadata */
3832 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3834 /* malloc() failed */
3839 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3841 /* Need one fd for the channel. */
3842 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3844 ERR("Exhausted number of available FD upon create metadata");
3848 /* Get the right consumer socket for the application. */
3849 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3852 goto error_consumer
;
3856 * Keep metadata key so we can identify it on the consumer side. Assign it
3857 * to the registry *before* we ask the consumer so we avoid the race of the
3858 * consumer requesting the metadata and the ask_channel call on our side
3859 * did not returned yet.
3861 registry
->metadata_key
= metadata
->key
;
3863 session
= session_find_by_id(ua_sess
->tracing_id
);
3864 LTTNG_ASSERT(session
);
3866 LTTNG_ASSERT(pthread_mutex_trylock(&session
->lock
));
3867 LTTNG_ASSERT(session_trylock_list());
3870 * Ask the metadata channel creation to the consumer. The metadata object
3871 * will be created by the consumer and kept their. However, the stream is
3872 * never added or monitored until we do a first push metadata to the
3875 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3876 registry
, session
->current_trace_chunk
);
3878 /* Nullify the metadata key so we don't try to close it later on. */
3879 registry
->metadata_key
= 0;
3880 goto error_consumer
;
3884 * The setup command will make the metadata stream be sent to the relayd,
3885 * if applicable, and the thread managing the metadatas. This is important
3886 * because after this point, if an error occurs, the only way the stream
3887 * can be deleted is to be monitored in the consumer.
3889 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3891 /* Nullify the metadata key so we don't try to close it later on. */
3892 registry
->metadata_key
= 0;
3893 goto error_consumer
;
3896 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3897 metadata
->key
, app
->pid
);
3900 lttng_fd_put(LTTNG_FD_APPS
, 1);
3901 delete_ust_app_channel(-1, metadata
, app
);
3903 pthread_mutex_unlock(®istry
->lock
);
3905 session_put(session
);
3911 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3912 * acquired before calling this function.
3914 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3916 struct ust_app
*app
= NULL
;
3917 struct lttng_ht_node_ulong
*node
;
3918 struct lttng_ht_iter iter
;
3920 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3921 node
= lttng_ht_iter_get_node_ulong(&iter
);
3923 DBG2("UST app no found with pid %d", pid
);
3927 DBG2("Found UST app by pid %d", pid
);
3929 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3936 * Allocate and init an UST app object using the registration information and
3937 * the command socket. This is called when the command socket connects to the
3940 * The object is returned on success or else NULL.
3942 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3945 struct ust_app
*lta
= NULL
;
3946 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3949 LTTNG_ASSERT(sock
>= 0);
3951 DBG3("UST app creating application for socket %d", sock
);
3953 if ((msg
->bits_per_long
== 64 &&
3954 (uatomic_read(&the_ust_consumerd64_fd
) ==
3956 (msg
->bits_per_long
== 32 &&
3957 (uatomic_read(&the_ust_consumerd32_fd
) ==
3959 ERR("Registration failed: application \"%s\" (pid: %d) has "
3960 "%d-bit long, but no consumerd for this size is available.\n",
3961 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3966 * Reserve the two file descriptors of the event source pipe. The write
3967 * end will be closed once it is passed to the application, at which
3968 * point a single 'put' will be performed.
3970 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3972 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s', pid = %d",
3973 msg
->name
, (int) msg
->pid
);
3977 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3978 if (!event_notifier_event_source_pipe
) {
3979 PERROR("Failed to open application event source pipe: '%s' (pid = %d)",
3980 msg
->name
, msg
->pid
);
3984 lta
= zmalloc(sizeof(struct ust_app
));
3987 goto error_free_pipe
;
3990 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3992 lta
->ppid
= msg
->ppid
;
3993 lta
->uid
= msg
->uid
;
3994 lta
->gid
= msg
->gid
;
3996 lta
->bits_per_long
= msg
->bits_per_long
;
3997 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3998 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3999 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
4000 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
4001 lta
->long_alignment
= msg
->long_alignment
;
4002 lta
->byte_order
= msg
->byte_order
;
4004 lta
->v_major
= msg
->major
;
4005 lta
->v_minor
= msg
->minor
;
4006 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4007 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4008 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4009 lta
->notify_sock
= -1;
4010 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4012 /* Copy name and make sure it's NULL terminated. */
4013 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
4014 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
4017 * Before this can be called, when receiving the registration information,
4018 * the application compatibility is checked. So, at this point, the
4019 * application can work with this session daemon.
4021 lta
->compatible
= 1;
4023 lta
->pid
= msg
->pid
;
4024 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
4026 pthread_mutex_init(<a
->sock_lock
, NULL
);
4027 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
4029 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
4033 lttng_pipe_destroy(event_notifier_event_source_pipe
);
4034 lttng_fd_put(LTTNG_FD_APPS
, 2);
4040 * For a given application object, add it to every hash table.
4042 void ust_app_add(struct ust_app
*app
)
4045 LTTNG_ASSERT(app
->notify_sock
>= 0);
4047 app
->registration_time
= time(NULL
);
4052 * On a re-registration, we want to kick out the previous registration of
4055 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
4058 * The socket _should_ be unique until _we_ call close. So, a add_unique
4059 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
4060 * already in the table.
4062 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
4064 /* Add application to the notify socket hash table. */
4065 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
4066 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
4068 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock =%d name:%s "
4069 "notify_sock =%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
4070 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
4077 * Set the application version into the object.
4079 * Return 0 on success else a negative value either an errno code or a
4080 * LTTng-UST error code.
4082 int ust_app_version(struct ust_app
*app
)
4088 pthread_mutex_lock(&app
->sock_lock
);
4089 ret
= lttng_ust_ctl_tracer_version(app
->sock
, &app
->version
);
4090 pthread_mutex_unlock(&app
->sock_lock
);
4092 if (ret
== -LTTNG_UST_ERR_EXITING
|| ret
== -EPIPE
) {
4093 DBG3("UST app version failed. Application is dead: pid = %d, sock = %d",
4094 app
->pid
, app
->sock
);
4095 } else if (ret
== -EAGAIN
) {
4096 WARN("UST app version failed. Communication time out: pid = %d, sock = %d",
4097 app
->pid
, app
->sock
);
4099 ERR("UST app version failed with ret %d: pid = %d, sock = %d",
4100 ret
, app
->pid
, app
->sock
);
4107 bool ust_app_supports_notifiers(const struct ust_app
*app
)
4109 return app
->v_major
>= 9;
4112 bool ust_app_supports_counters(const struct ust_app
*app
)
4114 return app
->v_major
>= 9;
4118 * Setup the base event notifier group.
4120 * Return 0 on success else a negative value either an errno code or a
4121 * LTTng-UST error code.
4123 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
4126 int event_pipe_write_fd
;
4127 struct lttng_ust_abi_object_data
*event_notifier_group
= NULL
;
4128 enum lttng_error_code lttng_ret
;
4129 enum event_notifier_error_accounting_status event_notifier_error_accounting_status
;
4133 if (!ust_app_supports_notifiers(app
)) {
4138 /* Get the write side of the pipe. */
4139 event_pipe_write_fd
= lttng_pipe_get_writefd(
4140 app
->event_notifier_group
.event_pipe
);
4142 pthread_mutex_lock(&app
->sock_lock
);
4143 ret
= lttng_ust_ctl_create_event_notifier_group(app
->sock
,
4144 event_pipe_write_fd
, &event_notifier_group
);
4145 pthread_mutex_unlock(&app
->sock_lock
);
4147 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4149 DBG3("UST app create event notifier group failed. Application is dead: pid = %d, sock = %d",
4150 app
->pid
, app
->sock
);
4151 } else if (ret
== -EAGAIN
) {
4153 WARN("UST app create event notifier group failed. Communication time out: pid = %d, sock = %d",
4154 app
->pid
, app
->sock
);
4156 ERR("UST app create event notifier group failed with ret %d: pid = %d, sock = %d, event_pipe_write_fd: %d",
4157 ret
, app
->pid
, app
->sock
, event_pipe_write_fd
);
4162 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
4164 ERR("Failed to close write end of the application's event source pipe: app = '%s' (pid = %d)",
4165 app
->name
, app
->pid
);
4170 * Release the file descriptor that was reserved for the write-end of
4173 lttng_fd_put(LTTNG_FD_APPS
, 1);
4175 lttng_ret
= notification_thread_command_add_tracer_event_source(
4176 the_notification_thread_handle
,
4177 lttng_pipe_get_readfd(
4178 app
->event_notifier_group
.event_pipe
),
4180 if (lttng_ret
!= LTTNG_OK
) {
4181 ERR("Failed to add tracer event source to notification thread");
4186 /* Assign handle only when the complete setup is valid. */
4187 app
->event_notifier_group
.object
= event_notifier_group
;
4189 event_notifier_error_accounting_status
=
4190 event_notifier_error_accounting_register_app(app
);
4191 switch (event_notifier_error_accounting_status
) {
4192 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
4194 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED
:
4195 DBG3("Failed to setup event notifier error accounting (application does not support notifier error accounting): app socket fd = %d, app name = '%s', app pid = %d",
4196 app
->sock
, app
->name
, (int) app
->pid
);
4198 goto error_accounting
;
4199 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
4200 DBG3("Failed to setup event notifier error accounting (application is dead): app socket fd = %d, app name = '%s', app pid = %d",
4201 app
->sock
, app
->name
, (int) app
->pid
);
4203 goto error_accounting
;
4205 ERR("Failed to setup event notifier error accounting for app");
4207 goto error_accounting
;
4213 lttng_ret
= notification_thread_command_remove_tracer_event_source(
4214 the_notification_thread_handle
,
4215 lttng_pipe_get_readfd(
4216 app
->event_notifier_group
.event_pipe
));
4217 if (lttng_ret
!= LTTNG_OK
) {
4218 ERR("Failed to remove application tracer event source from notification thread");
4222 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4223 free(app
->event_notifier_group
.object
);
4224 app
->event_notifier_group
.object
= NULL
;
4229 * Unregister app by removing it from the global traceable app list and freeing
4232 * The socket is already closed at this point so no close to sock.
4234 void ust_app_unregister(int sock
)
4236 struct ust_app
*lta
;
4237 struct lttng_ht_node_ulong
*node
;
4238 struct lttng_ht_iter ust_app_sock_iter
;
4239 struct lttng_ht_iter iter
;
4240 struct ust_app_session
*ua_sess
;
4245 /* Get the node reference for a call_rcu */
4246 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
4247 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
4250 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
4251 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
4254 * For per-PID buffers, perform "push metadata" and flush all
4255 * application streams before removing app from hash tables,
4256 * ensuring proper behavior of data_pending check.
4257 * Remove sessions so they are not visible during deletion.
4259 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
4261 struct ust_registry_session
*registry
;
4263 ret
= lttng_ht_del(lta
->sessions
, &iter
);
4265 /* The session was already removed so scheduled for teardown. */
4269 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4270 (void) ust_app_flush_app_session(lta
, ua_sess
);
4274 * Add session to list for teardown. This is safe since at this point we
4275 * are the only one using this list.
4277 pthread_mutex_lock(&ua_sess
->lock
);
4279 if (ua_sess
->deleted
) {
4280 pthread_mutex_unlock(&ua_sess
->lock
);
4285 * Normally, this is done in the delete session process which is
4286 * executed in the call rcu below. However, upon registration we can't
4287 * afford to wait for the grace period before pushing data or else the
4288 * data pending feature can race between the unregistration and stop
4289 * command where the data pending command is sent *before* the grace
4292 * The close metadata below nullifies the metadata pointer in the
4293 * session so the delete session will NOT push/close a second time.
4295 registry
= get_session_registry(ua_sess
);
4297 /* Push metadata for application before freeing the application. */
4298 (void) push_metadata(registry
, ua_sess
->consumer
);
4301 * Don't ask to close metadata for global per UID buffers. Close
4302 * metadata only on destroy trace session in this case. Also, the
4303 * previous push metadata could have flag the metadata registry to
4304 * close so don't send a close command if closed.
4306 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4307 /* And ask to close it for this session registry. */
4308 (void) close_metadata(registry
, ua_sess
->consumer
);
4311 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4313 pthread_mutex_unlock(&ua_sess
->lock
);
4316 /* Remove application from PID hash table */
4317 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4321 * Remove application from notify hash table. The thread handling the
4322 * notify socket could have deleted the node so ignore on error because
4323 * either way it's valid. The close of that socket is handled by the
4324 * apps_notify_thread.
4326 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4327 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4330 * Ignore return value since the node might have been removed before by an
4331 * add replace during app registration because the PID can be reassigned by
4334 iter
.iter
.node
= <a
->pid_n
.node
;
4335 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4337 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
4342 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4349 * Fill events array with all events name of all registered apps.
4351 int ust_app_list_events(struct lttng_event
**events
)
4354 size_t nbmem
, count
= 0;
4355 struct lttng_ht_iter iter
;
4356 struct ust_app
*app
;
4357 struct lttng_event
*tmp_event
;
4359 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4360 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4361 if (tmp_event
== NULL
) {
4362 PERROR("zmalloc ust app events");
4369 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4370 struct lttng_ust_abi_tracepoint_iter uiter
;
4372 health_code_update();
4374 if (!app
->compatible
) {
4376 * TODO: In time, we should notice the caller of this error by
4377 * telling him that this is a version error.
4381 pthread_mutex_lock(&app
->sock_lock
);
4382 handle
= lttng_ust_ctl_tracepoint_list(app
->sock
);
4384 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4385 ERR("UST app list events getting handle failed for app pid %d",
4388 pthread_mutex_unlock(&app
->sock_lock
);
4392 while ((ret
= lttng_ust_ctl_tracepoint_list_get(app
->sock
, handle
,
4393 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4394 /* Handle ustctl error. */
4398 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4399 ERR("UST app tp list get failed for app %d with ret %d",
4402 DBG3("UST app tp list get failed. Application is dead");
4406 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4407 if (release_ret
< 0 &&
4408 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4409 release_ret
!= -EPIPE
) {
4410 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4412 pthread_mutex_unlock(&app
->sock_lock
);
4416 health_code_update();
4417 if (count
>= nbmem
) {
4418 /* In case the realloc fails, we free the memory */
4419 struct lttng_event
*new_tmp_event
;
4422 new_nbmem
= nbmem
<< 1;
4423 DBG2("Reallocating event list from %zu to %zu entries",
4425 new_tmp_event
= realloc(tmp_event
,
4426 new_nbmem
* sizeof(struct lttng_event
));
4427 if (new_tmp_event
== NULL
) {
4430 PERROR("realloc ust app events");
4433 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4434 if (release_ret
< 0 &&
4435 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4436 release_ret
!= -EPIPE
) {
4437 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4439 pthread_mutex_unlock(&app
->sock_lock
);
4442 /* Zero the new memory */
4443 memset(new_tmp_event
+ nbmem
, 0,
4444 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4446 tmp_event
= new_tmp_event
;
4448 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4449 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4450 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_ABI_TRACEPOINT
;
4451 tmp_event
[count
].pid
= app
->pid
;
4452 tmp_event
[count
].enabled
= -1;
4455 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4456 pthread_mutex_unlock(&app
->sock_lock
);
4458 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4459 DBG3("Error releasing app handle. Application died: pid = %d, sock = %d",
4460 app
->pid
, app
->sock
);
4461 } else if (ret
== -EAGAIN
) {
4462 WARN("Error releasing app handle. Communication time out: pid = %d, sock = %d",
4463 app
->pid
, app
->sock
);
4465 ERR("Error releasing app handle with ret %d: pid = %d, sock = %d",
4466 ret
, app
->pid
, app
->sock
);
4472 *events
= tmp_event
;
4474 DBG2("UST app list events done (%zu events)", count
);
4479 health_code_update();
4484 * Fill events array with all events name of all registered apps.
4486 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4489 size_t nbmem
, count
= 0;
4490 struct lttng_ht_iter iter
;
4491 struct ust_app
*app
;
4492 struct lttng_event_field
*tmp_event
;
4494 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4495 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4496 if (tmp_event
== NULL
) {
4497 PERROR("zmalloc ust app event fields");
4504 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4505 struct lttng_ust_abi_field_iter uiter
;
4507 health_code_update();
4509 if (!app
->compatible
) {
4511 * TODO: In time, we should notice the caller of this error by
4512 * telling him that this is a version error.
4516 pthread_mutex_lock(&app
->sock_lock
);
4517 handle
= lttng_ust_ctl_tracepoint_field_list(app
->sock
);
4519 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4520 ERR("UST app list field getting handle failed for app pid %d",
4523 pthread_mutex_unlock(&app
->sock_lock
);
4527 while ((ret
= lttng_ust_ctl_tracepoint_field_list_get(app
->sock
, handle
,
4528 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4529 /* Handle ustctl error. */
4533 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4534 ERR("UST app tp list field failed for app %d with ret %d",
4537 DBG3("UST app tp list field failed. Application is dead");
4541 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4542 pthread_mutex_unlock(&app
->sock_lock
);
4543 if (release_ret
< 0 &&
4544 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4545 release_ret
!= -EPIPE
) {
4546 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4551 health_code_update();
4552 if (count
>= nbmem
) {
4553 /* In case the realloc fails, we free the memory */
4554 struct lttng_event_field
*new_tmp_event
;
4557 new_nbmem
= nbmem
<< 1;
4558 DBG2("Reallocating event field list from %zu to %zu entries",
4560 new_tmp_event
= realloc(tmp_event
,
4561 new_nbmem
* sizeof(struct lttng_event_field
));
4562 if (new_tmp_event
== NULL
) {
4565 PERROR("realloc ust app event fields");
4568 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4569 pthread_mutex_unlock(&app
->sock_lock
);
4571 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4572 release_ret
!= -EPIPE
) {
4573 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4577 /* Zero the new memory */
4578 memset(new_tmp_event
+ nbmem
, 0,
4579 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4581 tmp_event
= new_tmp_event
;
4584 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4585 /* Mapping between these enums matches 1 to 1. */
4586 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4587 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4589 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4590 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4591 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4592 tmp_event
[count
].event
.pid
= app
->pid
;
4593 tmp_event
[count
].event
.enabled
= -1;
4596 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4597 pthread_mutex_unlock(&app
->sock_lock
);
4599 ret
!= -LTTNG_UST_ERR_EXITING
&&
4601 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4606 *fields
= tmp_event
;
4608 DBG2("UST app list event fields done (%zu events)", count
);
4613 health_code_update();
4618 * Free and clean all traceable apps of the global list.
4620 * Should _NOT_ be called with RCU read-side lock held.
4622 void ust_app_clean_list(void)
4625 struct ust_app
*app
;
4626 struct lttng_ht_iter iter
;
4628 DBG2("UST app cleaning registered apps hash table");
4632 /* Cleanup notify socket hash table */
4633 if (ust_app_ht_by_notify_sock
) {
4634 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4635 notify_sock_n
.node
) {
4637 * Assert that all notifiers are gone as all triggers
4638 * are unregistered prior to this clean-up.
4640 LTTNG_ASSERT(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4642 ust_app_notify_sock_unregister(app
->notify_sock
);
4647 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4648 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4650 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4654 /* Cleanup socket hash table */
4655 if (ust_app_ht_by_sock
) {
4656 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4658 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4665 /* Destroy is done only when the ht is empty */
4667 ht_cleanup_push(ust_app_ht
);
4669 if (ust_app_ht_by_sock
) {
4670 ht_cleanup_push(ust_app_ht_by_sock
);
4672 if (ust_app_ht_by_notify_sock
) {
4673 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4678 * Init UST app hash table.
4680 int ust_app_ht_alloc(void)
4682 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4686 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4687 if (!ust_app_ht_by_sock
) {
4690 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4691 if (!ust_app_ht_by_notify_sock
) {
4698 * For a specific UST session, disable the channel for all registered apps.
4700 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4701 struct ltt_ust_channel
*uchan
)
4704 struct lttng_ht_iter iter
;
4705 struct lttng_ht_node_str
*ua_chan_node
;
4706 struct ust_app
*app
;
4707 struct ust_app_session
*ua_sess
;
4708 struct ust_app_channel
*ua_chan
;
4710 LTTNG_ASSERT(usess
->active
);
4711 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4712 uchan
->name
, usess
->id
);
4716 /* For every registered applications */
4717 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4718 struct lttng_ht_iter uiter
;
4719 if (!app
->compatible
) {
4721 * TODO: In time, we should notice the caller of this error by
4722 * telling him that this is a version error.
4726 ua_sess
= lookup_session_by_app(usess
, app
);
4727 if (ua_sess
== NULL
) {
4732 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4733 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4734 /* If the session if found for the app, the channel must be there */
4735 LTTNG_ASSERT(ua_chan_node
);
4737 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4738 /* The channel must not be already disabled */
4739 LTTNG_ASSERT(ua_chan
->enabled
== 1);
4741 /* Disable channel onto application */
4742 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4744 /* XXX: We might want to report this error at some point... */
4754 * For a specific UST session, enable the channel for all registered apps.
4756 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4757 struct ltt_ust_channel
*uchan
)
4760 struct lttng_ht_iter iter
;
4761 struct ust_app
*app
;
4762 struct ust_app_session
*ua_sess
;
4764 LTTNG_ASSERT(usess
->active
);
4765 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4766 uchan
->name
, usess
->id
);
4770 /* For every registered applications */
4771 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4772 if (!app
->compatible
) {
4774 * TODO: In time, we should notice the caller of this error by
4775 * telling him that this is a version error.
4779 ua_sess
= lookup_session_by_app(usess
, app
);
4780 if (ua_sess
== NULL
) {
4784 /* Enable channel onto application */
4785 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4787 /* XXX: We might want to report this error at some point... */
4797 * Disable an event in a channel and for a specific session.
4799 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4800 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4803 struct lttng_ht_iter iter
, uiter
;
4804 struct lttng_ht_node_str
*ua_chan_node
;
4805 struct ust_app
*app
;
4806 struct ust_app_session
*ua_sess
;
4807 struct ust_app_channel
*ua_chan
;
4808 struct ust_app_event
*ua_event
;
4810 LTTNG_ASSERT(usess
->active
);
4811 DBG("UST app disabling event %s for all apps in channel "
4812 "%s for session id %" PRIu64
,
4813 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4817 /* For all registered applications */
4818 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4819 if (!app
->compatible
) {
4821 * TODO: In time, we should notice the caller of this error by
4822 * telling him that this is a version error.
4826 ua_sess
= lookup_session_by_app(usess
, app
);
4827 if (ua_sess
== NULL
) {
4832 /* Lookup channel in the ust app session */
4833 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4834 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4835 if (ua_chan_node
== NULL
) {
4836 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4837 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4840 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4842 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4843 uevent
->filter
, uevent
->attr
.loglevel
,
4845 if (ua_event
== NULL
) {
4846 DBG2("Event %s not found in channel %s for app pid %d."
4847 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4851 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4853 /* XXX: Report error someday... */
4862 /* The ua_sess lock must be held by the caller. */
4864 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4865 struct ust_app_session
*ua_sess
,
4866 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4867 struct ust_app_channel
**_ua_chan
)
4870 struct ust_app_channel
*ua_chan
= NULL
;
4872 LTTNG_ASSERT(ua_sess
);
4873 ASSERT_LOCKED(ua_sess
->lock
);
4875 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4876 sizeof(uchan
->name
))) {
4877 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4881 struct ltt_ust_context
*uctx
= NULL
;
4884 * Create channel onto application and synchronize its
4887 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4888 LTTNG_UST_ABI_CHAN_PER_CPU
, usess
,
4894 ret
= ust_app_channel_send(app
, usess
,
4901 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4902 ret
= create_ust_app_channel_context(ua_chan
,
4915 * The application's socket is not valid. Either a bad socket
4916 * or a timeout on it. We can't inform the caller that for a
4917 * specific app, the session failed so lets continue here.
4919 ret
= 0; /* Not an error. */
4927 if (ret
== 0 && _ua_chan
) {
4929 * Only return the application's channel on success. Note
4930 * that the channel can still be part of the application's
4931 * channel hashtable on error.
4933 *_ua_chan
= ua_chan
;
4939 * Enable event for a specific session and channel on the tracer.
4941 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4942 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4945 struct lttng_ht_iter iter
, uiter
;
4946 struct lttng_ht_node_str
*ua_chan_node
;
4947 struct ust_app
*app
;
4948 struct ust_app_session
*ua_sess
;
4949 struct ust_app_channel
*ua_chan
;
4950 struct ust_app_event
*ua_event
;
4952 LTTNG_ASSERT(usess
->active
);
4953 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4954 uevent
->attr
.name
, usess
->id
);
4957 * NOTE: At this point, this function is called only if the session and
4958 * channel passed are already created for all apps. and enabled on the
4964 /* For all registered applications */
4965 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4966 if (!app
->compatible
) {
4968 * TODO: In time, we should notice the caller of this error by
4969 * telling him that this is a version error.
4973 ua_sess
= lookup_session_by_app(usess
, app
);
4975 /* The application has problem or is probably dead. */
4979 pthread_mutex_lock(&ua_sess
->lock
);
4981 if (ua_sess
->deleted
) {
4982 pthread_mutex_unlock(&ua_sess
->lock
);
4986 /* Lookup channel in the ust app session */
4987 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4988 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4990 * It is possible that the channel cannot be found is
4991 * the channel/event creation occurs concurrently with
4992 * an application exit.
4994 if (!ua_chan_node
) {
4995 pthread_mutex_unlock(&ua_sess
->lock
);
4999 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5001 /* Get event node */
5002 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5003 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5004 if (ua_event
== NULL
) {
5005 DBG3("UST app enable event %s not found for app PID %d."
5006 "Skipping app", uevent
->attr
.name
, app
->pid
);
5010 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
5012 pthread_mutex_unlock(&ua_sess
->lock
);
5016 pthread_mutex_unlock(&ua_sess
->lock
);
5025 * For a specific existing UST session and UST channel, creates the event for
5026 * all registered apps.
5028 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
5029 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
5032 struct lttng_ht_iter iter
, uiter
;
5033 struct lttng_ht_node_str
*ua_chan_node
;
5034 struct ust_app
*app
;
5035 struct ust_app_session
*ua_sess
;
5036 struct ust_app_channel
*ua_chan
;
5038 LTTNG_ASSERT(usess
->active
);
5039 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
5040 uevent
->attr
.name
, usess
->id
);
5044 /* For all registered applications */
5045 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5046 if (!app
->compatible
) {
5048 * TODO: In time, we should notice the caller of this error by
5049 * telling him that this is a version error.
5053 ua_sess
= lookup_session_by_app(usess
, app
);
5055 /* The application has problem or is probably dead. */
5059 pthread_mutex_lock(&ua_sess
->lock
);
5061 if (ua_sess
->deleted
) {
5062 pthread_mutex_unlock(&ua_sess
->lock
);
5066 /* Lookup channel in the ust app session */
5067 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5068 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5069 /* If the channel is not found, there is a code flow error */
5070 LTTNG_ASSERT(ua_chan_node
);
5072 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5074 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5075 pthread_mutex_unlock(&ua_sess
->lock
);
5077 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
5078 /* Possible value at this point: -ENOMEM. If so, we stop! */
5081 DBG2("UST app event %s already exist on app PID %d",
5082 uevent
->attr
.name
, app
->pid
);
5092 * Start tracing for a specific UST session and app.
5094 * Called with UST app session lock held.
5098 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5101 struct ust_app_session
*ua_sess
;
5103 DBG("Starting tracing for ust app pid %d", app
->pid
);
5107 if (!app
->compatible
) {
5111 ua_sess
= lookup_session_by_app(usess
, app
);
5112 if (ua_sess
== NULL
) {
5113 /* The session is in teardown process. Ignore and continue. */
5117 pthread_mutex_lock(&ua_sess
->lock
);
5119 if (ua_sess
->deleted
) {
5120 pthread_mutex_unlock(&ua_sess
->lock
);
5124 if (ua_sess
->enabled
) {
5125 pthread_mutex_unlock(&ua_sess
->lock
);
5129 /* Upon restart, we skip the setup, already done */
5130 if (ua_sess
->started
) {
5134 health_code_update();
5137 /* This starts the UST tracing */
5138 pthread_mutex_lock(&app
->sock_lock
);
5139 ret
= lttng_ust_ctl_start_session(app
->sock
, ua_sess
->handle
);
5140 pthread_mutex_unlock(&app
->sock_lock
);
5142 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5143 DBG3("UST app start session failed. Application is dead: pid = %d, sock = %d",
5144 app
->pid
, app
->sock
);
5145 pthread_mutex_unlock(&ua_sess
->lock
);
5147 } else if (ret
== -EAGAIN
) {
5148 WARN("UST app start session failed. Communication time out: pid = %d, sock = %d",
5149 app
->pid
, app
->sock
);
5150 pthread_mutex_unlock(&ua_sess
->lock
);
5154 ERR("UST app start session failed with ret %d: pid = %d, sock = %d",
5155 ret
, app
->pid
, app
->sock
);
5160 /* Indicate that the session has been started once */
5161 ua_sess
->started
= 1;
5162 ua_sess
->enabled
= 1;
5164 pthread_mutex_unlock(&ua_sess
->lock
);
5166 health_code_update();
5168 /* Quiescent wait after starting trace */
5169 pthread_mutex_lock(&app
->sock_lock
);
5170 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5171 pthread_mutex_unlock(&app
->sock_lock
);
5173 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5174 DBG3("UST app wait quiescent failed. Application is dead: pid = %d, sock = %d",
5175 app
->pid
, app
->sock
);
5176 } else if (ret
== -EAGAIN
) {
5177 WARN("UST app wait quiescent failed. Communication time out: pid = %d, sock = %d",
5178 app
->pid
, app
->sock
);
5180 ERR("UST app wait quiescent failed with ret %d: pid %d, sock = %d",
5181 ret
, app
->pid
, app
->sock
);
5187 health_code_update();
5191 pthread_mutex_unlock(&ua_sess
->lock
);
5193 health_code_update();
5198 * Stop tracing for a specific UST session and app.
5201 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5204 struct ust_app_session
*ua_sess
;
5205 struct ust_registry_session
*registry
;
5207 DBG("Stopping tracing for ust app pid %d", app
->pid
);
5211 if (!app
->compatible
) {
5212 goto end_no_session
;
5215 ua_sess
= lookup_session_by_app(usess
, app
);
5216 if (ua_sess
== NULL
) {
5217 goto end_no_session
;
5220 pthread_mutex_lock(&ua_sess
->lock
);
5222 if (ua_sess
->deleted
) {
5223 pthread_mutex_unlock(&ua_sess
->lock
);
5224 goto end_no_session
;
5228 * If started = 0, it means that stop trace has been called for a session
5229 * that was never started. It's possible since we can have a fail start
5230 * from either the application manager thread or the command thread. Simply
5231 * indicate that this is a stop error.
5233 if (!ua_sess
->started
) {
5234 goto error_rcu_unlock
;
5237 health_code_update();
5239 /* This inhibits UST tracing */
5240 pthread_mutex_lock(&app
->sock_lock
);
5241 ret
= lttng_ust_ctl_stop_session(app
->sock
, ua_sess
->handle
);
5242 pthread_mutex_unlock(&app
->sock_lock
);
5244 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5245 DBG3("UST app stop session failed. Application is dead: pid = %d, sock = %d",
5246 app
->pid
, app
->sock
);
5248 } else if (ret
== -EAGAIN
) {
5249 WARN("UST app stop session failed. Communication time out: pid = %d, sock = %d",
5250 app
->pid
, app
->sock
);
5254 ERR("UST app stop session failed with ret %d: pid = %d, sock = %d",
5255 ret
, app
->pid
, app
->sock
);
5257 goto error_rcu_unlock
;
5260 health_code_update();
5261 ua_sess
->enabled
= 0;
5263 /* Quiescent wait after stopping trace */
5264 pthread_mutex_lock(&app
->sock_lock
);
5265 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5266 pthread_mutex_unlock(&app
->sock_lock
);
5268 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5269 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d)",
5270 app
->pid
, app
->sock
);
5271 } else if (ret
== -EAGAIN
) {
5272 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d)",
5273 app
->pid
, app
->sock
);
5275 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d)",
5276 ret
, app
->pid
, app
->sock
);
5280 health_code_update();
5282 registry
= get_session_registry(ua_sess
);
5284 /* The UST app session is held registry shall not be null. */
5285 LTTNG_ASSERT(registry
);
5287 /* Push metadata for application before freeing the application. */
5288 (void) push_metadata(registry
, ua_sess
->consumer
);
5291 pthread_mutex_unlock(&ua_sess
->lock
);
5294 health_code_update();
5298 pthread_mutex_unlock(&ua_sess
->lock
);
5300 health_code_update();
5305 int ust_app_flush_app_session(struct ust_app
*app
,
5306 struct ust_app_session
*ua_sess
)
5308 int ret
, retval
= 0;
5309 struct lttng_ht_iter iter
;
5310 struct ust_app_channel
*ua_chan
;
5311 struct consumer_socket
*socket
;
5313 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5317 if (!app
->compatible
) {
5318 goto end_not_compatible
;
5321 pthread_mutex_lock(&ua_sess
->lock
);
5323 if (ua_sess
->deleted
) {
5327 health_code_update();
5329 /* Flushing buffers */
5330 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5333 /* Flush buffers and push metadata. */
5334 switch (ua_sess
->buffer_type
) {
5335 case LTTNG_BUFFER_PER_PID
:
5336 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5338 health_code_update();
5339 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5341 ERR("Error flushing consumer channel");
5347 case LTTNG_BUFFER_PER_UID
:
5353 health_code_update();
5356 pthread_mutex_unlock(&ua_sess
->lock
);
5360 health_code_update();
5365 * Flush buffers for all applications for a specific UST session.
5366 * Called with UST session lock held.
5369 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5374 DBG("Flushing session buffers for all ust apps");
5378 /* Flush buffers and push metadata. */
5379 switch (usess
->buffer_type
) {
5380 case LTTNG_BUFFER_PER_UID
:
5382 struct buffer_reg_uid
*reg
;
5383 struct lttng_ht_iter iter
;
5385 /* Flush all per UID buffers associated to that session. */
5386 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5387 struct ust_registry_session
*ust_session_reg
;
5388 struct buffer_reg_channel
*buf_reg_chan
;
5389 struct consumer_socket
*socket
;
5391 /* Get consumer socket to use to push the metadata.*/
5392 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5395 /* Ignore request if no consumer is found for the session. */
5399 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5400 buf_reg_chan
, node
.node
) {
5402 * The following call will print error values so the return
5403 * code is of little importance because whatever happens, we
5404 * have to try them all.
5406 (void) consumer_flush_channel(socket
, buf_reg_chan
->consumer_key
);
5409 ust_session_reg
= reg
->registry
->reg
.ust
;
5410 /* Push metadata. */
5411 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5415 case LTTNG_BUFFER_PER_PID
:
5417 struct ust_app_session
*ua_sess
;
5418 struct lttng_ht_iter iter
;
5419 struct ust_app
*app
;
5421 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5422 ua_sess
= lookup_session_by_app(usess
, app
);
5423 if (ua_sess
== NULL
) {
5426 (void) ust_app_flush_app_session(app
, ua_sess
);
5437 health_code_update();
5442 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5443 struct ust_app_session
*ua_sess
)
5446 struct lttng_ht_iter iter
;
5447 struct ust_app_channel
*ua_chan
;
5448 struct consumer_socket
*socket
;
5450 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5454 if (!app
->compatible
) {
5455 goto end_not_compatible
;
5458 pthread_mutex_lock(&ua_sess
->lock
);
5460 if (ua_sess
->deleted
) {
5464 health_code_update();
5466 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5469 ERR("Failed to find consumer (%" PRIu32
") socket",
5470 app
->bits_per_long
);
5475 /* Clear quiescent state. */
5476 switch (ua_sess
->buffer_type
) {
5477 case LTTNG_BUFFER_PER_PID
:
5478 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5479 ua_chan
, node
.node
) {
5480 health_code_update();
5481 ret
= consumer_clear_quiescent_channel(socket
,
5484 ERR("Error clearing quiescent state for consumer channel");
5490 case LTTNG_BUFFER_PER_UID
:
5497 health_code_update();
5500 pthread_mutex_unlock(&ua_sess
->lock
);
5504 health_code_update();
5509 * Clear quiescent state in each stream for all applications for a
5510 * specific UST session.
5511 * Called with UST session lock held.
5514 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5519 DBG("Clearing stream quiescent state for all ust apps");
5523 switch (usess
->buffer_type
) {
5524 case LTTNG_BUFFER_PER_UID
:
5526 struct lttng_ht_iter iter
;
5527 struct buffer_reg_uid
*reg
;
5530 * Clear quiescent for all per UID buffers associated to
5533 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5534 struct consumer_socket
*socket
;
5535 struct buffer_reg_channel
*buf_reg_chan
;
5537 /* Get associated consumer socket.*/
5538 socket
= consumer_find_socket_by_bitness(
5539 reg
->bits_per_long
, usess
->consumer
);
5542 * Ignore request if no consumer is found for
5548 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5549 &iter
.iter
, buf_reg_chan
, node
.node
) {
5551 * The following call will print error values so
5552 * the return code is of little importance
5553 * because whatever happens, we have to try them
5556 (void) consumer_clear_quiescent_channel(socket
,
5557 buf_reg_chan
->consumer_key
);
5562 case LTTNG_BUFFER_PER_PID
:
5564 struct ust_app_session
*ua_sess
;
5565 struct lttng_ht_iter iter
;
5566 struct ust_app
*app
;
5568 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5570 ua_sess
= lookup_session_by_app(usess
, app
);
5571 if (ua_sess
== NULL
) {
5574 (void) ust_app_clear_quiescent_app_session(app
,
5586 health_code_update();
5591 * Destroy a specific UST session in apps.
5593 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5596 struct ust_app_session
*ua_sess
;
5597 struct lttng_ht_iter iter
;
5598 struct lttng_ht_node_u64
*node
;
5600 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5604 if (!app
->compatible
) {
5608 __lookup_session_by_app(usess
, app
, &iter
);
5609 node
= lttng_ht_iter_get_node_u64(&iter
);
5611 /* Session is being or is deleted. */
5614 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5616 health_code_update();
5617 destroy_app_session(app
, ua_sess
);
5619 health_code_update();
5621 /* Quiescent wait after stopping trace */
5622 pthread_mutex_lock(&app
->sock_lock
);
5623 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5624 pthread_mutex_unlock(&app
->sock_lock
);
5626 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5627 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d)",
5628 app
->pid
, app
->sock
);
5629 } else if (ret
== -EAGAIN
) {
5630 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d)",
5631 app
->pid
, app
->sock
);
5633 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d)",
5634 ret
, app
->pid
, app
->sock
);
5639 health_code_update();
5644 * Start tracing for the UST session.
5646 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5648 struct lttng_ht_iter iter
;
5649 struct ust_app
*app
;
5651 DBG("Starting all UST traces");
5654 * Even though the start trace might fail, flag this session active so
5655 * other application coming in are started by default.
5662 * In a start-stop-start use-case, we need to clear the quiescent state
5663 * of each channel set by the prior stop command, thus ensuring that a
5664 * following stop or destroy is sure to grab a timestamp_end near those
5665 * operations, even if the packet is empty.
5667 (void) ust_app_clear_quiescent_session(usess
);
5669 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5670 ust_app_global_update(usess
, app
);
5679 * Start tracing for the UST session.
5680 * Called with UST session lock held.
5682 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5685 struct lttng_ht_iter iter
;
5686 struct ust_app
*app
;
5688 DBG("Stopping all UST traces");
5691 * Even though the stop trace might fail, flag this session inactive so
5692 * other application coming in are not started by default.
5698 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5699 ret
= ust_app_stop_trace(usess
, app
);
5701 /* Continue to next apps even on error */
5706 (void) ust_app_flush_session(usess
);
5714 * Destroy app UST session.
5716 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5719 struct lttng_ht_iter iter
;
5720 struct ust_app
*app
;
5722 DBG("Destroy all UST traces");
5726 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5727 ret
= destroy_trace(usess
, app
);
5729 /* Continue to next apps even on error */
5739 /* The ua_sess lock must be held by the caller. */
5741 int find_or_create_ust_app_channel(
5742 struct ltt_ust_session
*usess
,
5743 struct ust_app_session
*ua_sess
,
5744 struct ust_app
*app
,
5745 struct ltt_ust_channel
*uchan
,
5746 struct ust_app_channel
**ua_chan
)
5749 struct lttng_ht_iter iter
;
5750 struct lttng_ht_node_str
*ua_chan_node
;
5752 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5753 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5755 *ua_chan
= caa_container_of(ua_chan_node
,
5756 struct ust_app_channel
, node
);
5760 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5769 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5770 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5771 struct ust_app
*app
)
5774 struct ust_app_event
*ua_event
= NULL
;
5776 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5777 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5779 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5784 if (ua_event
->enabled
!= uevent
->enabled
) {
5785 ret
= uevent
->enabled
?
5786 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5787 disable_ust_app_event(ua_sess
, ua_event
, app
);
5795 /* Called with RCU read-side lock held. */
5797 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5800 enum lttng_error_code ret_code
;
5801 enum lttng_trigger_status t_status
;
5802 struct lttng_ht_iter app_trigger_iter
;
5803 struct lttng_triggers
*triggers
= NULL
;
5804 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5805 unsigned int count
, i
;
5807 if (!ust_app_supports_notifiers(app
)) {
5812 * Currrently, registering or unregistering a trigger with an
5813 * event rule condition causes a full synchronization of the event
5816 * The first step attempts to add an event notifier for all registered
5817 * triggers that apply to the user space tracers. Then, the
5818 * application's event notifiers rules are all checked against the list
5819 * of registered triggers. Any event notifier that doesn't have a
5820 * matching trigger can be assumed to have been disabled.
5822 * All of this is inefficient, but is put in place to get the feature
5823 * rolling as it is simpler at this moment. It will be optimized Soon™
5824 * to allow the state of enabled
5825 * event notifiers to be synchronized in a piece-wise way.
5828 /* Get all triggers using uid 0 (root) */
5829 ret_code
= notification_thread_command_list_triggers(
5830 the_notification_thread_handle
, 0, &triggers
);
5831 if (ret_code
!= LTTNG_OK
) {
5835 LTTNG_ASSERT(triggers
);
5837 t_status
= lttng_triggers_get_count(triggers
, &count
);
5838 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5842 for (i
= 0; i
< count
; i
++) {
5843 struct lttng_condition
*condition
;
5844 struct lttng_event_rule
*event_rule
;
5845 struct lttng_trigger
*trigger
;
5846 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5847 enum lttng_condition_status condition_status
;
5850 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5851 LTTNG_ASSERT(trigger
);
5853 token
= lttng_trigger_get_tracer_token(trigger
);
5854 condition
= lttng_trigger_get_condition(trigger
);
5856 if (lttng_condition_get_type(condition
) !=
5857 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
) {
5858 /* Does not apply */
5863 lttng_condition_event_rule_matches_borrow_rule_mutable(
5864 condition
, &event_rule
);
5865 LTTNG_ASSERT(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5867 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5868 /* Skip kernel related triggers. */
5873 * Find or create the associated token event rule. The caller
5874 * holds the RCU read lock, so this is safe to call without
5875 * explicitly acquiring it here.
5877 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5878 app
->token_to_event_notifier_rule_ht
, token
);
5879 if (!looked_up_event_notifier_rule
) {
5880 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
5888 /* Remove all unknown event sources from the app. */
5889 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5890 &app_trigger_iter
.iter
, event_notifier_rule
,
5892 const uint64_t app_token
= event_notifier_rule
->token
;
5896 * Check if the app event trigger still exists on the
5897 * notification side.
5899 for (i
= 0; i
< count
; i
++) {
5900 uint64_t notification_thread_token
;
5901 const struct lttng_trigger
*trigger
=
5902 lttng_triggers_get_at_index(
5905 LTTNG_ASSERT(trigger
);
5907 notification_thread_token
=
5908 lttng_trigger_get_tracer_token(trigger
);
5910 if (notification_thread_token
== app_token
) {
5922 * This trigger was unregistered, disable it on the tracer's
5925 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5927 LTTNG_ASSERT(ret
== 0);
5929 /* Callee logs errors. */
5930 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5932 delete_ust_app_event_notifier_rule(
5933 app
->sock
, event_notifier_rule
, app
);
5939 lttng_triggers_destroy(triggers
);
5944 * RCU read lock must be held by the caller.
5947 void ust_app_synchronize_all_channels(struct ltt_ust_session
*usess
,
5948 struct ust_app_session
*ua_sess
,
5949 struct ust_app
*app
)
5952 struct cds_lfht_iter uchan_iter
;
5953 struct ltt_ust_channel
*uchan
;
5955 LTTNG_ASSERT(usess
);
5956 LTTNG_ASSERT(ua_sess
);
5959 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5961 struct ust_app_channel
*ua_chan
;
5962 struct cds_lfht_iter uevent_iter
;
5963 struct ltt_ust_event
*uevent
;
5966 * Search for a matching ust_app_channel. If none is found,
5967 * create it. Creating the channel will cause the ua_chan
5968 * structure to be allocated, the channel buffers to be
5969 * allocated (if necessary) and sent to the application, and
5970 * all enabled contexts will be added to the channel.
5972 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5973 app
, uchan
, &ua_chan
);
5975 /* Tracer is probably gone or ENOMEM. */
5980 /* ua_chan will be NULL for the metadata channel */
5984 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5986 ret
= ust_app_channel_synchronize_event(ua_chan
,
5987 uevent
, ua_sess
, app
);
5993 if (ua_chan
->enabled
!= uchan
->enabled
) {
5994 ret
= uchan
->enabled
?
5995 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5996 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
6007 * The caller must ensure that the application is compatible and is tracked
6008 * by the process attribute trackers.
6011 void ust_app_synchronize(struct ltt_ust_session
*usess
,
6012 struct ust_app
*app
)
6015 struct ust_app_session
*ua_sess
= NULL
;
6018 * The application's configuration should only be synchronized for
6021 LTTNG_ASSERT(usess
->active
);
6023 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
6025 /* Tracer is probably gone or ENOMEM. */
6027 destroy_app_session(app
, ua_sess
);
6031 LTTNG_ASSERT(ua_sess
);
6033 pthread_mutex_lock(&ua_sess
->lock
);
6034 if (ua_sess
->deleted
) {
6035 goto deleted_session
;
6040 ust_app_synchronize_all_channels(usess
, ua_sess
, app
);
6043 * Create the metadata for the application. This returns gracefully if a
6044 * metadata was already set for the session.
6046 * The metadata channel must be created after the data channels as the
6047 * consumer daemon assumes this ordering. When interacting with a relay
6048 * daemon, the consumer will use this assumption to send the
6049 * "STREAMS_SENT" message to the relay daemon.
6051 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
6053 ERR("Metadata creation failed for app sock %d for session id %" PRIu64
,
6054 app
->sock
, usess
->id
);
6060 pthread_mutex_unlock(&ua_sess
->lock
);
6066 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6068 struct ust_app_session
*ua_sess
;
6070 ua_sess
= lookup_session_by_app(usess
, app
);
6071 if (ua_sess
== NULL
) {
6074 destroy_app_session(app
, ua_sess
);
6078 * Add channels/events from UST global domain to registered apps at sock.
6080 * Called with session lock held.
6081 * Called with RCU read-side lock held.
6083 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6085 LTTNG_ASSERT(usess
);
6086 LTTNG_ASSERT(usess
->active
);
6088 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
6089 app
->sock
, usess
->id
);
6091 if (!app
->compatible
) {
6094 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
6096 trace_ust_id_tracker_lookup(
6097 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
6099 trace_ust_id_tracker_lookup(
6100 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
6103 * Synchronize the application's internal tracing configuration
6104 * and start tracing.
6106 ust_app_synchronize(usess
, app
);
6107 ust_app_start_trace(usess
, app
);
6109 ust_app_global_destroy(usess
, app
);
6114 * Add all event notifiers to an application.
6116 * Called with session lock held.
6117 * Called with RCU read-side lock held.
6119 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
6121 DBG2("UST application global event notifier rules update: app = '%s', pid = %d)",
6122 app
->name
, app
->pid
);
6124 if (!app
->compatible
|| !ust_app_supports_notifiers(app
)) {
6128 if (app
->event_notifier_group
.object
== NULL
) {
6129 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' pid = %d)",
6130 app
->name
, app
->pid
);
6134 ust_app_synchronize_event_notifier_rules(app
);
6138 * Called with session lock held.
6140 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
6142 struct lttng_ht_iter iter
;
6143 struct ust_app
*app
;
6146 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6147 ust_app_global_update(usess
, app
);
6152 void ust_app_global_update_all_event_notifier_rules(void)
6154 struct lttng_ht_iter iter
;
6155 struct ust_app
*app
;
6158 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6159 ust_app_global_update_event_notifier_rules(app
);
6166 * Add context to a specific channel for global UST domain.
6168 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
6169 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
6172 struct lttng_ht_node_str
*ua_chan_node
;
6173 struct lttng_ht_iter iter
, uiter
;
6174 struct ust_app_channel
*ua_chan
= NULL
;
6175 struct ust_app_session
*ua_sess
;
6176 struct ust_app
*app
;
6178 LTTNG_ASSERT(usess
->active
);
6181 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6182 if (!app
->compatible
) {
6184 * TODO: In time, we should notice the caller of this error by
6185 * telling him that this is a version error.
6189 ua_sess
= lookup_session_by_app(usess
, app
);
6190 if (ua_sess
== NULL
) {
6194 pthread_mutex_lock(&ua_sess
->lock
);
6196 if (ua_sess
->deleted
) {
6197 pthread_mutex_unlock(&ua_sess
->lock
);
6201 /* Lookup channel in the ust app session */
6202 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
6203 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6204 if (ua_chan_node
== NULL
) {
6207 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
6209 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
6214 pthread_mutex_unlock(&ua_sess
->lock
);
6222 * Receive registration and populate the given msg structure.
6224 * On success return 0 else a negative value returned by the ustctl call.
6226 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
6229 uint32_t pid
, ppid
, uid
, gid
;
6233 ret
= lttng_ust_ctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
6234 &pid
, &ppid
, &uid
, &gid
,
6235 &msg
->bits_per_long
,
6236 &msg
->uint8_t_alignment
,
6237 &msg
->uint16_t_alignment
,
6238 &msg
->uint32_t_alignment
,
6239 &msg
->uint64_t_alignment
,
6240 &msg
->long_alignment
,
6247 case LTTNG_UST_ERR_EXITING
:
6248 DBG3("UST app recv reg message failed. Application died");
6250 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6251 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6252 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
6253 LTTNG_UST_ABI_MINOR_VERSION
);
6256 ERR("UST app recv reg message failed with ret %d", ret
);
6261 msg
->pid
= (pid_t
) pid
;
6262 msg
->ppid
= (pid_t
) ppid
;
6263 msg
->uid
= (uid_t
) uid
;
6264 msg
->gid
= (gid_t
) gid
;
6271 * Return a ust app session object using the application object and the
6272 * session object descriptor has a key. If not found, NULL is returned.
6273 * A RCU read side lock MUST be acquired when calling this function.
6275 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
6278 struct lttng_ht_node_ulong
*node
;
6279 struct lttng_ht_iter iter
;
6280 struct ust_app_session
*ua_sess
= NULL
;
6284 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
6285 node
= lttng_ht_iter_get_node_ulong(&iter
);
6287 DBG2("UST app session find by objd %d not found", objd
);
6291 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
6298 * Return a ust app channel object using the application object and the channel
6299 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6300 * lock MUST be acquired before calling this function.
6302 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
6305 struct lttng_ht_node_ulong
*node
;
6306 struct lttng_ht_iter iter
;
6307 struct ust_app_channel
*ua_chan
= NULL
;
6311 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
6312 node
= lttng_ht_iter_get_node_ulong(&iter
);
6314 DBG2("UST app channel find by objd %d not found", objd
);
6318 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
6325 * Reply to a register channel notification from an application on the notify
6326 * socket. The channel metadata is also created.
6328 * The session UST registry lock is acquired in this function.
6330 * On success 0 is returned else a negative value.
6332 static int reply_ust_register_channel(int sock
, int cobjd
,
6333 size_t nr_fields
, struct lttng_ust_ctl_field
*fields
)
6335 int ret
, ret_code
= 0;
6337 uint64_t chan_reg_key
;
6338 enum lttng_ust_ctl_channel_header type
;
6339 struct ust_app
*app
;
6340 struct ust_app_channel
*ua_chan
;
6341 struct ust_app_session
*ua_sess
;
6342 struct ust_registry_session
*registry
;
6343 struct ust_registry_channel
*ust_reg_chan
;
6347 /* Lookup application. If not found, there is a code flow error. */
6348 app
= find_app_by_notify_sock(sock
);
6350 DBG("Application socket %d is being torn down. Abort event notify",
6353 goto error_rcu_unlock
;
6356 /* Lookup channel by UST object descriptor. */
6357 ua_chan
= find_channel_by_objd(app
, cobjd
);
6359 DBG("Application channel is being torn down. Abort event notify");
6361 goto error_rcu_unlock
;
6364 LTTNG_ASSERT(ua_chan
->session
);
6365 ua_sess
= ua_chan
->session
;
6367 /* Get right session registry depending on the session buffer type. */
6368 registry
= get_session_registry(ua_sess
);
6370 DBG("Application session is being torn down. Abort event notify");
6372 goto error_rcu_unlock
;
6375 /* Depending on the buffer type, a different channel key is used. */
6376 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6377 chan_reg_key
= ua_chan
->tracing_channel_id
;
6379 chan_reg_key
= ua_chan
->key
;
6382 pthread_mutex_lock(®istry
->lock
);
6384 ust_reg_chan
= ust_registry_channel_find(registry
, chan_reg_key
);
6385 LTTNG_ASSERT(ust_reg_chan
);
6387 if (!ust_reg_chan
->register_done
) {
6389 * TODO: eventually use the registry event count for
6390 * this channel to better guess header type for per-pid
6393 type
= LTTNG_UST_CTL_CHANNEL_HEADER_LARGE
;
6394 ust_reg_chan
->nr_ctx_fields
= nr_fields
;
6395 ust_reg_chan
->ctx_fields
= fields
;
6397 ust_reg_chan
->header_type
= type
;
6399 /* Get current already assigned values. */
6400 type
= ust_reg_chan
->header_type
;
6402 /* Channel id is set during the object creation. */
6403 chan_id
= ust_reg_chan
->chan_id
;
6405 /* Append to metadata */
6406 if (!ust_reg_chan
->metadata_dumped
) {
6407 ret_code
= ust_metadata_channel_statedump(registry
, ust_reg_chan
);
6409 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6415 DBG3("UST app replying to register channel key %" PRIu64
6416 " with id %u, type = %d, ret = %d", chan_reg_key
, chan_id
, type
,
6419 ret
= lttng_ust_ctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6421 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6422 DBG3("UST app reply channel failed. Application died: pid = %d, sock = %d",
6423 app
->pid
, app
->sock
);
6424 } else if (ret
== -EAGAIN
) {
6425 WARN("UST app reply channel failed. Communication time out: pid = %d, sock = %d",
6426 app
->pid
, app
->sock
);
6428 ERR("UST app reply channel failed with ret %d: pid = %d, sock = %d",
6429 ret
, app
->pid
, app
->sock
);
6434 /* This channel registry registration is completed. */
6435 ust_reg_chan
->register_done
= 1;
6438 pthread_mutex_unlock(®istry
->lock
);
6446 * Add event to the UST channel registry. When the event is added to the
6447 * registry, the metadata is also created. Once done, this replies to the
6448 * application with the appropriate error code.
6450 * The session UST registry lock is acquired in the function.
6452 * On success 0 is returned else a negative value.
6454 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6455 char *sig
, size_t nr_fields
, struct lttng_ust_ctl_field
*fields
,
6456 int loglevel_value
, char *model_emf_uri
)
6459 uint32_t event_id
= 0;
6460 uint64_t chan_reg_key
;
6461 struct ust_app
*app
;
6462 struct ust_app_channel
*ua_chan
;
6463 struct ust_app_session
*ua_sess
;
6464 struct ust_registry_session
*registry
;
6468 /* Lookup application. If not found, there is a code flow error. */
6469 app
= find_app_by_notify_sock(sock
);
6471 DBG("Application socket %d is being torn down. Abort event notify",
6474 goto error_rcu_unlock
;
6477 /* Lookup channel by UST object descriptor. */
6478 ua_chan
= find_channel_by_objd(app
, cobjd
);
6480 DBG("Application channel is being torn down. Abort event notify");
6482 goto error_rcu_unlock
;
6485 LTTNG_ASSERT(ua_chan
->session
);
6486 ua_sess
= ua_chan
->session
;
6488 registry
= get_session_registry(ua_sess
);
6490 DBG("Application session is being torn down. Abort event notify");
6492 goto error_rcu_unlock
;
6495 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6496 chan_reg_key
= ua_chan
->tracing_channel_id
;
6498 chan_reg_key
= ua_chan
->key
;
6501 pthread_mutex_lock(®istry
->lock
);
6504 * From this point on, this call acquires the ownership of the sig, fields
6505 * and model_emf_uri meaning any free are done inside it if needed. These
6506 * three variables MUST NOT be read/write after this.
6508 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6509 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6510 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6514 model_emf_uri
= NULL
;
6517 * The return value is returned to ustctl so in case of an error, the
6518 * application can be notified. In case of an error, it's important not to
6519 * return a negative error or else the application will get closed.
6521 ret
= lttng_ust_ctl_reply_register_event(sock
, event_id
, ret_code
);
6523 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6524 DBG3("UST app reply event failed. Application died: pid = %d, sock = %d.",
6525 app
->pid
, app
->sock
);
6526 } else if (ret
== -EAGAIN
) {
6527 WARN("UST app reply event failed. Communication time out: pid = %d, sock = %d",
6528 app
->pid
, app
->sock
);
6530 ERR("UST app reply event failed with ret %d: pid = %d, sock = %d",
6531 ret
, app
->pid
, app
->sock
);
6534 * No need to wipe the create event since the application socket will
6535 * get close on error hence cleaning up everything by itself.
6540 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6544 pthread_mutex_unlock(®istry
->lock
);
6549 free(model_emf_uri
);
6554 * Add enum to the UST session registry. Once done, this replies to the
6555 * application with the appropriate error code.
6557 * The session UST registry lock is acquired within this function.
6559 * On success 0 is returned else a negative value.
6561 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6562 struct lttng_ust_ctl_enum_entry
*entries
, size_t nr_entries
)
6564 int ret
= 0, ret_code
;
6565 struct ust_app
*app
;
6566 struct ust_app_session
*ua_sess
;
6567 struct ust_registry_session
*registry
;
6568 uint64_t enum_id
= -1ULL;
6572 /* Lookup application. If not found, there is a code flow error. */
6573 app
= find_app_by_notify_sock(sock
);
6575 /* Return an error since this is not an error */
6576 DBG("Application socket %d is being torn down. Aborting enum registration",
6580 goto error_rcu_unlock
;
6583 /* Lookup session by UST object descriptor. */
6584 ua_sess
= find_session_by_objd(app
, sobjd
);
6586 /* Return an error since this is not an error */
6587 DBG("Application session is being torn down (session not found Aborting enum registration.");
6589 goto error_rcu_unlock
;
6592 registry
= get_session_registry(ua_sess
);
6594 DBG("Application session is being torn down (registry not found Aborting enum registration.");
6596 goto error_rcu_unlock
;
6599 pthread_mutex_lock(®istry
->lock
);
6602 * From this point on, the callee acquires the ownership of
6603 * entries. The variable entries MUST NOT be read/written after
6606 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6607 entries
, nr_entries
, &enum_id
);
6611 * The return value is returned to ustctl so in case of an error, the
6612 * application can be notified. In case of an error, it's important not to
6613 * return a negative error or else the application will get closed.
6615 ret
= lttng_ust_ctl_reply_register_enum(sock
, enum_id
, ret_code
);
6617 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6618 DBG3("UST app reply enum failed. Application died: pid = %d, sock = %d",
6619 app
->pid
, app
->sock
);
6620 } else if (ret
== -EAGAIN
) {
6621 WARN("UST app reply enum failed. Communication time out: pid = %d, sock = %d",
6622 app
->pid
, app
->sock
);
6624 ERR("UST app reply enum failed with ret %d: pid = %d, sock = %d",
6625 ret
, app
->pid
, app
->sock
);
6628 * No need to wipe the create enum since the application socket will
6629 * get close on error hence cleaning up everything by itself.
6634 DBG3("UST registry enum %s added successfully or already found", name
);
6637 pthread_mutex_unlock(®istry
->lock
);
6644 * Handle application notification through the given notify socket.
6646 * Return 0 on success or else a negative value.
6648 int ust_app_recv_notify(int sock
)
6651 enum lttng_ust_ctl_notify_cmd cmd
;
6653 DBG3("UST app receiving notify from sock %d", sock
);
6655 ret
= lttng_ust_ctl_recv_notify(sock
, &cmd
);
6657 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6658 DBG3("UST app recv notify failed. Application died: sock = %d",
6660 } else if (ret
== -EAGAIN
) {
6661 WARN("UST app recv notify failed. Communication time out: sock = %d",
6664 ERR("UST app recv notify failed with ret %d: sock = %d",
6671 case LTTNG_UST_CTL_NOTIFY_CMD_EVENT
:
6673 int sobjd
, cobjd
, loglevel_value
;
6674 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6676 struct lttng_ust_ctl_field
*fields
;
6678 DBG2("UST app ustctl register event received");
6680 ret
= lttng_ust_ctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6681 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6684 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6685 DBG3("UST app recv event failed. Application died: sock = %d",
6687 } else if (ret
== -EAGAIN
) {
6688 WARN("UST app recv event failed. Communication time out: sock = %d",
6691 ERR("UST app recv event failed with ret %d: sock = %d",
6698 * Add event to the UST registry coming from the notify socket. This
6699 * call will free if needed the sig, fields and model_emf_uri. This
6700 * code path loses the ownsership of these variables and transfer them
6701 * to the this function.
6703 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6704 fields
, loglevel_value
, model_emf_uri
);
6711 case LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL
:
6715 struct lttng_ust_ctl_field
*fields
;
6717 DBG2("UST app ustctl register channel received");
6719 ret
= lttng_ust_ctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6722 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6723 DBG3("UST app recv channel failed. Application died: sock = %d",
6725 } else if (ret
== -EAGAIN
) {
6726 WARN("UST app recv channel failed. Communication time out: sock = %d",
6729 ERR("UST app recv channel failed with ret %d: sock = %d)",
6736 * The fields ownership are transfered to this function call meaning
6737 * that if needed it will be freed. After this, it's invalid to access
6738 * fields or clean it up.
6740 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6748 case LTTNG_UST_CTL_NOTIFY_CMD_ENUM
:
6751 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
6753 struct lttng_ust_ctl_enum_entry
*entries
;
6755 DBG2("UST app ustctl register enum received");
6757 ret
= lttng_ust_ctl_recv_register_enum(sock
, &sobjd
, name
,
6758 &entries
, &nr_entries
);
6760 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6761 DBG3("UST app recv enum failed. Application died: sock = %d",
6763 } else if (ret
== -EAGAIN
) {
6764 WARN("UST app recv enum failed. Communication time out: sock = %d",
6767 ERR("UST app recv enum failed with ret %d: sock = %d",
6773 /* Callee assumes ownership of entries */
6774 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6775 entries
, nr_entries
);
6783 /* Should NEVER happen. */
6792 * Once the notify socket hangs up, this is called. First, it tries to find the
6793 * corresponding application. On failure, the call_rcu to close the socket is
6794 * executed. If an application is found, it tries to delete it from the notify
6795 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6797 * Note that an object needs to be allocated here so on ENOMEM failure, the
6798 * call RCU is not done but the rest of the cleanup is.
6800 void ust_app_notify_sock_unregister(int sock
)
6803 struct lttng_ht_iter iter
;
6804 struct ust_app
*app
;
6805 struct ust_app_notify_sock_obj
*obj
;
6807 LTTNG_ASSERT(sock
>= 0);
6811 obj
= zmalloc(sizeof(*obj
));
6814 * An ENOMEM is kind of uncool. If this strikes we continue the
6815 * procedure but the call_rcu will not be called. In this case, we
6816 * accept the fd leak rather than possibly creating an unsynchronized
6817 * state between threads.
6819 * TODO: The notify object should be created once the notify socket is
6820 * registered and stored independantely from the ust app object. The
6821 * tricky part is to synchronize the teardown of the application and
6822 * this notify object. Let's keep that in mind so we can avoid this
6823 * kind of shenanigans with ENOMEM in the teardown path.
6830 DBG("UST app notify socket unregister %d", sock
);
6833 * Lookup application by notify socket. If this fails, this means that the
6834 * hash table delete has already been done by the application
6835 * unregistration process so we can safely close the notify socket in a
6838 app
= find_app_by_notify_sock(sock
);
6843 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6846 * Whatever happens here either we fail or succeed, in both cases we have
6847 * to close the socket after a grace period to continue to the call RCU
6848 * here. If the deletion is successful, the application is not visible
6849 * anymore by other threads and is it fails it means that it was already
6850 * deleted from the hash table so either way we just have to close the
6853 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6859 * Close socket after a grace period to avoid for the socket to be reused
6860 * before the application object is freed creating potential race between
6861 * threads trying to add unique in the global hash table.
6864 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6869 * Destroy a ust app data structure and free its memory.
6871 void ust_app_destroy(struct ust_app
*app
)
6877 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6881 * Take a snapshot for a given UST session. The snapshot is sent to the given
6884 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
6886 enum lttng_error_code
ust_app_snapshot_record(
6887 const struct ltt_ust_session
*usess
,
6888 const struct consumer_output
*output
, int wait
,
6889 uint64_t nb_packets_per_stream
)
6892 enum lttng_error_code status
= LTTNG_OK
;
6893 struct lttng_ht_iter iter
;
6894 struct ust_app
*app
;
6895 char *trace_path
= NULL
;
6897 LTTNG_ASSERT(usess
);
6898 LTTNG_ASSERT(output
);
6902 switch (usess
->buffer_type
) {
6903 case LTTNG_BUFFER_PER_UID
:
6905 struct buffer_reg_uid
*reg
;
6907 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
6908 struct buffer_reg_channel
*buf_reg_chan
;
6909 struct consumer_socket
*socket
;
6910 char pathname
[PATH_MAX
];
6911 size_t consumer_path_offset
= 0;
6913 if (!reg
->registry
->reg
.ust
->metadata_key
) {
6914 /* Skip since no metadata is present */
6918 /* Get consumer socket to use to push the metadata.*/
6919 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
6922 status
= LTTNG_ERR_INVALID
;
6926 memset(pathname
, 0, sizeof(pathname
));
6927 ret
= snprintf(pathname
, sizeof(pathname
),
6928 DEFAULT_UST_TRACE_UID_PATH
,
6929 reg
->uid
, reg
->bits_per_long
);
6931 PERROR("snprintf snapshot path");
6932 status
= LTTNG_ERR_INVALID
;
6935 /* Free path allowed on previous iteration. */
6937 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
6938 &consumer_path_offset
);
6940 status
= LTTNG_ERR_INVALID
;
6943 /* Add the UST default trace dir to path. */
6944 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
6945 buf_reg_chan
, node
.node
) {
6946 status
= consumer_snapshot_channel(socket
,
6947 buf_reg_chan
->consumer_key
,
6948 output
, 0, usess
->uid
,
6949 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
6950 nb_packets_per_stream
);
6951 if (status
!= LTTNG_OK
) {
6955 status
= consumer_snapshot_channel(socket
,
6956 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
6957 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
6959 if (status
!= LTTNG_OK
) {
6965 case LTTNG_BUFFER_PER_PID
:
6967 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6968 struct consumer_socket
*socket
;
6969 struct lttng_ht_iter chan_iter
;
6970 struct ust_app_channel
*ua_chan
;
6971 struct ust_app_session
*ua_sess
;
6972 struct ust_registry_session
*registry
;
6973 char pathname
[PATH_MAX
];
6974 size_t consumer_path_offset
= 0;
6976 ua_sess
= lookup_session_by_app(usess
, app
);
6978 /* Session not associated with this app. */
6982 /* Get the right consumer socket for the application. */
6983 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
6986 status
= LTTNG_ERR_INVALID
;
6990 /* Add the UST default trace dir to path. */
6991 memset(pathname
, 0, sizeof(pathname
));
6992 ret
= snprintf(pathname
, sizeof(pathname
), "%s",
6995 status
= LTTNG_ERR_INVALID
;
6996 PERROR("snprintf snapshot path");
6999 /* Free path allowed on previous iteration. */
7001 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
7002 &consumer_path_offset
);
7004 status
= LTTNG_ERR_INVALID
;
7007 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7008 ua_chan
, node
.node
) {
7009 status
= consumer_snapshot_channel(socket
,
7010 ua_chan
->key
, output
, 0,
7011 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7012 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7013 &trace_path
[consumer_path_offset
], wait
,
7014 nb_packets_per_stream
);
7018 case LTTNG_ERR_CHAN_NOT_FOUND
:
7025 registry
= get_session_registry(ua_sess
);
7027 DBG("Application session is being torn down. Skip application.");
7030 status
= consumer_snapshot_channel(socket
,
7031 registry
->metadata_key
, output
, 1,
7032 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7033 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7034 &trace_path
[consumer_path_offset
], wait
, 0);
7038 case LTTNG_ERR_CHAN_NOT_FOUND
:
7058 * Return the size taken by one more packet per stream.
7060 uint64_t ust_app_get_size_one_more_packet_per_stream(
7061 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
7063 uint64_t tot_size
= 0;
7064 struct ust_app
*app
;
7065 struct lttng_ht_iter iter
;
7067 LTTNG_ASSERT(usess
);
7069 switch (usess
->buffer_type
) {
7070 case LTTNG_BUFFER_PER_UID
:
7072 struct buffer_reg_uid
*reg
;
7074 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7075 struct buffer_reg_channel
*buf_reg_chan
;
7078 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7079 buf_reg_chan
, node
.node
) {
7080 if (cur_nr_packets
>= buf_reg_chan
->num_subbuf
) {
7082 * Don't take channel into account if we
7083 * already grab all its packets.
7087 tot_size
+= buf_reg_chan
->subbuf_size
* buf_reg_chan
->stream_count
;
7093 case LTTNG_BUFFER_PER_PID
:
7096 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7097 struct ust_app_channel
*ua_chan
;
7098 struct ust_app_session
*ua_sess
;
7099 struct lttng_ht_iter chan_iter
;
7101 ua_sess
= lookup_session_by_app(usess
, app
);
7103 /* Session not associated with this app. */
7107 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7108 ua_chan
, node
.node
) {
7109 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
7111 * Don't take channel into account if we
7112 * already grab all its packets.
7116 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
7130 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
7131 struct cds_list_head
*buffer_reg_uid_list
,
7132 struct consumer_output
*consumer
, uint64_t uchan_id
,
7133 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
7136 uint64_t consumer_chan_key
;
7141 ret
= buffer_reg_uid_consumer_channel_key(
7142 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
7150 ret
= consumer_get_lost_packets(ust_session_id
,
7151 consumer_chan_key
, consumer
, lost
);
7153 ret
= consumer_get_discarded_events(ust_session_id
,
7154 consumer_chan_key
, consumer
, discarded
);
7161 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
7162 struct ltt_ust_channel
*uchan
,
7163 struct consumer_output
*consumer
, int overwrite
,
7164 uint64_t *discarded
, uint64_t *lost
)
7167 struct lttng_ht_iter iter
;
7168 struct lttng_ht_node_str
*ua_chan_node
;
7169 struct ust_app
*app
;
7170 struct ust_app_session
*ua_sess
;
7171 struct ust_app_channel
*ua_chan
;
7178 * Iterate over every registered applications. Sum counters for
7179 * all applications containing requested session and channel.
7181 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7182 struct lttng_ht_iter uiter
;
7184 ua_sess
= lookup_session_by_app(usess
, app
);
7185 if (ua_sess
== NULL
) {
7190 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
7191 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
7192 /* If the session is found for the app, the channel must be there */
7193 LTTNG_ASSERT(ua_chan_node
);
7195 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
7200 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
7207 uint64_t _discarded
;
7209 ret
= consumer_get_discarded_events(usess
->id
,
7210 ua_chan
->key
, consumer
, &_discarded
);
7214 (*discarded
) += _discarded
;
7223 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
7224 struct ust_app
*app
)
7227 struct ust_app_session
*ua_sess
;
7229 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
7233 ua_sess
= lookup_session_by_app(usess
, app
);
7234 if (ua_sess
== NULL
) {
7235 /* The session is in teardown process. Ignore and continue. */
7239 pthread_mutex_lock(&ua_sess
->lock
);
7241 if (ua_sess
->deleted
) {
7245 pthread_mutex_lock(&app
->sock_lock
);
7246 ret
= lttng_ust_ctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
7247 pthread_mutex_unlock(&app
->sock_lock
);
7250 pthread_mutex_unlock(&ua_sess
->lock
);
7254 health_code_update();
7259 * Regenerate the statedump for each app in the session.
7261 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
7264 struct lttng_ht_iter iter
;
7265 struct ust_app
*app
;
7267 DBG("Regenerating the metadata for all UST apps");
7271 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7272 if (!app
->compatible
) {
7276 ret
= ust_app_regenerate_statedump(usess
, app
);
7278 /* Continue to the next app even on error */
7289 * Rotate all the channels of a session.
7291 * Return LTTNG_OK on success or else an LTTng error code.
7293 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
7296 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7297 struct lttng_ht_iter iter
;
7298 struct ust_app
*app
;
7299 struct ltt_ust_session
*usess
= session
->ust_session
;
7301 LTTNG_ASSERT(usess
);
7305 switch (usess
->buffer_type
) {
7306 case LTTNG_BUFFER_PER_UID
:
7308 struct buffer_reg_uid
*reg
;
7310 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7311 struct buffer_reg_channel
*buf_reg_chan
;
7312 struct consumer_socket
*socket
;
7314 /* Get consumer socket to use to push the metadata.*/
7315 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7318 cmd_ret
= LTTNG_ERR_INVALID
;
7322 /* Rotate the data channels. */
7323 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7324 buf_reg_chan
, node
.node
) {
7325 ret
= consumer_rotate_channel(socket
,
7326 buf_reg_chan
->consumer_key
,
7327 usess
->uid
, usess
->gid
,
7329 /* is_metadata_channel */ false);
7331 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7337 * The metadata channel might not be present.
7339 * Consumer stream allocation can be done
7340 * asynchronously and can fail on intermediary
7341 * operations (i.e add context) and lead to data
7342 * channels created with no metadata channel.
7344 if (!reg
->registry
->reg
.ust
->metadata_key
) {
7345 /* Skip since no metadata is present. */
7349 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7351 ret
= consumer_rotate_channel(socket
,
7352 reg
->registry
->reg
.ust
->metadata_key
,
7353 usess
->uid
, usess
->gid
,
7355 /* is_metadata_channel */ true);
7357 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7363 case LTTNG_BUFFER_PER_PID
:
7365 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7366 struct consumer_socket
*socket
;
7367 struct lttng_ht_iter chan_iter
;
7368 struct ust_app_channel
*ua_chan
;
7369 struct ust_app_session
*ua_sess
;
7370 struct ust_registry_session
*registry
;
7372 ua_sess
= lookup_session_by_app(usess
, app
);
7374 /* Session not associated with this app. */
7378 /* Get the right consumer socket for the application. */
7379 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7382 cmd_ret
= LTTNG_ERR_INVALID
;
7386 registry
= get_session_registry(ua_sess
);
7388 DBG("Application session is being torn down. Skip application.");
7392 /* Rotate the data channels. */
7393 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7394 ua_chan
, node
.node
) {
7395 ret
= consumer_rotate_channel(socket
,
7397 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7398 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7400 /* is_metadata_channel */ false);
7402 /* Per-PID buffer and application going away. */
7403 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7405 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7410 /* Rotate the metadata channel. */
7411 (void) push_metadata(registry
, usess
->consumer
);
7412 ret
= consumer_rotate_channel(socket
,
7413 registry
->metadata_key
,
7414 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7415 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7417 /* is_metadata_channel */ true);
7419 /* Per-PID buffer and application going away. */
7420 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7422 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7440 enum lttng_error_code
ust_app_create_channel_subdirectories(
7441 const struct ltt_ust_session
*usess
)
7443 enum lttng_error_code ret
= LTTNG_OK
;
7444 struct lttng_ht_iter iter
;
7445 enum lttng_trace_chunk_status chunk_status
;
7446 char *pathname_index
;
7449 LTTNG_ASSERT(usess
->current_trace_chunk
);
7452 switch (usess
->buffer_type
) {
7453 case LTTNG_BUFFER_PER_UID
:
7455 struct buffer_reg_uid
*reg
;
7457 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7458 fmt_ret
= asprintf(&pathname_index
,
7459 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7460 reg
->uid
, reg
->bits_per_long
);
7462 ERR("Failed to format channel index directory");
7463 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7468 * Create the index subdirectory which will take care
7469 * of implicitly creating the channel's path.
7471 chunk_status
= lttng_trace_chunk_create_subdirectory(
7472 usess
->current_trace_chunk
,
7474 free(pathname_index
);
7475 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7476 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7482 case LTTNG_BUFFER_PER_PID
:
7484 struct ust_app
*app
;
7487 * Create the toplevel ust/ directory in case no apps are running.
7489 chunk_status
= lttng_trace_chunk_create_subdirectory(
7490 usess
->current_trace_chunk
,
7491 DEFAULT_UST_TRACE_DIR
);
7492 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7493 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7497 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7499 struct ust_app_session
*ua_sess
;
7500 struct ust_registry_session
*registry
;
7502 ua_sess
= lookup_session_by_app(usess
, app
);
7504 /* Session not associated with this app. */
7508 registry
= get_session_registry(ua_sess
);
7510 DBG("Application session is being torn down. Skip application.");
7514 fmt_ret
= asprintf(&pathname_index
,
7515 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7518 ERR("Failed to format channel index directory");
7519 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7523 * Create the index subdirectory which will take care
7524 * of implicitly creating the channel's path.
7526 chunk_status
= lttng_trace_chunk_create_subdirectory(
7527 usess
->current_trace_chunk
,
7529 free(pathname_index
);
7530 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7531 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7548 * Clear all the channels of a session.
7550 * Return LTTNG_OK on success or else an LTTng error code.
7552 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7555 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7556 struct lttng_ht_iter iter
;
7557 struct ust_app
*app
;
7558 struct ltt_ust_session
*usess
= session
->ust_session
;
7560 LTTNG_ASSERT(usess
);
7564 if (usess
->active
) {
7565 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7566 cmd_ret
= LTTNG_ERR_FATAL
;
7570 switch (usess
->buffer_type
) {
7571 case LTTNG_BUFFER_PER_UID
:
7573 struct buffer_reg_uid
*reg
;
7575 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7576 struct buffer_reg_channel
*buf_reg_chan
;
7577 struct consumer_socket
*socket
;
7579 /* Get consumer socket to use to push the metadata.*/
7580 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7583 cmd_ret
= LTTNG_ERR_INVALID
;
7587 /* Clear the data channels. */
7588 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7589 buf_reg_chan
, node
.node
) {
7590 ret
= consumer_clear_channel(socket
,
7591 buf_reg_chan
->consumer_key
);
7597 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7600 * Clear the metadata channel.
7601 * Metadata channel is not cleared per se but we still need to
7602 * perform a rotation operation on it behind the scene.
7604 ret
= consumer_clear_channel(socket
,
7605 reg
->registry
->reg
.ust
->metadata_key
);
7612 case LTTNG_BUFFER_PER_PID
:
7614 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7615 struct consumer_socket
*socket
;
7616 struct lttng_ht_iter chan_iter
;
7617 struct ust_app_channel
*ua_chan
;
7618 struct ust_app_session
*ua_sess
;
7619 struct ust_registry_session
*registry
;
7621 ua_sess
= lookup_session_by_app(usess
, app
);
7623 /* Session not associated with this app. */
7627 /* Get the right consumer socket for the application. */
7628 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7631 cmd_ret
= LTTNG_ERR_INVALID
;
7635 registry
= get_session_registry(ua_sess
);
7637 DBG("Application session is being torn down. Skip application.");
7641 /* Clear the data channels. */
7642 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7643 ua_chan
, node
.node
) {
7644 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7646 /* Per-PID buffer and application going away. */
7647 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7654 (void) push_metadata(registry
, usess
->consumer
);
7657 * Clear the metadata channel.
7658 * Metadata channel is not cleared per se but we still need to
7659 * perform rotation operation on it behind the scene.
7661 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7663 /* Per-PID buffer and application going away. */
7664 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7682 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7683 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7686 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7696 * This function skips the metadata channel as the begin/end timestamps of a
7697 * metadata packet are useless.
7699 * Moreover, opening a packet after a "clear" will cause problems for live
7700 * sessions as it will introduce padding that was not part of the first trace
7701 * chunk. The relay daemon expects the content of the metadata stream of
7702 * successive metadata trace chunks to be strict supersets of one another.
7704 * For example, flushing a packet at the beginning of the metadata stream of
7705 * a trace chunk resulting from a "clear" session command will cause the
7706 * size of the metadata stream of the new trace chunk to not match the size of
7707 * the metadata stream of the original chunk. This will confuse the relay
7708 * daemon as the same "offset" in a metadata stream will no longer point
7709 * to the same content.
7711 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7713 enum lttng_error_code ret
= LTTNG_OK
;
7714 struct lttng_ht_iter iter
;
7715 struct ltt_ust_session
*usess
= session
->ust_session
;
7717 LTTNG_ASSERT(usess
);
7721 switch (usess
->buffer_type
) {
7722 case LTTNG_BUFFER_PER_UID
:
7724 struct buffer_reg_uid
*reg
;
7726 cds_list_for_each_entry (
7727 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7728 struct buffer_reg_channel
*buf_reg_chan
;
7729 struct consumer_socket
*socket
;
7731 socket
= consumer_find_socket_by_bitness(
7732 reg
->bits_per_long
, usess
->consumer
);
7734 ret
= LTTNG_ERR_FATAL
;
7738 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7739 &iter
.iter
, buf_reg_chan
, node
.node
) {
7740 const int open_ret
=
7741 consumer_open_channel_packets(
7743 buf_reg_chan
->consumer_key
);
7746 ret
= LTTNG_ERR_UNK
;
7753 case LTTNG_BUFFER_PER_PID
:
7755 struct ust_app
*app
;
7757 cds_lfht_for_each_entry (
7758 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7759 struct consumer_socket
*socket
;
7760 struct lttng_ht_iter chan_iter
;
7761 struct ust_app_channel
*ua_chan
;
7762 struct ust_app_session
*ua_sess
;
7763 struct ust_registry_session
*registry
;
7765 ua_sess
= lookup_session_by_app(usess
, app
);
7767 /* Session not associated with this app. */
7771 /* Get the right consumer socket for the application. */
7772 socket
= consumer_find_socket_by_bitness(
7773 app
->bits_per_long
, usess
->consumer
);
7775 ret
= LTTNG_ERR_FATAL
;
7779 registry
= get_session_registry(ua_sess
);
7781 DBG("Application session is being torn down. Skip application.");
7785 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7786 &chan_iter
.iter
, ua_chan
, node
.node
) {
7787 const int open_ret
=
7788 consumer_open_channel_packets(
7794 * Per-PID buffer and application going
7797 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7801 ret
= LTTNG_ERR_UNK
;