2 * Copyright (C) 2011 EfficiOS Inc.
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"
52 #include "ust-field-utils.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
;
199 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 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 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 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
;
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
,
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
,
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 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
,
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
,
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
;
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
;
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
;
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
;
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
;
931 pthread_mutex_lock(&ua_sess
->lock
);
933 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
;
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
);
1323 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 assert(cond_status
== LTTNG_CONDITION_STATUS_OK
);
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 occurred. */
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 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 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 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 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
;
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
);
1978 * Treat this the same way as an application that is
1982 } else if (ret
< 0) {
1985 /* We don't need the stream anymore once sent to the tracer. */
1986 cds_list_del(&stream
->list
);
1987 delete_ust_app_stream(-1, stream
, app
);
1989 /* Flag the channel that it is sent to the application. */
1990 ua_chan
->is_sent
= 1;
1993 health_code_update();
1998 * Create the specified event onto the UST tracer for a UST session.
2000 * Should be called with session mutex held.
2003 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2004 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
2008 health_code_update();
2010 /* Create UST event on tracer */
2011 pthread_mutex_lock(&app
->sock_lock
);
2012 ret
= lttng_ust_ctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
2014 pthread_mutex_unlock(&app
->sock_lock
);
2016 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2018 DBG3("UST app create event failed. Application is dead: pid = %d, sock = %d",
2019 app
->pid
, app
->sock
);
2020 } else if (ret
== -EAGAIN
) {
2022 WARN("UST app create event failed. Communication time out: pid = %d, sock = %d",
2023 app
->pid
, app
->sock
);
2025 ERR("UST app create event '%s' failed with ret %d: pid = %d, sock = %d",
2026 ua_event
->attr
.name
, ret
, app
->pid
,
2032 ua_event
->handle
= ua_event
->obj
->handle
;
2034 DBG2("UST app event %s created successfully for pid:%d object = %p",
2035 ua_event
->attr
.name
, app
->pid
, ua_event
->obj
);
2037 health_code_update();
2039 /* Set filter if one is present. */
2040 if (ua_event
->filter
) {
2041 ret
= set_ust_object_filter(app
, ua_event
->filter
, ua_event
->obj
);
2047 /* Set exclusions for the event */
2048 if (ua_event
->exclusion
) {
2049 ret
= set_ust_object_exclusions(app
, ua_event
->exclusion
, ua_event
->obj
);
2055 /* If event not enabled, disable it on the tracer */
2056 if (ua_event
->enabled
) {
2058 * We now need to explicitly enable the event, since it
2059 * is now disabled at creation.
2061 ret
= enable_ust_object(app
, ua_event
->obj
);
2064 * If we hit an EPERM, something is wrong with our enable call. If
2065 * we get an EEXIST, there is a problem on the tracer side since we
2069 case -LTTNG_UST_ERR_PERM
:
2070 /* Code flow problem */
2072 case -LTTNG_UST_ERR_EXIST
:
2073 /* It's OK for our use case. */
2084 health_code_update();
2088 static int init_ust_event_notifier_from_event_rule(
2089 const struct lttng_event_rule
*rule
,
2090 struct lttng_ust_abi_event_notifier
*event_notifier
)
2092 enum lttng_event_rule_status status
;
2093 enum lttng_ust_abi_loglevel_type ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2094 int loglevel
= -1, ret
= 0;
2095 const char *pattern
;
2098 memset(event_notifier
, 0, sizeof(*event_notifier
));
2100 if (lttng_event_rule_targets_agent_domain(rule
)) {
2102 * Special event for agents
2103 * The actual meat of the event is in the filter that will be
2104 * attached later on.
2105 * Set the default values for the agent event.
2107 pattern
= event_get_default_agent_ust_name(
2108 lttng_event_rule_get_domain_type(rule
));
2110 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2112 const struct lttng_log_level_rule
*log_level_rule
;
2114 assert(lttng_event_rule_get_type(rule
) ==
2115 LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
);
2117 status
= lttng_event_rule_user_tracepoint_get_name_pattern(rule
, &pattern
);
2118 if (status
!= LTTNG_EVENT_RULE_STATUS_OK
) {
2119 /* At this point, this is a fatal error. */
2123 status
= lttng_event_rule_user_tracepoint_get_log_level_rule(
2124 rule
, &log_level_rule
);
2125 if (status
== LTTNG_EVENT_RULE_STATUS_UNSET
) {
2126 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_ALL
;
2127 } else if (status
== LTTNG_EVENT_RULE_STATUS_OK
) {
2128 enum lttng_log_level_rule_status llr_status
;
2130 switch (lttng_log_level_rule_get_type(log_level_rule
)) {
2131 case LTTNG_LOG_LEVEL_RULE_TYPE_EXACTLY
:
2132 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_SINGLE
;
2133 llr_status
= lttng_log_level_rule_exactly_get_level(
2134 log_level_rule
, &loglevel
);
2136 case LTTNG_LOG_LEVEL_RULE_TYPE_AT_LEAST_AS_SEVERE_AS
:
2137 ust_loglevel_type
= LTTNG_UST_ABI_LOGLEVEL_RANGE
;
2138 llr_status
= lttng_log_level_rule_at_least_as_severe_as_get_level(
2139 log_level_rule
, &loglevel
);
2145 assert(llr_status
== LTTNG_LOG_LEVEL_RULE_STATUS_OK
);
2147 /* At this point this is a fatal error. */
2152 event_notifier
->event
.instrumentation
= LTTNG_UST_ABI_TRACEPOINT
;
2153 ret
= lttng_strncpy(event_notifier
->event
.name
, pattern
,
2154 sizeof(event_notifier
->event
.name
));
2156 ERR("Failed to copy event rule pattern to notifier: pattern = '%s' ",
2161 event_notifier
->event
.loglevel_type
= ust_loglevel_type
;
2162 event_notifier
->event
.loglevel
= loglevel
;
2168 * Create the specified event notifier against the user space tracer of a
2169 * given application.
2171 static int create_ust_event_notifier(struct ust_app
*app
,
2172 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
)
2175 enum lttng_condition_status condition_status
;
2176 const struct lttng_condition
*condition
= NULL
;
2177 struct lttng_ust_abi_event_notifier event_notifier
;
2178 const struct lttng_event_rule
*event_rule
= NULL
;
2179 unsigned int capture_bytecode_count
= 0, i
;
2180 enum lttng_condition_status cond_status
;
2181 enum lttng_event_rule_type event_rule_type
;
2183 health_code_update();
2184 assert(app
->event_notifier_group
.object
);
2186 condition
= lttng_trigger_get_const_condition(
2187 ua_event_notifier_rule
->trigger
);
2189 assert(lttng_condition_get_type(condition
) ==
2190 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
);
2192 condition_status
= lttng_condition_event_rule_matches_get_rule(
2193 condition
, &event_rule
);
2194 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
2198 event_rule_type
= lttng_event_rule_get_type(event_rule
);
2199 assert(event_rule_type
== LTTNG_EVENT_RULE_TYPE_USER_TRACEPOINT
||
2200 event_rule_type
== LTTNG_EVENT_RULE_TYPE_JUL_LOGGING
||
2202 LTTNG_EVENT_RULE_TYPE_LOG4J_LOGGING
||
2204 LTTNG_EVENT_RULE_TYPE_PYTHON_LOGGING
);
2206 init_ust_event_notifier_from_event_rule(event_rule
, &event_notifier
);
2207 event_notifier
.event
.token
= ua_event_notifier_rule
->token
;
2208 event_notifier
.error_counter_index
= ua_event_notifier_rule
->error_counter_index
;
2210 /* Create UST event notifier against the tracer. */
2211 pthread_mutex_lock(&app
->sock_lock
);
2212 ret
= lttng_ust_ctl_create_event_notifier(app
->sock
, &event_notifier
,
2213 app
->event_notifier_group
.object
,
2214 &ua_event_notifier_rule
->obj
);
2215 pthread_mutex_unlock(&app
->sock_lock
);
2217 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2219 DBG3("UST app create event notifier failed. Application is dead: pid = %d, sock = %d",
2220 app
->pid
, app
->sock
);
2221 } else if (ret
== -EAGAIN
) {
2223 WARN("UST app create event notifier failed. Communication time out: pid = %d, sock = %d",
2224 app
->pid
, app
->sock
);
2226 ERR("UST app create event notifier '%s' failed with ret %d: pid = %d, sock = %d",
2227 event_notifier
.event
.name
, ret
, app
->pid
,
2233 ua_event_notifier_rule
->handle
= ua_event_notifier_rule
->obj
->handle
;
2235 DBG2("UST app event notifier %s created successfully: app = '%s': pid = %d), object = %p",
2236 event_notifier
.event
.name
, app
->name
, app
->pid
,
2237 ua_event_notifier_rule
->obj
);
2239 health_code_update();
2241 /* Set filter if one is present. */
2242 if (ua_event_notifier_rule
->filter
) {
2243 ret
= set_ust_object_filter(app
, ua_event_notifier_rule
->filter
,
2244 ua_event_notifier_rule
->obj
);
2250 /* Set exclusions for the event. */
2251 if (ua_event_notifier_rule
->exclusion
) {
2252 ret
= set_ust_object_exclusions(app
,
2253 ua_event_notifier_rule
->exclusion
,
2254 ua_event_notifier_rule
->obj
);
2260 /* Set the capture bytecodes. */
2261 cond_status
= lttng_condition_event_rule_matches_get_capture_descriptor_count(
2262 condition
, &capture_bytecode_count
);
2263 assert(cond_status
== LTTNG_CONDITION_STATUS_OK
);
2265 for (i
= 0; i
< capture_bytecode_count
; i
++) {
2266 const struct lttng_bytecode
*capture_bytecode
=
2267 lttng_condition_event_rule_matches_get_capture_bytecode_at_index(
2270 ret
= set_ust_capture(app
, capture_bytecode
, i
,
2271 ua_event_notifier_rule
->obj
);
2278 * We now need to explicitly enable the event, since it
2279 * is disabled at creation.
2281 ret
= enable_ust_object(app
, ua_event_notifier_rule
->obj
);
2284 * If we hit an EPERM, something is wrong with our enable call.
2285 * If we get an EEXIST, there is a problem on the tracer side
2286 * since we just created it.
2289 case -LTTNG_UST_ERR_PERM
:
2290 /* Code flow problem. */
2292 case -LTTNG_UST_ERR_EXIST
:
2293 /* It's OK for our use case. */
2303 ua_event_notifier_rule
->enabled
= true;
2306 health_code_update();
2311 * Copy data between an UST app event and a LTT event.
2313 static void shadow_copy_event(struct ust_app_event
*ua_event
,
2314 struct ltt_ust_event
*uevent
)
2316 size_t exclusion_alloc_size
;
2318 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
2319 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
2321 ua_event
->enabled
= uevent
->enabled
;
2323 /* Copy event attributes */
2324 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
2326 /* Copy filter bytecode */
2327 if (uevent
->filter
) {
2328 ua_event
->filter
= lttng_bytecode_copy(uevent
->filter
);
2329 /* Filter might be NULL here in case of ENONEM. */
2332 /* Copy exclusion data */
2333 if (uevent
->exclusion
) {
2334 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
2335 LTTNG_UST_ABI_SYM_NAME_LEN
* uevent
->exclusion
->count
;
2336 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
2337 if (ua_event
->exclusion
== NULL
) {
2340 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
2341 exclusion_alloc_size
);
2347 * Copy data between an UST app channel and a LTT channel.
2349 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
2350 struct ltt_ust_channel
*uchan
)
2352 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
2354 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
2355 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
2357 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
2358 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
2360 /* Copy event attributes since the layout is different. */
2361 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
2362 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
2363 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
2364 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
2365 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
2366 ua_chan
->monitor_timer_interval
= uchan
->monitor_timer_interval
;
2367 ua_chan
->attr
.output
= uchan
->attr
.output
;
2368 ua_chan
->attr
.blocking_timeout
= uchan
->attr
.u
.s
.blocking_timeout
;
2371 * Note that the attribute channel type is not set since the channel on the
2372 * tracing registry side does not have this information.
2375 ua_chan
->enabled
= uchan
->enabled
;
2376 ua_chan
->tracing_channel_id
= uchan
->id
;
2378 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
2382 * Copy data between a UST app session and a regular LTT session.
2384 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
2385 struct ltt_ust_session
*usess
, struct ust_app
*app
)
2387 struct tm
*timeinfo
;
2390 char tmp_shm_path
[PATH_MAX
];
2392 timeinfo
= localtime(&app
->registration_time
);
2393 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
2395 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
2397 ua_sess
->tracing_id
= usess
->id
;
2398 ua_sess
->id
= get_next_session_id();
2399 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.uid
, app
->uid
);
2400 LTTNG_OPTIONAL_SET(&ua_sess
->real_credentials
.gid
, app
->gid
);
2401 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.uid
, usess
->uid
);
2402 LTTNG_OPTIONAL_SET(&ua_sess
->effective_credentials
.gid
, usess
->gid
);
2403 ua_sess
->buffer_type
= usess
->buffer_type
;
2404 ua_sess
->bits_per_long
= app
->bits_per_long
;
2406 /* There is only one consumer object per session possible. */
2407 consumer_output_get(usess
->consumer
);
2408 ua_sess
->consumer
= usess
->consumer
;
2410 ua_sess
->output_traces
= usess
->output_traces
;
2411 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
2412 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
2413 &usess
->metadata_attr
);
2415 switch (ua_sess
->buffer_type
) {
2416 case LTTNG_BUFFER_PER_PID
:
2417 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2418 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
2421 case LTTNG_BUFFER_PER_UID
:
2422 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
2423 DEFAULT_UST_TRACE_UID_PATH
,
2424 lttng_credentials_get_uid(&ua_sess
->real_credentials
),
2425 app
->bits_per_long
);
2432 PERROR("asprintf UST shadow copy session");
2437 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
2438 sizeof(ua_sess
->root_shm_path
));
2439 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
2440 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
2441 sizeof(ua_sess
->shm_path
));
2442 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2443 if (ua_sess
->shm_path
[0]) {
2444 switch (ua_sess
->buffer_type
) {
2445 case LTTNG_BUFFER_PER_PID
:
2446 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2447 "/" DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
2448 app
->name
, app
->pid
, datetime
);
2450 case LTTNG_BUFFER_PER_UID
:
2451 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
2452 "/" DEFAULT_UST_TRACE_UID_PATH
,
2453 app
->uid
, app
->bits_per_long
);
2460 PERROR("sprintf UST shadow copy session");
2464 strncat(ua_sess
->shm_path
, tmp_shm_path
,
2465 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
2466 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
2471 consumer_output_put(ua_sess
->consumer
);
2475 * Lookup sesison wrapper.
2478 void __lookup_session_by_app(const struct ltt_ust_session
*usess
,
2479 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
2481 /* Get right UST app session from app */
2482 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
2486 * Return ust app session from the app session hashtable using the UST session
2489 static struct ust_app_session
*lookup_session_by_app(
2490 const struct ltt_ust_session
*usess
, struct ust_app
*app
)
2492 struct lttng_ht_iter iter
;
2493 struct lttng_ht_node_u64
*node
;
2495 __lookup_session_by_app(usess
, app
, &iter
);
2496 node
= lttng_ht_iter_get_node_u64(&iter
);
2501 return caa_container_of(node
, struct ust_app_session
, node
);
2508 * Setup buffer registry per PID for the given session and application. If none
2509 * is found, a new one is created, added to the global registry and
2510 * initialized. If regp is valid, it's set with the newly created object.
2512 * Return 0 on success or else a negative value.
2514 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
2515 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
2518 struct buffer_reg_pid
*reg_pid
;
2525 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
2528 * This is the create channel path meaning that if there is NO
2529 * registry available, we have to create one for this session.
2531 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
2532 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2540 /* Initialize registry. */
2541 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
2542 app
->bits_per_long
, app
->uint8_t_alignment
,
2543 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2544 app
->uint64_t_alignment
, app
->long_alignment
,
2545 app
->byte_order
, app
->version
.major
, app
->version
.minor
,
2546 reg_pid
->root_shm_path
, reg_pid
->shm_path
,
2547 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
2548 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
2549 ua_sess
->tracing_id
,
2553 * reg_pid->registry->reg.ust is NULL upon error, so we need to
2554 * destroy the buffer registry, because it is always expected
2555 * that if the buffer registry can be found, its ust registry is
2558 buffer_reg_pid_destroy(reg_pid
);
2562 buffer_reg_pid_add(reg_pid
);
2564 DBG3("UST app buffer registry per PID created successfully");
2576 * Setup buffer registry per UID for the given session and application. If none
2577 * is found, a new one is created, added to the global registry and
2578 * initialized. If regp is valid, it's set with the newly created object.
2580 * Return 0 on success or else a negative value.
2582 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
2583 struct ust_app_session
*ua_sess
,
2584 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
2587 struct buffer_reg_uid
*reg_uid
;
2594 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2597 * This is the create channel path meaning that if there is NO
2598 * registry available, we have to create one for this session.
2600 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2601 LTTNG_DOMAIN_UST
, ®_uid
,
2602 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2610 /* Initialize registry. */
2611 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2612 app
->bits_per_long
, app
->uint8_t_alignment
,
2613 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2614 app
->uint64_t_alignment
, app
->long_alignment
,
2615 app
->byte_order
, app
->version
.major
,
2616 app
->version
.minor
, reg_uid
->root_shm_path
,
2617 reg_uid
->shm_path
, usess
->uid
, usess
->gid
,
2618 ua_sess
->tracing_id
, app
->uid
);
2621 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2622 * destroy the buffer registry, because it is always expected
2623 * that if the buffer registry can be found, its ust registry is
2626 buffer_reg_uid_destroy(reg_uid
, NULL
);
2629 /* Add node to teardown list of the session. */
2630 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2632 buffer_reg_uid_add(reg_uid
);
2634 DBG3("UST app buffer registry per UID created successfully");
2645 * Create a session on the tracer side for the given app.
2647 * On success, ua_sess_ptr is populated with the session pointer or else left
2648 * untouched. If the session was created, is_created is set to 1. On error,
2649 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2652 * Returns 0 on success or else a negative code which is either -ENOMEM or
2653 * -ENOTCONN which is the default code if the lttng_ust_ctl_create_session fails.
2655 static int find_or_create_ust_app_session(struct ltt_ust_session
*usess
,
2656 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2659 int ret
, created
= 0;
2660 struct ust_app_session
*ua_sess
;
2664 assert(ua_sess_ptr
);
2666 health_code_update();
2668 ua_sess
= lookup_session_by_app(usess
, app
);
2669 if (ua_sess
== NULL
) {
2670 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2671 app
->pid
, usess
->id
);
2672 ua_sess
= alloc_ust_app_session();
2673 if (ua_sess
== NULL
) {
2674 /* Only malloc can failed so something is really wrong */
2678 shadow_copy_session(ua_sess
, usess
, app
);
2682 switch (usess
->buffer_type
) {
2683 case LTTNG_BUFFER_PER_PID
:
2684 /* Init local registry. */
2685 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2687 delete_ust_app_session(-1, ua_sess
, app
);
2691 case LTTNG_BUFFER_PER_UID
:
2692 /* Look for a global registry. If none exists, create one. */
2693 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2695 delete_ust_app_session(-1, ua_sess
, app
);
2705 health_code_update();
2707 if (ua_sess
->handle
== -1) {
2708 pthread_mutex_lock(&app
->sock_lock
);
2709 ret
= lttng_ust_ctl_create_session(app
->sock
);
2710 pthread_mutex_unlock(&app
->sock_lock
);
2712 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2713 DBG("UST app creating session failed. Application is dead: pid = %d, sock = %d",
2714 app
->pid
, app
->sock
);
2716 } else if (ret
== -EAGAIN
) {
2717 DBG("UST app creating session failed. Communication time out: pid = %d, sock = %d",
2718 app
->pid
, app
->sock
);
2721 ERR("UST app creating session failed with ret %d: pid = %d, sock =%d",
2722 ret
, app
->pid
, app
->sock
);
2724 delete_ust_app_session(-1, ua_sess
, app
);
2725 if (ret
!= -ENOMEM
) {
2727 * Tracer is probably gone or got an internal error so let's
2728 * behave like it will soon unregister or not usable.
2735 ua_sess
->handle
= ret
;
2737 /* Add ust app session to app's HT */
2738 lttng_ht_node_init_u64(&ua_sess
->node
,
2739 ua_sess
->tracing_id
);
2740 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2741 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2742 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2743 &ua_sess
->ust_objd_node
);
2745 DBG2("UST app session created successfully with handle %d", ret
);
2748 *ua_sess_ptr
= ua_sess
;
2750 *is_created
= created
;
2753 /* Everything went well. */
2757 health_code_update();
2762 * Match function for a hash table lookup of ust_app_ctx.
2764 * It matches an ust app context based on the context type and, in the case
2765 * of perf counters, their name.
2767 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2769 struct ust_app_ctx
*ctx
;
2770 const struct lttng_ust_context_attr
*key
;
2775 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2779 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2784 case LTTNG_UST_ABI_CONTEXT_PERF_THREAD_COUNTER
:
2785 if (strncmp(key
->u
.perf_counter
.name
,
2786 ctx
->ctx
.u
.perf_counter
.name
,
2787 sizeof(key
->u
.perf_counter
.name
))) {
2791 case LTTNG_UST_ABI_CONTEXT_APP_CONTEXT
:
2792 if (strcmp(key
->u
.app_ctx
.provider_name
,
2793 ctx
->ctx
.u
.app_ctx
.provider_name
) ||
2794 strcmp(key
->u
.app_ctx
.ctx_name
,
2795 ctx
->ctx
.u
.app_ctx
.ctx_name
)) {
2811 * Lookup for an ust app context from an lttng_ust_context.
2813 * Must be called while holding RCU read side lock.
2814 * Return an ust_app_ctx object or NULL on error.
2817 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2818 struct lttng_ust_context_attr
*uctx
)
2820 struct lttng_ht_iter iter
;
2821 struct lttng_ht_node_ulong
*node
;
2822 struct ust_app_ctx
*app_ctx
= NULL
;
2827 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2828 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2829 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2830 node
= lttng_ht_iter_get_node_ulong(&iter
);
2835 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2842 * Create a context for the channel on the tracer.
2844 * Called with UST app session lock held and a RCU read side lock.
2847 int create_ust_app_channel_context(struct ust_app_channel
*ua_chan
,
2848 struct lttng_ust_context_attr
*uctx
,
2849 struct ust_app
*app
)
2852 struct ust_app_ctx
*ua_ctx
;
2854 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2856 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2862 ua_ctx
= alloc_ust_app_ctx(uctx
);
2863 if (ua_ctx
== NULL
) {
2869 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2870 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2871 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2873 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2883 * Enable on the tracer side a ust app event for the session and channel.
2885 * Called with UST app session lock held.
2888 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2889 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2893 ret
= enable_ust_object(app
, ua_event
->obj
);
2898 ua_event
->enabled
= 1;
2905 * Disable on the tracer side a ust app event for the session and channel.
2907 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2908 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2912 ret
= disable_ust_object(app
, ua_event
->obj
);
2917 ua_event
->enabled
= 0;
2924 * Lookup ust app channel for session and disable it on the tracer side.
2927 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2928 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2932 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2937 ua_chan
->enabled
= 0;
2944 * Lookup ust app channel for session and enable it on the tracer side. This
2945 * MUST be called with a RCU read side lock acquired.
2947 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2948 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2951 struct lttng_ht_iter iter
;
2952 struct lttng_ht_node_str
*ua_chan_node
;
2953 struct ust_app_channel
*ua_chan
;
2955 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2956 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2957 if (ua_chan_node
== NULL
) {
2958 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2959 uchan
->name
, ua_sess
->tracing_id
);
2963 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2965 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2975 * Ask the consumer to create a channel and get it if successful.
2977 * Called with UST app session lock held.
2979 * Return 0 on success or else a negative value.
2981 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2982 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2983 int bitness
, struct ust_registry_session
*registry
,
2984 uint64_t trace_archive_id
)
2987 unsigned int nb_fd
= 0;
2988 struct consumer_socket
*socket
;
2996 health_code_update();
2998 /* Get the right consumer socket for the application. */
2999 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
3005 health_code_update();
3007 /* Need one fd for the channel. */
3008 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3010 ERR("Exhausted number of available FD upon create channel");
3015 * Ask consumer to create channel. The consumer will return the number of
3016 * stream we have to expect.
3018 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
3019 registry
, usess
->current_trace_chunk
);
3025 * Compute the number of fd needed before receiving them. It must be 2 per
3026 * stream (2 being the default value here).
3028 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
3030 /* Reserve the amount of file descriptor we need. */
3031 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
3033 ERR("Exhausted number of available FD upon create channel");
3034 goto error_fd_get_stream
;
3037 health_code_update();
3040 * Now get the channel from the consumer. This call will populate the stream
3041 * list of that channel and set the ust objects.
3043 if (usess
->consumer
->enabled
) {
3044 ret
= ust_consumer_get_channel(socket
, ua_chan
);
3054 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
3055 error_fd_get_stream
:
3057 * Initiate a destroy channel on the consumer since we had an error
3058 * handling it on our side. The return value is of no importance since we
3059 * already have a ret value set by the previous error that we need to
3062 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
3064 lttng_fd_put(LTTNG_FD_APPS
, 1);
3066 health_code_update();
3072 * Duplicate the ust data object of the ust app stream and save it in the
3073 * buffer registry stream.
3075 * Return 0 on success or else a negative value.
3077 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
3078 struct ust_app_stream
*stream
)
3085 /* Duplicating a stream requires 2 new fds. Reserve them. */
3086 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3088 ERR("Exhausted number of available FD upon duplicate stream");
3092 /* Duplicate object for stream once the original is in the registry. */
3093 ret
= lttng_ust_ctl_duplicate_ust_object_data(&stream
->obj
,
3094 reg_stream
->obj
.ust
);
3096 ERR("Duplicate stream obj from %p to %p failed with ret %d",
3097 reg_stream
->obj
.ust
, stream
->obj
, ret
);
3098 lttng_fd_put(LTTNG_FD_APPS
, 2);
3101 stream
->handle
= stream
->obj
->handle
;
3108 * Duplicate the ust data object of the ust app. channel and save it in the
3109 * buffer registry channel.
3111 * Return 0 on success or else a negative value.
3113 static int duplicate_channel_object(struct buffer_reg_channel
*buf_reg_chan
,
3114 struct ust_app_channel
*ua_chan
)
3118 assert(buf_reg_chan
);
3121 /* Duplicating a channel requires 1 new fd. Reserve it. */
3122 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3124 ERR("Exhausted number of available FD upon duplicate channel");
3128 /* Duplicate object for stream once the original is in the registry. */
3129 ret
= lttng_ust_ctl_duplicate_ust_object_data(&ua_chan
->obj
, buf_reg_chan
->obj
.ust
);
3131 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
3132 buf_reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
3135 ua_chan
->handle
= ua_chan
->obj
->handle
;
3140 lttng_fd_put(LTTNG_FD_APPS
, 1);
3146 * For a given channel buffer registry, setup all streams of the given ust
3147 * application channel.
3149 * Return 0 on success or else a negative value.
3151 static int setup_buffer_reg_streams(struct buffer_reg_channel
*buf_reg_chan
,
3152 struct ust_app_channel
*ua_chan
,
3153 struct ust_app
*app
)
3156 struct ust_app_stream
*stream
, *stmp
;
3158 assert(buf_reg_chan
);
3161 DBG2("UST app setup buffer registry stream");
3163 /* Send all streams to application. */
3164 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
3165 struct buffer_reg_stream
*reg_stream
;
3167 ret
= buffer_reg_stream_create(®_stream
);
3173 * Keep original pointer and nullify it in the stream so the delete
3174 * stream call does not release the object.
3176 reg_stream
->obj
.ust
= stream
->obj
;
3178 buffer_reg_stream_add(reg_stream
, buf_reg_chan
);
3180 /* We don't need the streams anymore. */
3181 cds_list_del(&stream
->list
);
3182 delete_ust_app_stream(-1, stream
, app
);
3190 * Create a buffer registry channel for the given session registry and
3191 * application channel object. If regp pointer is valid, it's set with the
3192 * created object. Important, the created object is NOT added to the session
3193 * registry hash table.
3195 * Return 0 on success else a negative value.
3197 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3198 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
3201 struct buffer_reg_channel
*buf_reg_chan
= NULL
;
3206 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
3208 /* Create buffer registry channel. */
3209 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, &buf_reg_chan
);
3213 assert(buf_reg_chan
);
3214 buf_reg_chan
->consumer_key
= ua_chan
->key
;
3215 buf_reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
3216 buf_reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
3218 /* Create and add a channel registry to session. */
3219 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
3220 ua_chan
->tracing_channel_id
);
3224 buffer_reg_channel_add(reg_sess
, buf_reg_chan
);
3227 *regp
= buf_reg_chan
;
3233 /* Safe because the registry channel object was not added to any HT. */
3234 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3240 * Setup buffer registry channel for the given session registry and application
3241 * channel object. If regp pointer is valid, it's set with the created object.
3243 * Return 0 on success else a negative value.
3245 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
3246 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*buf_reg_chan
,
3247 struct ust_app
*app
)
3252 assert(buf_reg_chan
);
3254 assert(ua_chan
->obj
);
3256 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
3258 /* Setup all streams for the registry. */
3259 ret
= setup_buffer_reg_streams(buf_reg_chan
, ua_chan
, app
);
3264 buf_reg_chan
->obj
.ust
= ua_chan
->obj
;
3265 ua_chan
->obj
= NULL
;
3270 buffer_reg_channel_remove(reg_sess
, buf_reg_chan
);
3271 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3276 * Send buffer registry channel to the application.
3278 * Return 0 on success else a negative value.
3280 static int send_channel_uid_to_ust(struct buffer_reg_channel
*buf_reg_chan
,
3281 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
3282 struct ust_app_channel
*ua_chan
)
3285 struct buffer_reg_stream
*reg_stream
;
3287 assert(buf_reg_chan
);
3292 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
3294 ret
= duplicate_channel_object(buf_reg_chan
, ua_chan
);
3299 /* Send channel to the application. */
3300 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
3301 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3302 ret
= -ENOTCONN
; /* Caused by app exiting. */
3304 } else if (ret
== -EAGAIN
) {
3305 /* Caused by timeout. */
3306 WARN("Communication with application %d timed out on send_channel for channel \"%s\" of session \"%" PRIu64
"\".",
3307 app
->pid
, ua_chan
->name
, ua_sess
->tracing_id
);
3308 /* Treat this the same way as an application that is exiting. */
3311 } else if (ret
< 0) {
3315 health_code_update();
3317 /* Send all streams to application. */
3318 pthread_mutex_lock(&buf_reg_chan
->stream_list_lock
);
3319 cds_list_for_each_entry(reg_stream
, &buf_reg_chan
->streams
, lnode
) {
3320 struct ust_app_stream stream
= {};
3322 ret
= duplicate_stream_object(reg_stream
, &stream
);
3324 goto error_stream_unlock
;
3327 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
3329 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
3330 ret
= -ENOTCONN
; /* Caused by app exiting. */
3331 } else if (ret
== -EAGAIN
) {
3333 * Caused by timeout.
3334 * Treat this the same way as an application
3337 WARN("Communication with application %d timed out on send_stream for stream of channel \"%s\" of session \"%" PRIu64
"\".",
3340 ua_sess
->tracing_id
);
3343 (void) release_ust_app_stream(-1, &stream
, app
);
3344 goto error_stream_unlock
;
3348 * The return value is not important here. This function will output an
3351 (void) release_ust_app_stream(-1, &stream
, app
);
3353 ua_chan
->is_sent
= 1;
3355 error_stream_unlock
:
3356 pthread_mutex_unlock(&buf_reg_chan
->stream_list_lock
);
3362 * Create and send to the application the created buffers with per UID buffers.
3364 * This MUST be called with a RCU read side lock acquired.
3365 * The session list lock and the session's lock must be acquired.
3367 * Return 0 on success else a negative value.
3369 static int create_channel_per_uid(struct ust_app
*app
,
3370 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3371 struct ust_app_channel
*ua_chan
)
3374 struct buffer_reg_uid
*reg_uid
;
3375 struct buffer_reg_channel
*buf_reg_chan
;
3376 struct ltt_session
*session
= NULL
;
3377 enum lttng_error_code notification_ret
;
3378 struct ust_registry_channel
*ust_reg_chan
;
3385 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
3387 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
3389 * The session creation handles the creation of this global registry
3390 * object. If none can be find, there is a code flow problem or a
3395 buf_reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
3401 /* Create the buffer registry channel object. */
3402 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, &buf_reg_chan
);
3404 ERR("Error creating the UST channel \"%s\" registry instance",
3409 session
= session_find_by_id(ua_sess
->tracing_id
);
3411 assert(pthread_mutex_trylock(&session
->lock
));
3412 assert(session_trylock_list());
3415 * Create the buffers on the consumer side. This call populates the
3416 * ust app channel object with all streams and data object.
3418 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3419 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
,
3420 session
->most_recent_chunk_id
.value
);
3422 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3426 * Let's remove the previously created buffer registry channel so
3427 * it's not visible anymore in the session registry.
3429 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
3430 ua_chan
->tracing_channel_id
, false);
3431 buffer_reg_channel_remove(reg_uid
->registry
, buf_reg_chan
);
3432 buffer_reg_channel_destroy(buf_reg_chan
, LTTNG_DOMAIN_UST
);
3437 * Setup the streams and add it to the session registry.
3439 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
3440 ua_chan
, buf_reg_chan
, app
);
3442 ERR("Error setting up UST channel \"%s\"", ua_chan
->name
);
3446 /* Notify the notification subsystem of the channel's creation. */
3447 pthread_mutex_lock(®_uid
->registry
->reg
.ust
->lock
);
3448 ust_reg_chan
= ust_registry_channel_find(reg_uid
->registry
->reg
.ust
,
3449 ua_chan
->tracing_channel_id
);
3450 assert(ust_reg_chan
);
3451 ust_reg_chan
->consumer_key
= ua_chan
->key
;
3452 ust_reg_chan
= NULL
;
3453 pthread_mutex_unlock(®_uid
->registry
->reg
.ust
->lock
);
3455 notification_ret
= notification_thread_command_add_channel(
3456 the_notification_thread_handle
, session
->name
,
3457 lttng_credentials_get_uid(
3458 &ua_sess
->effective_credentials
),
3459 lttng_credentials_get_gid(
3460 &ua_sess
->effective_credentials
),
3461 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3462 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3463 if (notification_ret
!= LTTNG_OK
) {
3464 ret
= - (int) notification_ret
;
3465 ERR("Failed to add channel to notification thread");
3470 /* Send buffers to the application. */
3471 ret
= send_channel_uid_to_ust(buf_reg_chan
, app
, ua_sess
, ua_chan
);
3473 if (ret
!= -ENOTCONN
) {
3474 ERR("Error sending channel to application");
3481 session_put(session
);
3487 * Create and send to the application the created buffers with per PID buffers.
3489 * Called with UST app session lock held.
3490 * The session list lock and the session's lock must be acquired.
3492 * Return 0 on success else a negative value.
3494 static int create_channel_per_pid(struct ust_app
*app
,
3495 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3496 struct ust_app_channel
*ua_chan
)
3499 struct ust_registry_session
*registry
;
3500 enum lttng_error_code cmd_ret
;
3501 struct ltt_session
*session
= NULL
;
3502 uint64_t chan_reg_key
;
3503 struct ust_registry_channel
*ust_reg_chan
;
3510 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
3514 registry
= get_session_registry(ua_sess
);
3515 /* The UST app session lock is held, registry shall not be null. */
3518 /* Create and add a new channel registry to session. */
3519 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
3521 ERR("Error creating the UST channel \"%s\" registry instance",
3526 session
= session_find_by_id(ua_sess
->tracing_id
);
3529 assert(pthread_mutex_trylock(&session
->lock
));
3530 assert(session_trylock_list());
3532 /* Create and get channel on the consumer side. */
3533 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
3534 app
->bits_per_long
, registry
,
3535 session
->most_recent_chunk_id
.value
);
3537 ERR("Error creating UST channel \"%s\" on the consumer daemon",
3539 goto error_remove_from_registry
;
3542 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
3544 if (ret
!= -ENOTCONN
) {
3545 ERR("Error sending channel to application");
3547 goto error_remove_from_registry
;
3550 chan_reg_key
= ua_chan
->key
;
3551 pthread_mutex_lock(®istry
->lock
);
3552 ust_reg_chan
= ust_registry_channel_find(registry
, chan_reg_key
);
3553 assert(ust_reg_chan
);
3554 ust_reg_chan
->consumer_key
= ua_chan
->key
;
3555 pthread_mutex_unlock(®istry
->lock
);
3557 cmd_ret
= notification_thread_command_add_channel(
3558 the_notification_thread_handle
, session
->name
,
3559 lttng_credentials_get_uid(
3560 &ua_sess
->effective_credentials
),
3561 lttng_credentials_get_gid(
3562 &ua_sess
->effective_credentials
),
3563 ua_chan
->name
, ua_chan
->key
, LTTNG_DOMAIN_UST
,
3564 ua_chan
->attr
.subbuf_size
* ua_chan
->attr
.num_subbuf
);
3565 if (cmd_ret
!= LTTNG_OK
) {
3566 ret
= - (int) cmd_ret
;
3567 ERR("Failed to add channel to notification thread");
3568 goto error_remove_from_registry
;
3571 error_remove_from_registry
:
3573 ust_registry_channel_del_free(registry
, ua_chan
->key
, false);
3578 session_put(session
);
3584 * From an already allocated ust app channel, create the channel buffers if
3585 * needed and send them to the application. This MUST be called with a RCU read
3586 * side lock acquired.
3588 * Called with UST app session lock held.
3590 * Return 0 on success or else a negative value. Returns -ENOTCONN if
3591 * the application exited concurrently.
3593 static int ust_app_channel_send(struct ust_app
*app
,
3594 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
3595 struct ust_app_channel
*ua_chan
)
3601 assert(usess
->active
);
3605 /* Handle buffer type before sending the channel to the application. */
3606 switch (usess
->buffer_type
) {
3607 case LTTNG_BUFFER_PER_UID
:
3609 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
3615 case LTTNG_BUFFER_PER_PID
:
3617 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
3629 /* Initialize ust objd object using the received handle and add it. */
3630 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
3631 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
3633 /* If channel is not enabled, disable it on the tracer */
3634 if (!ua_chan
->enabled
) {
3635 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
3646 * Create UST app channel and return it through ua_chanp if not NULL.
3648 * Called with UST app session lock and RCU read-side lock held.
3650 * Return 0 on success or else a negative value.
3652 static int ust_app_channel_allocate(struct ust_app_session
*ua_sess
,
3653 struct ltt_ust_channel
*uchan
,
3654 enum lttng_ust_abi_chan_type type
, struct ltt_ust_session
*usess
,
3655 struct ust_app_channel
**ua_chanp
)
3658 struct lttng_ht_iter iter
;
3659 struct lttng_ht_node_str
*ua_chan_node
;
3660 struct ust_app_channel
*ua_chan
;
3662 /* Lookup channel in the ust app session */
3663 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
3664 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
3665 if (ua_chan_node
!= NULL
) {
3666 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3670 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
3671 if (ua_chan
== NULL
) {
3672 /* Only malloc can fail here */
3676 shadow_copy_channel(ua_chan
, uchan
);
3678 /* Set channel type. */
3679 ua_chan
->attr
.type
= type
;
3681 /* Only add the channel if successful on the tracer side. */
3682 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
3685 *ua_chanp
= ua_chan
;
3688 /* Everything went well. */
3696 * Create UST app event and create it on the tracer side.
3698 * Must be called with the RCU read side lock held.
3699 * Called with ust app session mutex held.
3702 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3703 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3704 struct ust_app
*app
)
3707 struct ust_app_event
*ua_event
;
3709 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3710 if (ua_event
== NULL
) {
3711 /* Only failure mode of alloc_ust_app_event(). */
3715 shadow_copy_event(ua_event
, uevent
);
3717 /* Create it on the tracer side */
3718 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3721 * Not found previously means that it does not exist on the
3722 * tracer. If the application reports that the event existed,
3723 * it means there is a bug in the sessiond or lttng-ust
3724 * (or corruption, etc.)
3726 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3727 ERR("Tracer for application reported that an event being created already existed: "
3728 "event_name = \"%s\", pid = %d, ppid = %d, uid = %d, gid = %d",
3730 app
->pid
, app
->ppid
, app
->uid
,
3736 add_unique_ust_app_event(ua_chan
, ua_event
);
3738 DBG2("UST app create event completed: app = '%s' pid = %d",
3739 app
->name
, app
->pid
);
3745 /* Valid. Calling here is already in a read side lock */
3746 delete_ust_app_event(-1, ua_event
, app
);
3751 * Create UST app event notifier rule and create it on the tracer side.
3753 * Must be called with the RCU read side lock held.
3754 * Called with ust app session mutex held.
3757 int create_ust_app_event_notifier_rule(struct lttng_trigger
*trigger
,
3758 struct ust_app
*app
)
3761 struct ust_app_event_notifier_rule
*ua_event_notifier_rule
;
3763 ua_event_notifier_rule
= alloc_ust_app_event_notifier_rule(trigger
);
3764 if (ua_event_notifier_rule
== NULL
) {
3769 /* Create it on the tracer side. */
3770 ret
= create_ust_event_notifier(app
, ua_event_notifier_rule
);
3773 * Not found previously means that it does not exist on the
3774 * tracer. If the application reports that the event existed,
3775 * it means there is a bug in the sessiond or lttng-ust
3776 * (or corruption, etc.)
3778 if (ret
== -LTTNG_UST_ERR_EXIST
) {
3779 ERR("Tracer for application reported that an event notifier being created already exists: "
3780 "token = \"%" PRIu64
"\", pid = %d, ppid = %d, uid = %d, gid = %d",
3781 lttng_trigger_get_tracer_token(trigger
),
3782 app
->pid
, app
->ppid
, app
->uid
,
3788 lttng_ht_add_unique_u64(app
->token_to_event_notifier_rule_ht
,
3789 &ua_event_notifier_rule
->node
);
3791 DBG2("UST app create token event rule completed: app = '%s', pid = %d), token = %" PRIu64
,
3792 app
->name
, app
->pid
, lttng_trigger_get_tracer_token(trigger
));
3797 /* The RCU read side lock is already being held by the caller. */
3798 delete_ust_app_event_notifier_rule(-1, ua_event_notifier_rule
, app
);
3804 * Create UST metadata and open it on the tracer side.
3806 * Called with UST app session lock held and RCU read side lock.
3808 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3809 struct ust_app
*app
, struct consumer_output
*consumer
)
3812 struct ust_app_channel
*metadata
;
3813 struct consumer_socket
*socket
;
3814 struct ust_registry_session
*registry
;
3815 struct ltt_session
*session
= NULL
;
3821 registry
= get_session_registry(ua_sess
);
3822 /* The UST app session is held registry shall not be null. */
3825 pthread_mutex_lock(®istry
->lock
);
3827 /* Metadata already exists for this registry or it was closed previously */
3828 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3833 /* Allocate UST metadata */
3834 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3836 /* malloc() failed */
3841 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3843 /* Need one fd for the channel. */
3844 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3846 ERR("Exhausted number of available FD upon create metadata");
3850 /* Get the right consumer socket for the application. */
3851 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3854 goto error_consumer
;
3858 * Keep metadata key so we can identify it on the consumer side. Assign it
3859 * to the registry *before* we ask the consumer so we avoid the race of the
3860 * consumer requesting the metadata and the ask_channel call on our side
3861 * did not returned yet.
3863 registry
->metadata_key
= metadata
->key
;
3865 session
= session_find_by_id(ua_sess
->tracing_id
);
3868 assert(pthread_mutex_trylock(&session
->lock
));
3869 assert(session_trylock_list());
3872 * Ask the metadata channel creation to the consumer. The metadata object
3873 * will be created by the consumer and kept their. However, the stream is
3874 * never added or monitored until we do a first push metadata to the
3877 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3878 registry
, session
->current_trace_chunk
);
3880 /* Nullify the metadata key so we don't try to close it later on. */
3881 registry
->metadata_key
= 0;
3882 goto error_consumer
;
3886 * The setup command will make the metadata stream be sent to the relayd,
3887 * if applicable, and the thread managing the metadatas. This is important
3888 * because after this point, if an error occurs, the only way the stream
3889 * can be deleted is to be monitored in the consumer.
3891 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3893 /* Nullify the metadata key so we don't try to close it later on. */
3894 registry
->metadata_key
= 0;
3895 goto error_consumer
;
3898 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3899 metadata
->key
, app
->pid
);
3902 lttng_fd_put(LTTNG_FD_APPS
, 1);
3903 delete_ust_app_channel(-1, metadata
, app
);
3905 pthread_mutex_unlock(®istry
->lock
);
3907 session_put(session
);
3913 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3914 * acquired before calling this function.
3916 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3918 struct ust_app
*app
= NULL
;
3919 struct lttng_ht_node_ulong
*node
;
3920 struct lttng_ht_iter iter
;
3922 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3923 node
= lttng_ht_iter_get_node_ulong(&iter
);
3925 DBG2("UST app no found with pid %d", pid
);
3929 DBG2("Found UST app by pid %d", pid
);
3931 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3938 * Allocate and init an UST app object using the registration information and
3939 * the command socket. This is called when the command socket connects to the
3942 * The object is returned on success or else NULL.
3944 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3947 struct ust_app
*lta
= NULL
;
3948 struct lttng_pipe
*event_notifier_event_source_pipe
= NULL
;
3953 DBG3("UST app creating application for socket %d", sock
);
3955 if ((msg
->bits_per_long
== 64 &&
3956 (uatomic_read(&the_ust_consumerd64_fd
) ==
3958 (msg
->bits_per_long
== 32 &&
3959 (uatomic_read(&the_ust_consumerd32_fd
) ==
3961 ERR("Registration failed: application \"%s\" (pid: %d) has "
3962 "%d-bit long, but no consumerd for this size is available.\n",
3963 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3968 * Reserve the two file descriptors of the event source pipe. The write
3969 * end will be closed once it is passed to the application, at which
3970 * point a single 'put' will be performed.
3972 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
3974 ERR("Failed to reserve two file descriptors for the event source pipe while creating a new application instance: app = '%s', pid = %d",
3975 msg
->name
, (int) msg
->pid
);
3979 event_notifier_event_source_pipe
= lttng_pipe_open(FD_CLOEXEC
);
3980 if (!event_notifier_event_source_pipe
) {
3981 PERROR("Failed to open application event source pipe: '%s' (pid = %d)",
3982 msg
->name
, msg
->pid
);
3986 lta
= zmalloc(sizeof(struct ust_app
));
3989 goto error_free_pipe
;
3992 lta
->event_notifier_group
.event_pipe
= event_notifier_event_source_pipe
;
3994 lta
->ppid
= msg
->ppid
;
3995 lta
->uid
= msg
->uid
;
3996 lta
->gid
= msg
->gid
;
3998 lta
->bits_per_long
= msg
->bits_per_long
;
3999 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
4000 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
4001 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
4002 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
4003 lta
->long_alignment
= msg
->long_alignment
;
4004 lta
->byte_order
= msg
->byte_order
;
4006 lta
->v_major
= msg
->major
;
4007 lta
->v_minor
= msg
->minor
;
4008 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4009 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4010 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4011 lta
->notify_sock
= -1;
4012 lta
->token_to_event_notifier_rule_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
4014 /* Copy name and make sure it's NULL terminated. */
4015 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
4016 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
4019 * Before this can be called, when receiving the registration information,
4020 * the application compatibility is checked. So, at this point, the
4021 * application can work with this session daemon.
4023 lta
->compatible
= 1;
4025 lta
->pid
= msg
->pid
;
4026 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
4028 pthread_mutex_init(<a
->sock_lock
, NULL
);
4029 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
4031 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
4035 lttng_pipe_destroy(event_notifier_event_source_pipe
);
4036 lttng_fd_put(LTTNG_FD_APPS
, 2);
4042 * For a given application object, add it to every hash table.
4044 void ust_app_add(struct ust_app
*app
)
4047 assert(app
->notify_sock
>= 0);
4049 app
->registration_time
= time(NULL
);
4054 * Accept duplicate pid to accommodate the possibility of multiple
4055 * lttng-ust per process. Both lttng-ust instance will register
4056 * themselves and be unique in term of socket.
4057 * All operations on pid should expects that multiple "app" be present
4058 * with the same pid.
4060 lttng_ht_add_ulong(ust_app_ht
, &app
->pid_n
);
4063 * The socket _should_ be unique until _we_ call close. So, a add_unique
4064 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
4065 * already in the table.
4067 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
4069 /* Add application to the notify socket hash table. */
4070 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
4071 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
4073 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock =%d name:%s "
4074 "notify_sock =%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
4075 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
4082 * Set the application version into the object.
4084 * Return 0 on success else a negative value either an errno code or a
4085 * LTTng-UST error code.
4087 int ust_app_version(struct ust_app
*app
)
4093 pthread_mutex_lock(&app
->sock_lock
);
4094 ret
= lttng_ust_ctl_tracer_version(app
->sock
, &app
->version
);
4095 pthread_mutex_unlock(&app
->sock_lock
);
4097 if (ret
== -LTTNG_UST_ERR_EXITING
|| ret
== -EPIPE
) {
4098 DBG3("UST app version failed. Application is dead: pid = %d, sock = %d",
4099 app
->pid
, app
->sock
);
4100 } else if (ret
== -EAGAIN
) {
4101 WARN("UST app version failed. Communication time out: pid = %d, sock = %d",
4102 app
->pid
, app
->sock
);
4104 ERR("UST app version failed with ret %d: pid = %d, sock = %d",
4105 ret
, app
->pid
, app
->sock
);
4112 bool ust_app_supports_notifiers(const struct ust_app
*app
)
4114 return app
->v_major
>= 9;
4117 bool ust_app_supports_counters(const struct ust_app
*app
)
4119 return app
->v_major
>= 9;
4123 * Setup the base event notifier group.
4125 * Return 0 on success else a negative value either an errno code or a
4126 * LTTng-UST error code.
4128 int ust_app_setup_event_notifier_group(struct ust_app
*app
)
4131 int event_pipe_write_fd
;
4132 struct lttng_ust_abi_object_data
*event_notifier_group
= NULL
;
4133 enum lttng_error_code lttng_ret
;
4134 enum event_notifier_error_accounting_status event_notifier_error_accounting_status
;
4138 if (!ust_app_supports_notifiers(app
)) {
4143 /* Get the write side of the pipe. */
4144 event_pipe_write_fd
= lttng_pipe_get_writefd(
4145 app
->event_notifier_group
.event_pipe
);
4147 pthread_mutex_lock(&app
->sock_lock
);
4148 ret
= lttng_ust_ctl_create_event_notifier_group(app
->sock
,
4149 event_pipe_write_fd
, &event_notifier_group
);
4150 pthread_mutex_unlock(&app
->sock_lock
);
4152 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4154 DBG3("UST app create event notifier group failed. Application is dead: pid = %d, sock = %d",
4155 app
->pid
, app
->sock
);
4156 } else if (ret
== -EAGAIN
) {
4158 WARN("UST app create event notifier group failed. Communication time out: pid = %d, sock = %d",
4159 app
->pid
, app
->sock
);
4161 ERR("UST app create event notifier group failed with ret %d: pid = %d, sock = %d, event_pipe_write_fd: %d",
4162 ret
, app
->pid
, app
->sock
, event_pipe_write_fd
);
4167 ret
= lttng_pipe_write_close(app
->event_notifier_group
.event_pipe
);
4169 ERR("Failed to close write end of the application's event source pipe: app = '%s' (pid = %d)",
4170 app
->name
, app
->pid
);
4175 * Release the file descriptor that was reserved for the write-end of
4178 lttng_fd_put(LTTNG_FD_APPS
, 1);
4180 lttng_ret
= notification_thread_command_add_tracer_event_source(
4181 the_notification_thread_handle
,
4182 lttng_pipe_get_readfd(
4183 app
->event_notifier_group
.event_pipe
),
4185 if (lttng_ret
!= LTTNG_OK
) {
4186 ERR("Failed to add tracer event source to notification thread");
4191 /* Assign handle only when the complete setup is valid. */
4192 app
->event_notifier_group
.object
= event_notifier_group
;
4194 event_notifier_error_accounting_status
=
4195 event_notifier_error_accounting_register_app(app
);
4196 switch (event_notifier_error_accounting_status
) {
4197 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_OK
:
4199 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_UNSUPPORTED
:
4200 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",
4201 app
->sock
, app
->name
, (int) app
->pid
);
4203 goto error_accounting
;
4204 case EVENT_NOTIFIER_ERROR_ACCOUNTING_STATUS_APP_DEAD
:
4205 DBG3("Failed to setup event notifier error accounting (application is dead): app socket fd = %d, app name = '%s', app pid = %d",
4206 app
->sock
, app
->name
, (int) app
->pid
);
4208 goto error_accounting
;
4210 ERR("Failed to setup event notifier error accounting for app");
4212 goto error_accounting
;
4218 lttng_ret
= notification_thread_command_remove_tracer_event_source(
4219 the_notification_thread_handle
,
4220 lttng_pipe_get_readfd(
4221 app
->event_notifier_group
.event_pipe
));
4222 if (lttng_ret
!= LTTNG_OK
) {
4223 ERR("Failed to remove application tracer event source from notification thread");
4227 lttng_ust_ctl_release_object(app
->sock
, app
->event_notifier_group
.object
);
4228 free(app
->event_notifier_group
.object
);
4229 app
->event_notifier_group
.object
= NULL
;
4234 * Unregister app by removing it from the global traceable app list and freeing
4237 * The socket is already closed at this point so no close to sock.
4239 void ust_app_unregister(int sock
)
4241 struct ust_app
*lta
;
4242 struct lttng_ht_node_ulong
*node
;
4243 struct lttng_ht_iter ust_app_sock_iter
;
4244 struct lttng_ht_iter iter
;
4245 struct ust_app_session
*ua_sess
;
4250 /* Get the node reference for a call_rcu */
4251 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
4252 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
4255 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
4256 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
4259 * For per-PID buffers, perform "push metadata" and flush all
4260 * application streams before removing app from hash tables,
4261 * ensuring proper behavior of data_pending check.
4262 * Remove sessions so they are not visible during deletion.
4264 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
4266 struct ust_registry_session
*registry
;
4268 ret
= lttng_ht_del(lta
->sessions
, &iter
);
4270 /* The session was already removed so scheduled for teardown. */
4274 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
4275 (void) ust_app_flush_app_session(lta
, ua_sess
);
4279 * Add session to list for teardown. This is safe since at this point we
4280 * are the only one using this list.
4282 pthread_mutex_lock(&ua_sess
->lock
);
4284 if (ua_sess
->deleted
) {
4285 pthread_mutex_unlock(&ua_sess
->lock
);
4290 * Normally, this is done in the delete session process which is
4291 * executed in the call rcu below. However, upon registration we can't
4292 * afford to wait for the grace period before pushing data or else the
4293 * data pending feature can race between the unregistration and stop
4294 * command where the data pending command is sent *before* the grace
4297 * The close metadata below nullifies the metadata pointer in the
4298 * session so the delete session will NOT push/close a second time.
4300 registry
= get_session_registry(ua_sess
);
4302 /* Push metadata for application before freeing the application. */
4303 (void) push_metadata(registry
, ua_sess
->consumer
);
4306 * Don't ask to close metadata for global per UID buffers. Close
4307 * metadata only on destroy trace session in this case. Also, the
4308 * previous push metadata could have flag the metadata registry to
4309 * close so don't send a close command if closed.
4311 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
4312 /* And ask to close it for this session registry. */
4313 (void) close_metadata(registry
, ua_sess
->consumer
);
4316 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
4318 pthread_mutex_unlock(&ua_sess
->lock
);
4321 /* Remove application from PID hash table */
4322 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
4326 * Remove application from notify hash table. The thread handling the
4327 * notify socket could have deleted the node so ignore on error because
4328 * either way it's valid. The close of that socket is handled by the
4329 * apps_notify_thread.
4331 iter
.iter
.node
= <a
->notify_sock_n
.node
;
4332 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4334 iter
.iter
.node
= <a
->pid_n
.node
;
4335 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4339 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
4346 * Fill events array with all events name of all registered apps.
4348 int ust_app_list_events(struct lttng_event
**events
)
4351 size_t nbmem
, count
= 0;
4352 struct lttng_ht_iter iter
;
4353 struct ust_app
*app
;
4354 struct lttng_event
*tmp_event
;
4356 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4357 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
4358 if (tmp_event
== NULL
) {
4359 PERROR("zmalloc ust app events");
4366 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4367 struct lttng_ust_abi_tracepoint_iter uiter
;
4369 health_code_update();
4371 if (!app
->compatible
) {
4373 * TODO: In time, we should notice the caller of this error by
4374 * telling him that this is a version error.
4378 pthread_mutex_lock(&app
->sock_lock
);
4379 handle
= lttng_ust_ctl_tracepoint_list(app
->sock
);
4381 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4382 ERR("UST app list events getting handle failed for app pid %d",
4385 pthread_mutex_unlock(&app
->sock_lock
);
4389 while ((ret
= lttng_ust_ctl_tracepoint_list_get(app
->sock
, handle
,
4390 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4391 /* Handle ustctl error. */
4395 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4396 ERR("UST app tp list get failed for app %d with ret %d",
4399 DBG3("UST app tp list get failed. Application is dead");
4403 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4404 if (release_ret
< 0 &&
4405 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4406 release_ret
!= -EPIPE
) {
4407 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4409 pthread_mutex_unlock(&app
->sock_lock
);
4413 health_code_update();
4414 if (count
>= nbmem
) {
4415 /* In case the realloc fails, we free the memory */
4416 struct lttng_event
*new_tmp_event
;
4419 new_nbmem
= nbmem
<< 1;
4420 DBG2("Reallocating event list from %zu to %zu entries",
4422 new_tmp_event
= realloc(tmp_event
,
4423 new_nbmem
* sizeof(struct lttng_event
));
4424 if (new_tmp_event
== NULL
) {
4427 PERROR("realloc ust app events");
4430 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4431 if (release_ret
< 0 &&
4432 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4433 release_ret
!= -EPIPE
) {
4434 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4436 pthread_mutex_unlock(&app
->sock_lock
);
4439 /* Zero the new memory */
4440 memset(new_tmp_event
+ nbmem
, 0,
4441 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
4443 tmp_event
= new_tmp_event
;
4445 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4446 tmp_event
[count
].loglevel
= uiter
.loglevel
;
4447 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_ABI_TRACEPOINT
;
4448 tmp_event
[count
].pid
= app
->pid
;
4449 tmp_event
[count
].enabled
= -1;
4452 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4453 pthread_mutex_unlock(&app
->sock_lock
);
4455 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
4456 DBG3("Error releasing app handle. Application died: pid = %d, sock = %d",
4457 app
->pid
, app
->sock
);
4458 } else if (ret
== -EAGAIN
) {
4459 WARN("Error releasing app handle. Communication time out: pid = %d, sock = %d",
4460 app
->pid
, app
->sock
);
4462 ERR("Error releasing app handle with ret %d: pid = %d, sock = %d",
4463 ret
, app
->pid
, app
->sock
);
4469 *events
= tmp_event
;
4471 DBG2("UST app list events done (%zu events)", count
);
4476 health_code_update();
4481 * Fill events array with all events name of all registered apps.
4483 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
4486 size_t nbmem
, count
= 0;
4487 struct lttng_ht_iter iter
;
4488 struct ust_app
*app
;
4489 struct lttng_event_field
*tmp_event
;
4491 nbmem
= UST_APP_EVENT_LIST_SIZE
;
4492 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
4493 if (tmp_event
== NULL
) {
4494 PERROR("zmalloc ust app event fields");
4501 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4502 struct lttng_ust_abi_field_iter uiter
;
4504 health_code_update();
4506 if (!app
->compatible
) {
4508 * TODO: In time, we should notice the caller of this error by
4509 * telling him that this is a version error.
4513 pthread_mutex_lock(&app
->sock_lock
);
4514 handle
= lttng_ust_ctl_tracepoint_field_list(app
->sock
);
4516 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
4517 ERR("UST app list field getting handle failed for app pid %d",
4520 pthread_mutex_unlock(&app
->sock_lock
);
4524 while ((ret
= lttng_ust_ctl_tracepoint_field_list_get(app
->sock
, handle
,
4525 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
4526 /* Handle ustctl error. */
4530 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
4531 ERR("UST app tp list field failed for app %d with ret %d",
4534 DBG3("UST app tp list field failed. Application is dead");
4538 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4539 pthread_mutex_unlock(&app
->sock_lock
);
4540 if (release_ret
< 0 &&
4541 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4542 release_ret
!= -EPIPE
) {
4543 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4548 health_code_update();
4549 if (count
>= nbmem
) {
4550 /* In case the realloc fails, we free the memory */
4551 struct lttng_event_field
*new_tmp_event
;
4554 new_nbmem
= nbmem
<< 1;
4555 DBG2("Reallocating event field list from %zu to %zu entries",
4557 new_tmp_event
= realloc(tmp_event
,
4558 new_nbmem
* sizeof(struct lttng_event_field
));
4559 if (new_tmp_event
== NULL
) {
4562 PERROR("realloc ust app event fields");
4565 release_ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4566 pthread_mutex_unlock(&app
->sock_lock
);
4568 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
4569 release_ret
!= -EPIPE
) {
4570 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
4574 /* Zero the new memory */
4575 memset(new_tmp_event
+ nbmem
, 0,
4576 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
4578 tmp_event
= new_tmp_event
;
4581 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4582 /* Mapping between these enums matches 1 to 1. */
4583 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
4584 tmp_event
[count
].nowrite
= uiter
.nowrite
;
4586 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_ABI_SYM_NAME_LEN
);
4587 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
4588 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
4589 tmp_event
[count
].event
.pid
= app
->pid
;
4590 tmp_event
[count
].event
.enabled
= -1;
4593 ret
= lttng_ust_ctl_release_handle(app
->sock
, handle
);
4594 pthread_mutex_unlock(&app
->sock_lock
);
4596 ret
!= -LTTNG_UST_ERR_EXITING
&&
4598 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
4603 *fields
= tmp_event
;
4605 DBG2("UST app list event fields done (%zu events)", count
);
4610 health_code_update();
4615 * Free and clean all traceable apps of the global list.
4617 * Should _NOT_ be called with RCU read-side lock held.
4619 void ust_app_clean_list(void)
4622 struct ust_app
*app
;
4623 struct lttng_ht_iter iter
;
4625 DBG2("UST app cleaning registered apps hash table");
4629 /* Cleanup notify socket hash table */
4630 if (ust_app_ht_by_notify_sock
) {
4631 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
4632 notify_sock_n
.node
) {
4634 * Assert that all notifiers are gone as all triggers
4635 * are unregistered prior to this clean-up.
4637 assert(lttng_ht_get_count(app
->token_to_event_notifier_rule_ht
) == 0);
4639 ust_app_notify_sock_unregister(app
->notify_sock
);
4644 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4645 ret
= lttng_ht_del(ust_app_ht
, &iter
);
4647 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4651 /* Cleanup socket hash table */
4652 if (ust_app_ht_by_sock
) {
4653 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
4655 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
4662 /* Destroy is done only when the ht is empty */
4664 ht_cleanup_push(ust_app_ht
);
4666 if (ust_app_ht_by_sock
) {
4667 ht_cleanup_push(ust_app_ht_by_sock
);
4669 if (ust_app_ht_by_notify_sock
) {
4670 ht_cleanup_push(ust_app_ht_by_notify_sock
);
4675 * Init UST app hash table.
4677 int ust_app_ht_alloc(void)
4679 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4683 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4684 if (!ust_app_ht_by_sock
) {
4687 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
4688 if (!ust_app_ht_by_notify_sock
) {
4695 * For a specific UST session, disable the channel for all registered apps.
4697 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
4698 struct ltt_ust_channel
*uchan
)
4701 struct lttng_ht_iter iter
;
4702 struct lttng_ht_node_str
*ua_chan_node
;
4703 struct ust_app
*app
;
4704 struct ust_app_session
*ua_sess
;
4705 struct ust_app_channel
*ua_chan
;
4707 assert(usess
->active
);
4708 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
4709 uchan
->name
, usess
->id
);
4713 /* For every registered applications */
4714 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4715 struct lttng_ht_iter uiter
;
4716 if (!app
->compatible
) {
4718 * TODO: In time, we should notice the caller of this error by
4719 * telling him that this is a version error.
4723 ua_sess
= lookup_session_by_app(usess
, app
);
4724 if (ua_sess
== NULL
) {
4729 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4730 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4731 /* If the session if found for the app, the channel must be there */
4732 assert(ua_chan_node
);
4734 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4735 /* The channel must not be already disabled */
4736 assert(ua_chan
->enabled
== 1);
4738 /* Disable channel onto application */
4739 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
4741 /* XXX: We might want to report this error at some point... */
4751 * For a specific UST session, enable the channel for all registered apps.
4753 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
4754 struct ltt_ust_channel
*uchan
)
4757 struct lttng_ht_iter iter
;
4758 struct ust_app
*app
;
4759 struct ust_app_session
*ua_sess
;
4761 assert(usess
->active
);
4762 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
4763 uchan
->name
, usess
->id
);
4767 /* For every registered applications */
4768 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4769 if (!app
->compatible
) {
4771 * TODO: In time, we should notice the caller of this error by
4772 * telling him that this is a version error.
4776 ua_sess
= lookup_session_by_app(usess
, app
);
4777 if (ua_sess
== NULL
) {
4781 /* Enable channel onto application */
4782 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
4784 /* XXX: We might want to report this error at some point... */
4794 * Disable an event in a channel and for a specific session.
4796 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
4797 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4800 struct lttng_ht_iter iter
, uiter
;
4801 struct lttng_ht_node_str
*ua_chan_node
;
4802 struct ust_app
*app
;
4803 struct ust_app_session
*ua_sess
;
4804 struct ust_app_channel
*ua_chan
;
4805 struct ust_app_event
*ua_event
;
4807 assert(usess
->active
);
4808 DBG("UST app disabling event %s for all apps in channel "
4809 "%s for session id %" PRIu64
,
4810 uevent
->attr
.name
, uchan
->name
, usess
->id
);
4814 /* For all registered applications */
4815 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4816 if (!app
->compatible
) {
4818 * TODO: In time, we should notice the caller of this error by
4819 * telling him that this is a version error.
4823 ua_sess
= lookup_session_by_app(usess
, app
);
4824 if (ua_sess
== NULL
) {
4829 /* Lookup channel in the ust app session */
4830 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4831 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4832 if (ua_chan_node
== NULL
) {
4833 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
4834 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
4837 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4839 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4840 uevent
->filter
, uevent
->attr
.loglevel
,
4842 if (ua_event
== NULL
) {
4843 DBG2("Event %s not found in channel %s for app pid %d."
4844 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
4848 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4850 /* XXX: Report error someday... */
4859 /* The ua_sess lock must be held by the caller. */
4861 int ust_app_channel_create(struct ltt_ust_session
*usess
,
4862 struct ust_app_session
*ua_sess
,
4863 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
4864 struct ust_app_channel
**_ua_chan
)
4867 struct ust_app_channel
*ua_chan
= NULL
;
4870 ASSERT_LOCKED(ua_sess
->lock
);
4872 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4873 sizeof(uchan
->name
))) {
4874 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
4878 struct ltt_ust_context
*uctx
= NULL
;
4881 * Create channel onto application and synchronize its
4884 ret
= ust_app_channel_allocate(ua_sess
, uchan
,
4885 LTTNG_UST_ABI_CHAN_PER_CPU
, usess
,
4891 ret
= ust_app_channel_send(app
, usess
,
4898 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
4899 ret
= create_ust_app_channel_context(ua_chan
,
4912 * The application's socket is not valid. Either a bad socket
4913 * or a timeout on it. We can't inform the caller that for a
4914 * specific app, the session failed so lets continue here.
4916 ret
= 0; /* Not an error. */
4924 if (ret
== 0 && _ua_chan
) {
4926 * Only return the application's channel on success. Note
4927 * that the channel can still be part of the application's
4928 * channel hashtable on error.
4930 *_ua_chan
= ua_chan
;
4936 * Enable event for a specific session and channel on the tracer.
4938 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4939 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4942 struct lttng_ht_iter iter
, uiter
;
4943 struct lttng_ht_node_str
*ua_chan_node
;
4944 struct ust_app
*app
;
4945 struct ust_app_session
*ua_sess
;
4946 struct ust_app_channel
*ua_chan
;
4947 struct ust_app_event
*ua_event
;
4949 assert(usess
->active
);
4950 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4951 uevent
->attr
.name
, usess
->id
);
4954 * NOTE: At this point, this function is called only if the session and
4955 * channel passed are already created for all apps. and enabled on the
4961 /* For all registered applications */
4962 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4963 if (!app
->compatible
) {
4965 * TODO: In time, we should notice the caller of this error by
4966 * telling him that this is a version error.
4970 ua_sess
= lookup_session_by_app(usess
, app
);
4972 /* The application has problem or is probably dead. */
4976 pthread_mutex_lock(&ua_sess
->lock
);
4978 if (ua_sess
->deleted
) {
4979 pthread_mutex_unlock(&ua_sess
->lock
);
4983 /* Lookup channel in the ust app session */
4984 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4985 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4987 * It is possible that the channel cannot be found is
4988 * the channel/event creation occurs concurrently with
4989 * an application exit.
4991 if (!ua_chan_node
) {
4992 pthread_mutex_unlock(&ua_sess
->lock
);
4996 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4998 /* Get event node */
4999 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5000 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5001 if (ua_event
== NULL
) {
5002 DBG3("UST app enable event %s not found for app PID %d."
5003 "Skipping app", uevent
->attr
.name
, app
->pid
);
5007 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
5009 pthread_mutex_unlock(&ua_sess
->lock
);
5013 pthread_mutex_unlock(&ua_sess
->lock
);
5022 * For a specific existing UST session and UST channel, creates the event for
5023 * all registered apps.
5025 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
5026 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
5029 struct lttng_ht_iter iter
, uiter
;
5030 struct lttng_ht_node_str
*ua_chan_node
;
5031 struct ust_app
*app
;
5032 struct ust_app_session
*ua_sess
;
5033 struct ust_app_channel
*ua_chan
;
5035 assert(usess
->active
);
5036 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
5037 uevent
->attr
.name
, usess
->id
);
5041 /* For all registered applications */
5042 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5043 if (!app
->compatible
) {
5045 * TODO: In time, we should notice the caller of this error by
5046 * telling him that this is a version error.
5050 ua_sess
= lookup_session_by_app(usess
, app
);
5052 /* The application has problem or is probably dead. */
5056 pthread_mutex_lock(&ua_sess
->lock
);
5058 if (ua_sess
->deleted
) {
5059 pthread_mutex_unlock(&ua_sess
->lock
);
5063 /* Lookup channel in the ust app session */
5064 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
5065 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
5066 /* If the channel is not found, there is a code flow error */
5067 assert(ua_chan_node
);
5069 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
5071 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5072 pthread_mutex_unlock(&ua_sess
->lock
);
5074 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
5075 /* Possible value at this point: -ENOMEM. If so, we stop! */
5078 DBG2("UST app event %s already exist on app PID %d",
5079 uevent
->attr
.name
, app
->pid
);
5089 * Start tracing for a specific UST session and app.
5091 * Called with UST app session lock held.
5095 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5098 struct ust_app_session
*ua_sess
;
5100 DBG("Starting tracing for ust app pid %d", app
->pid
);
5104 if (!app
->compatible
) {
5108 ua_sess
= lookup_session_by_app(usess
, app
);
5109 if (ua_sess
== NULL
) {
5110 /* The session is in teardown process. Ignore and continue. */
5114 pthread_mutex_lock(&ua_sess
->lock
);
5116 if (ua_sess
->deleted
) {
5117 pthread_mutex_unlock(&ua_sess
->lock
);
5121 if (ua_sess
->enabled
) {
5122 pthread_mutex_unlock(&ua_sess
->lock
);
5126 /* Upon restart, we skip the setup, already done */
5127 if (ua_sess
->started
) {
5131 health_code_update();
5134 /* This starts the UST tracing */
5135 pthread_mutex_lock(&app
->sock_lock
);
5136 ret
= lttng_ust_ctl_start_session(app
->sock
, ua_sess
->handle
);
5137 pthread_mutex_unlock(&app
->sock_lock
);
5139 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5140 DBG3("UST app start session failed. Application is dead: pid = %d, sock = %d",
5141 app
->pid
, app
->sock
);
5142 pthread_mutex_unlock(&ua_sess
->lock
);
5144 } else if (ret
== -EAGAIN
) {
5145 WARN("UST app start session failed. Communication time out: pid = %d, sock = %d",
5146 app
->pid
, app
->sock
);
5147 pthread_mutex_unlock(&ua_sess
->lock
);
5151 ERR("UST app start session failed with ret %d: pid = %d, sock = %d",
5152 ret
, app
->pid
, app
->sock
);
5157 /* Indicate that the session has been started once */
5158 ua_sess
->started
= 1;
5159 ua_sess
->enabled
= 1;
5161 pthread_mutex_unlock(&ua_sess
->lock
);
5163 health_code_update();
5165 /* Quiescent wait after starting trace */
5166 pthread_mutex_lock(&app
->sock_lock
);
5167 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5168 pthread_mutex_unlock(&app
->sock_lock
);
5170 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5171 DBG3("UST app wait quiescent failed. Application is dead: pid = %d, sock = %d",
5172 app
->pid
, app
->sock
);
5173 } else if (ret
== -EAGAIN
) {
5174 WARN("UST app wait quiescent failed. Communication time out: pid = %d, sock = %d",
5175 app
->pid
, app
->sock
);
5177 ERR("UST app wait quiescent failed with ret %d: pid %d, sock = %d",
5178 ret
, app
->pid
, app
->sock
);
5184 health_code_update();
5188 pthread_mutex_unlock(&ua_sess
->lock
);
5190 health_code_update();
5195 * Stop tracing for a specific UST session and app.
5198 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5201 struct ust_app_session
*ua_sess
;
5202 struct ust_registry_session
*registry
;
5204 DBG("Stopping tracing for ust app pid %d", app
->pid
);
5208 if (!app
->compatible
) {
5209 goto end_no_session
;
5212 ua_sess
= lookup_session_by_app(usess
, app
);
5213 if (ua_sess
== NULL
) {
5214 goto end_no_session
;
5217 pthread_mutex_lock(&ua_sess
->lock
);
5219 if (ua_sess
->deleted
) {
5220 pthread_mutex_unlock(&ua_sess
->lock
);
5221 goto end_no_session
;
5225 * If started = 0, it means that stop trace has been called for a session
5226 * that was never started. It's possible since we can have a fail start
5227 * from either the application manager thread or the command thread. Simply
5228 * indicate that this is a stop error.
5230 if (!ua_sess
->started
) {
5231 goto error_rcu_unlock
;
5234 health_code_update();
5236 /* This inhibits UST tracing */
5237 pthread_mutex_lock(&app
->sock_lock
);
5238 ret
= lttng_ust_ctl_stop_session(app
->sock
, ua_sess
->handle
);
5239 pthread_mutex_unlock(&app
->sock_lock
);
5241 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5242 DBG3("UST app stop session failed. Application is dead: pid = %d, sock = %d",
5243 app
->pid
, app
->sock
);
5245 } else if (ret
== -EAGAIN
) {
5246 WARN("UST app stop session failed. Communication time out: pid = %d, sock = %d",
5247 app
->pid
, app
->sock
);
5251 ERR("UST app stop session failed with ret %d: pid = %d, sock = %d",
5252 ret
, app
->pid
, app
->sock
);
5254 goto error_rcu_unlock
;
5257 health_code_update();
5258 ua_sess
->enabled
= 0;
5260 /* Quiescent wait after stopping trace */
5261 pthread_mutex_lock(&app
->sock_lock
);
5262 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5263 pthread_mutex_unlock(&app
->sock_lock
);
5265 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5266 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d)",
5267 app
->pid
, app
->sock
);
5268 } else if (ret
== -EAGAIN
) {
5269 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d)",
5270 app
->pid
, app
->sock
);
5272 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d)",
5273 ret
, app
->pid
, app
->sock
);
5277 health_code_update();
5279 registry
= get_session_registry(ua_sess
);
5281 /* The UST app session is held registry shall not be null. */
5284 /* Push metadata for application before freeing the application. */
5285 (void) push_metadata(registry
, ua_sess
->consumer
);
5288 pthread_mutex_unlock(&ua_sess
->lock
);
5291 health_code_update();
5295 pthread_mutex_unlock(&ua_sess
->lock
);
5297 health_code_update();
5302 int ust_app_flush_app_session(struct ust_app
*app
,
5303 struct ust_app_session
*ua_sess
)
5305 int ret
, retval
= 0;
5306 struct lttng_ht_iter iter
;
5307 struct ust_app_channel
*ua_chan
;
5308 struct consumer_socket
*socket
;
5310 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
5314 if (!app
->compatible
) {
5315 goto end_not_compatible
;
5318 pthread_mutex_lock(&ua_sess
->lock
);
5320 if (ua_sess
->deleted
) {
5324 health_code_update();
5326 /* Flushing buffers */
5327 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5330 /* Flush buffers and push metadata. */
5331 switch (ua_sess
->buffer_type
) {
5332 case LTTNG_BUFFER_PER_PID
:
5333 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
5335 health_code_update();
5336 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
5338 ERR("Error flushing consumer channel");
5344 case LTTNG_BUFFER_PER_UID
:
5350 health_code_update();
5353 pthread_mutex_unlock(&ua_sess
->lock
);
5357 health_code_update();
5362 * Flush buffers for all applications for a specific UST session.
5363 * Called with UST session lock held.
5366 int ust_app_flush_session(struct ltt_ust_session
*usess
)
5371 DBG("Flushing session buffers for all ust apps");
5375 /* Flush buffers and push metadata. */
5376 switch (usess
->buffer_type
) {
5377 case LTTNG_BUFFER_PER_UID
:
5379 struct buffer_reg_uid
*reg
;
5380 struct lttng_ht_iter iter
;
5382 /* Flush all per UID buffers associated to that session. */
5383 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5384 struct ust_registry_session
*ust_session_reg
;
5385 struct buffer_reg_channel
*buf_reg_chan
;
5386 struct consumer_socket
*socket
;
5388 /* Get consumer socket to use to push the metadata.*/
5389 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5392 /* Ignore request if no consumer is found for the session. */
5396 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5397 buf_reg_chan
, node
.node
) {
5399 * The following call will print error values so the return
5400 * code is of little importance because whatever happens, we
5401 * have to try them all.
5403 (void) consumer_flush_channel(socket
, buf_reg_chan
->consumer_key
);
5406 ust_session_reg
= reg
->registry
->reg
.ust
;
5407 /* Push metadata. */
5408 (void) push_metadata(ust_session_reg
, usess
->consumer
);
5412 case LTTNG_BUFFER_PER_PID
:
5414 struct ust_app_session
*ua_sess
;
5415 struct lttng_ht_iter iter
;
5416 struct ust_app
*app
;
5418 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5419 ua_sess
= lookup_session_by_app(usess
, app
);
5420 if (ua_sess
== NULL
) {
5423 (void) ust_app_flush_app_session(app
, ua_sess
);
5434 health_code_update();
5439 int ust_app_clear_quiescent_app_session(struct ust_app
*app
,
5440 struct ust_app_session
*ua_sess
)
5443 struct lttng_ht_iter iter
;
5444 struct ust_app_channel
*ua_chan
;
5445 struct consumer_socket
*socket
;
5447 DBG("Clearing stream quiescent state for ust app pid %d", app
->pid
);
5451 if (!app
->compatible
) {
5452 goto end_not_compatible
;
5455 pthread_mutex_lock(&ua_sess
->lock
);
5457 if (ua_sess
->deleted
) {
5461 health_code_update();
5463 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5466 ERR("Failed to find consumer (%" PRIu32
") socket",
5467 app
->bits_per_long
);
5472 /* Clear quiescent state. */
5473 switch (ua_sess
->buffer_type
) {
5474 case LTTNG_BUFFER_PER_PID
:
5475 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
,
5476 ua_chan
, node
.node
) {
5477 health_code_update();
5478 ret
= consumer_clear_quiescent_channel(socket
,
5481 ERR("Error clearing quiescent state for consumer channel");
5487 case LTTNG_BUFFER_PER_UID
:
5494 health_code_update();
5497 pthread_mutex_unlock(&ua_sess
->lock
);
5501 health_code_update();
5506 * Clear quiescent state in each stream for all applications for a
5507 * specific UST session.
5508 * Called with UST session lock held.
5511 int ust_app_clear_quiescent_session(struct ltt_ust_session
*usess
)
5516 DBG("Clearing stream quiescent state for all ust apps");
5520 switch (usess
->buffer_type
) {
5521 case LTTNG_BUFFER_PER_UID
:
5523 struct lttng_ht_iter iter
;
5524 struct buffer_reg_uid
*reg
;
5527 * Clear quiescent for all per UID buffers associated to
5530 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5531 struct consumer_socket
*socket
;
5532 struct buffer_reg_channel
*buf_reg_chan
;
5534 /* Get associated consumer socket.*/
5535 socket
= consumer_find_socket_by_bitness(
5536 reg
->bits_per_long
, usess
->consumer
);
5539 * Ignore request if no consumer is found for
5545 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
5546 &iter
.iter
, buf_reg_chan
, node
.node
) {
5548 * The following call will print error values so
5549 * the return code is of little importance
5550 * because whatever happens, we have to try them
5553 (void) consumer_clear_quiescent_channel(socket
,
5554 buf_reg_chan
->consumer_key
);
5559 case LTTNG_BUFFER_PER_PID
:
5561 struct ust_app_session
*ua_sess
;
5562 struct lttng_ht_iter iter
;
5563 struct ust_app
*app
;
5565 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
5567 ua_sess
= lookup_session_by_app(usess
, app
);
5568 if (ua_sess
== NULL
) {
5571 (void) ust_app_clear_quiescent_app_session(app
,
5583 health_code_update();
5588 * Destroy a specific UST session in apps.
5590 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
5593 struct ust_app_session
*ua_sess
;
5594 struct lttng_ht_iter iter
;
5595 struct lttng_ht_node_u64
*node
;
5597 DBG("Destroy tracing for ust app pid %d", app
->pid
);
5601 if (!app
->compatible
) {
5605 __lookup_session_by_app(usess
, app
, &iter
);
5606 node
= lttng_ht_iter_get_node_u64(&iter
);
5608 /* Session is being or is deleted. */
5611 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
5613 health_code_update();
5614 destroy_app_session(app
, ua_sess
);
5616 health_code_update();
5618 /* Quiescent wait after stopping trace */
5619 pthread_mutex_lock(&app
->sock_lock
);
5620 ret
= lttng_ust_ctl_wait_quiescent(app
->sock
);
5621 pthread_mutex_unlock(&app
->sock_lock
);
5623 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
5624 DBG3("UST app wait quiescent failed. Application is dead: pid= %d, sock = %d)",
5625 app
->pid
, app
->sock
);
5626 } else if (ret
== -EAGAIN
) {
5627 WARN("UST app wait quiescent failed. Communication time out: pid= %d, sock = %d)",
5628 app
->pid
, app
->sock
);
5630 ERR("UST app wait quiescent failed with ret %d: pid= %d, sock = %d)",
5631 ret
, app
->pid
, app
->sock
);
5636 health_code_update();
5641 * Start tracing for the UST session.
5643 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
5645 struct lttng_ht_iter iter
;
5646 struct ust_app
*app
;
5648 DBG("Starting all UST traces");
5651 * Even though the start trace might fail, flag this session active so
5652 * other application coming in are started by default.
5659 * In a start-stop-start use-case, we need to clear the quiescent state
5660 * of each channel set by the prior stop command, thus ensuring that a
5661 * following stop or destroy is sure to grab a timestamp_end near those
5662 * operations, even if the packet is empty.
5664 (void) ust_app_clear_quiescent_session(usess
);
5666 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5667 ust_app_global_update(usess
, app
);
5676 * Start tracing for the UST session.
5677 * Called with UST session lock held.
5679 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
5682 struct lttng_ht_iter iter
;
5683 struct ust_app
*app
;
5685 DBG("Stopping all UST traces");
5688 * Even though the stop trace might fail, flag this session inactive so
5689 * other application coming in are not started by default.
5695 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5696 ret
= ust_app_stop_trace(usess
, app
);
5698 /* Continue to next apps even on error */
5703 (void) ust_app_flush_session(usess
);
5711 * Destroy app UST session.
5713 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
5716 struct lttng_ht_iter iter
;
5717 struct ust_app
*app
;
5719 DBG("Destroy all UST traces");
5723 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5724 ret
= destroy_trace(usess
, app
);
5726 /* Continue to next apps even on error */
5736 /* The ua_sess lock must be held by the caller. */
5738 int find_or_create_ust_app_channel(
5739 struct ltt_ust_session
*usess
,
5740 struct ust_app_session
*ua_sess
,
5741 struct ust_app
*app
,
5742 struct ltt_ust_channel
*uchan
,
5743 struct ust_app_channel
**ua_chan
)
5746 struct lttng_ht_iter iter
;
5747 struct lttng_ht_node_str
*ua_chan_node
;
5749 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &iter
);
5750 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
5752 *ua_chan
= caa_container_of(ua_chan_node
,
5753 struct ust_app_channel
, node
);
5757 ret
= ust_app_channel_create(usess
, ua_sess
, uchan
, app
, ua_chan
);
5766 int ust_app_channel_synchronize_event(struct ust_app_channel
*ua_chan
,
5767 struct ltt_ust_event
*uevent
, struct ust_app_session
*ua_sess
,
5768 struct ust_app
*app
)
5771 struct ust_app_event
*ua_event
= NULL
;
5773 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
5774 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
5776 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
5781 if (ua_event
->enabled
!= uevent
->enabled
) {
5782 ret
= uevent
->enabled
?
5783 enable_ust_app_event(ua_sess
, ua_event
, app
) :
5784 disable_ust_app_event(ua_sess
, ua_event
, app
);
5792 /* Called with RCU read-side lock held. */
5794 void ust_app_synchronize_event_notifier_rules(struct ust_app
*app
)
5797 enum lttng_error_code ret_code
;
5798 enum lttng_trigger_status t_status
;
5799 struct lttng_ht_iter app_trigger_iter
;
5800 struct lttng_triggers
*triggers
= NULL
;
5801 struct ust_app_event_notifier_rule
*event_notifier_rule
;
5802 unsigned int count
, i
;
5804 if (!ust_app_supports_notifiers(app
)) {
5809 * Currrently, registering or unregistering a trigger with an
5810 * event rule condition causes a full synchronization of the event
5813 * The first step attempts to add an event notifier for all registered
5814 * triggers that apply to the user space tracers. Then, the
5815 * application's event notifiers rules are all checked against the list
5816 * of registered triggers. Any event notifier that doesn't have a
5817 * matching trigger can be assumed to have been disabled.
5819 * All of this is inefficient, but is put in place to get the feature
5820 * rolling as it is simpler at this moment. It will be optimized Soon™
5821 * to allow the state of enabled
5822 * event notifiers to be synchronized in a piece-wise way.
5825 /* Get all triggers using uid 0 (root) */
5826 ret_code
= notification_thread_command_list_triggers(
5827 the_notification_thread_handle
, 0, &triggers
);
5828 if (ret_code
!= LTTNG_OK
) {
5834 t_status
= lttng_triggers_get_count(triggers
, &count
);
5835 if (t_status
!= LTTNG_TRIGGER_STATUS_OK
) {
5839 for (i
= 0; i
< count
; i
++) {
5840 struct lttng_condition
*condition
;
5841 struct lttng_event_rule
*event_rule
;
5842 struct lttng_trigger
*trigger
;
5843 const struct ust_app_event_notifier_rule
*looked_up_event_notifier_rule
;
5844 enum lttng_condition_status condition_status
;
5847 trigger
= lttng_triggers_borrow_mutable_at_index(triggers
, i
);
5850 token
= lttng_trigger_get_tracer_token(trigger
);
5851 condition
= lttng_trigger_get_condition(trigger
);
5853 if (lttng_condition_get_type(condition
) !=
5854 LTTNG_CONDITION_TYPE_EVENT_RULE_MATCHES
) {
5855 /* Does not apply */
5860 lttng_condition_event_rule_matches_borrow_rule_mutable(
5861 condition
, &event_rule
);
5862 assert(condition_status
== LTTNG_CONDITION_STATUS_OK
);
5864 if (lttng_event_rule_get_domain_type(event_rule
) == LTTNG_DOMAIN_KERNEL
) {
5865 /* Skip kernel related triggers. */
5870 * Find or create the associated token event rule. The caller
5871 * holds the RCU read lock, so this is safe to call without
5872 * explicitly acquiring it here.
5874 looked_up_event_notifier_rule
= find_ust_app_event_notifier_rule(
5875 app
->token_to_event_notifier_rule_ht
, token
);
5876 if (!looked_up_event_notifier_rule
) {
5877 ret
= create_ust_app_event_notifier_rule(trigger
, app
);
5885 /* Remove all unknown event sources from the app. */
5886 cds_lfht_for_each_entry (app
->token_to_event_notifier_rule_ht
->ht
,
5887 &app_trigger_iter
.iter
, event_notifier_rule
,
5889 const uint64_t app_token
= event_notifier_rule
->token
;
5893 * Check if the app event trigger still exists on the
5894 * notification side.
5896 for (i
= 0; i
< count
; i
++) {
5897 uint64_t notification_thread_token
;
5898 const struct lttng_trigger
*trigger
=
5899 lttng_triggers_get_at_index(
5904 notification_thread_token
=
5905 lttng_trigger_get_tracer_token(trigger
);
5907 if (notification_thread_token
== app_token
) {
5919 * This trigger was unregistered, disable it on the tracer's
5922 ret
= lttng_ht_del(app
->token_to_event_notifier_rule_ht
,
5926 /* Callee logs errors. */
5927 (void) disable_ust_object(app
, event_notifier_rule
->obj
);
5929 delete_ust_app_event_notifier_rule(
5930 app
->sock
, event_notifier_rule
, app
);
5936 lttng_triggers_destroy(triggers
);
5941 * RCU read lock must be held by the caller.
5944 void ust_app_synchronize_all_channels(struct ltt_ust_session
*usess
,
5945 struct ust_app_session
*ua_sess
,
5946 struct ust_app
*app
)
5949 struct cds_lfht_iter uchan_iter
;
5950 struct ltt_ust_channel
*uchan
;
5956 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &uchan_iter
,
5958 struct ust_app_channel
*ua_chan
;
5959 struct cds_lfht_iter uevent_iter
;
5960 struct ltt_ust_event
*uevent
;
5963 * Search for a matching ust_app_channel. If none is found,
5964 * create it. Creating the channel will cause the ua_chan
5965 * structure to be allocated, the channel buffers to be
5966 * allocated (if necessary) and sent to the application, and
5967 * all enabled contexts will be added to the channel.
5969 ret
= find_or_create_ust_app_channel(usess
, ua_sess
,
5970 app
, uchan
, &ua_chan
);
5972 /* Tracer is probably gone or ENOMEM. */
5977 /* ua_chan will be NULL for the metadata channel */
5981 cds_lfht_for_each_entry(uchan
->events
->ht
, &uevent_iter
, uevent
,
5983 ret
= ust_app_channel_synchronize_event(ua_chan
,
5984 uevent
, ua_sess
, app
);
5990 if (ua_chan
->enabled
!= uchan
->enabled
) {
5991 ret
= uchan
->enabled
?
5992 enable_ust_app_channel(ua_sess
, uchan
, app
) :
5993 disable_ust_app_channel(ua_sess
, ua_chan
, app
);
6004 * The caller must ensure that the application is compatible and is tracked
6005 * by the process attribute trackers.
6008 void ust_app_synchronize(struct ltt_ust_session
*usess
,
6009 struct ust_app
*app
)
6012 struct ust_app_session
*ua_sess
= NULL
;
6015 * The application's configuration should only be synchronized for
6018 assert(usess
->active
);
6020 ret
= find_or_create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
6022 /* Tracer is probably gone or ENOMEM. */
6024 destroy_app_session(app
, ua_sess
);
6030 pthread_mutex_lock(&ua_sess
->lock
);
6031 if (ua_sess
->deleted
) {
6032 goto deleted_session
;
6037 ust_app_synchronize_all_channels(usess
, ua_sess
, app
);
6040 * Create the metadata for the application. This returns gracefully if a
6041 * metadata was already set for the session.
6043 * The metadata channel must be created after the data channels as the
6044 * consumer daemon assumes this ordering. When interacting with a relay
6045 * daemon, the consumer will use this assumption to send the
6046 * "STREAMS_SENT" message to the relay daemon.
6048 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
6050 ERR("Metadata creation failed for app sock %d for session id %" PRIu64
,
6051 app
->sock
, usess
->id
);
6057 pthread_mutex_unlock(&ua_sess
->lock
);
6063 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6065 struct ust_app_session
*ua_sess
;
6067 ua_sess
= lookup_session_by_app(usess
, app
);
6068 if (ua_sess
== NULL
) {
6071 destroy_app_session(app
, ua_sess
);
6075 * Add channels/events from UST global domain to registered apps at sock.
6077 * Called with session lock held.
6078 * Called with RCU read-side lock held.
6080 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
6083 assert(usess
->active
);
6085 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
6086 app
->sock
, usess
->id
);
6088 if (!app
->compatible
) {
6091 if (trace_ust_id_tracker_lookup(LTTNG_PROCESS_ATTR_VIRTUAL_PROCESS_ID
,
6093 trace_ust_id_tracker_lookup(
6094 LTTNG_PROCESS_ATTR_VIRTUAL_USER_ID
,
6096 trace_ust_id_tracker_lookup(
6097 LTTNG_PROCESS_ATTR_VIRTUAL_GROUP_ID
,
6100 * Synchronize the application's internal tracing configuration
6101 * and start tracing.
6103 ust_app_synchronize(usess
, app
);
6104 ust_app_start_trace(usess
, app
);
6106 ust_app_global_destroy(usess
, app
);
6111 * Add all event notifiers to an application.
6113 * Called with session lock held.
6114 * Called with RCU read-side lock held.
6116 void ust_app_global_update_event_notifier_rules(struct ust_app
*app
)
6118 DBG2("UST application global event notifier rules update: app = '%s', pid = %d)",
6119 app
->name
, app
->pid
);
6121 if (!app
->compatible
|| !ust_app_supports_notifiers(app
)) {
6125 if (app
->event_notifier_group
.object
== NULL
) {
6126 WARN("UST app global update of event notifiers for app skipped since communication handle is null: app = '%s' pid = %d)",
6127 app
->name
, app
->pid
);
6131 ust_app_synchronize_event_notifier_rules(app
);
6135 * Called with session lock held.
6137 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
6139 struct lttng_ht_iter iter
;
6140 struct ust_app
*app
;
6143 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6144 ust_app_global_update(usess
, app
);
6149 void ust_app_global_update_all_event_notifier_rules(void)
6151 struct lttng_ht_iter iter
;
6152 struct ust_app
*app
;
6155 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6156 ust_app_global_update_event_notifier_rules(app
);
6163 * Add context to a specific channel for global UST domain.
6165 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
6166 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
6169 struct lttng_ht_node_str
*ua_chan_node
;
6170 struct lttng_ht_iter iter
, uiter
;
6171 struct ust_app_channel
*ua_chan
= NULL
;
6172 struct ust_app_session
*ua_sess
;
6173 struct ust_app
*app
;
6175 assert(usess
->active
);
6178 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
6179 if (!app
->compatible
) {
6181 * TODO: In time, we should notice the caller of this error by
6182 * telling him that this is a version error.
6186 ua_sess
= lookup_session_by_app(usess
, app
);
6187 if (ua_sess
== NULL
) {
6191 pthread_mutex_lock(&ua_sess
->lock
);
6193 if (ua_sess
->deleted
) {
6194 pthread_mutex_unlock(&ua_sess
->lock
);
6198 /* Lookup channel in the ust app session */
6199 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
6200 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
6201 if (ua_chan_node
== NULL
) {
6204 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
6206 ret
= create_ust_app_channel_context(ua_chan
, &uctx
->ctx
, app
);
6211 pthread_mutex_unlock(&ua_sess
->lock
);
6219 * Receive registration and populate the given msg structure.
6221 * On success return 0 else a negative value returned by the ustctl call.
6223 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
6226 uint32_t pid
, ppid
, uid
, gid
;
6230 ret
= lttng_ust_ctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
6231 &pid
, &ppid
, &uid
, &gid
,
6232 &msg
->bits_per_long
,
6233 &msg
->uint8_t_alignment
,
6234 &msg
->uint16_t_alignment
,
6235 &msg
->uint32_t_alignment
,
6236 &msg
->uint64_t_alignment
,
6237 &msg
->long_alignment
,
6244 case LTTNG_UST_ERR_EXITING
:
6245 DBG3("UST app recv reg message failed. Application died");
6247 case LTTNG_UST_ERR_UNSUP_MAJOR
:
6248 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
6249 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
6250 LTTNG_UST_ABI_MINOR_VERSION
);
6253 ERR("UST app recv reg message failed with ret %d", ret
);
6258 msg
->pid
= (pid_t
) pid
;
6259 msg
->ppid
= (pid_t
) ppid
;
6260 msg
->uid
= (uid_t
) uid
;
6261 msg
->gid
= (gid_t
) gid
;
6268 * Return a ust app session object using the application object and the
6269 * session object descriptor has a key. If not found, NULL is returned.
6270 * A RCU read side lock MUST be acquired when calling this function.
6272 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
6275 struct lttng_ht_node_ulong
*node
;
6276 struct lttng_ht_iter iter
;
6277 struct ust_app_session
*ua_sess
= NULL
;
6281 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
6282 node
= lttng_ht_iter_get_node_ulong(&iter
);
6284 DBG2("UST app session find by objd %d not found", objd
);
6288 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
6295 * Return a ust app channel object using the application object and the channel
6296 * object descriptor has a key. If not found, NULL is returned. A RCU read side
6297 * lock MUST be acquired before calling this function.
6299 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
6302 struct lttng_ht_node_ulong
*node
;
6303 struct lttng_ht_iter iter
;
6304 struct ust_app_channel
*ua_chan
= NULL
;
6308 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
6309 node
= lttng_ht_iter_get_node_ulong(&iter
);
6311 DBG2("UST app channel find by objd %d not found", objd
);
6315 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
6322 * Fixup legacy context fields for comparison:
6323 * - legacy array becomes array_nestable,
6324 * - legacy struct becomes struct_nestable,
6325 * - legacy variant becomes variant_nestable,
6326 * legacy sequences are not emitted in LTTng-UST contexts.
6328 static int ust_app_fixup_legacy_context_fields(size_t *_nr_fields
,
6329 struct lttng_ust_ctl_field
**_fields
)
6331 struct lttng_ust_ctl_field
*fields
= *_fields
, *new_fields
= NULL
;
6332 size_t nr_fields
= *_nr_fields
, new_nr_fields
= 0, i
, j
;
6336 for (i
= 0; i
< nr_fields
; i
++) {
6337 const struct lttng_ust_ctl_field
*field
= &fields
[i
];
6339 switch (field
->type
.atype
) {
6340 case lttng_ust_ctl_atype_sequence
:
6341 ERR("Unexpected legacy sequence context.");
6344 case lttng_ust_ctl_atype_array
:
6345 switch (field
->type
.u
.legacy
.array
.elem_type
.atype
) {
6346 case lttng_ust_ctl_atype_integer
:
6349 ERR("Unexpected legacy array element type in context.");
6354 /* One field for array_nested, one field for elem type. */
6358 case lttng_ust_ctl_atype_struct
: /* Fallthrough */
6359 case lttng_ust_ctl_atype_variant
:
6371 new_fields
= (struct lttng_ust_ctl_field
*) zmalloc(sizeof(*new_fields
) * new_nr_fields
);
6376 for (i
= 0, j
= 0; i
< nr_fields
; i
++, j
++) {
6377 const struct lttng_ust_ctl_field
*field
= &fields
[i
];
6378 struct lttng_ust_ctl_field
*new_field
= &new_fields
[j
];
6380 switch (field
->type
.atype
) {
6381 case lttng_ust_ctl_atype_array
:
6382 /* One field for array_nested, one field for elem type. */
6383 strncpy(new_field
->name
, field
->name
, LTTNG_UST_ABI_SYM_NAME_LEN
- 1);
6384 new_field
->type
.atype
= lttng_ust_ctl_atype_array_nestable
;
6385 new_field
->type
.u
.array_nestable
.length
= field
->type
.u
.legacy
.array
.length
;
6386 new_field
->type
.u
.array_nestable
.alignment
= 0;
6387 new_field
= &new_fields
[++j
]; /* elem type */
6388 new_field
->type
.atype
= field
->type
.u
.legacy
.array
.elem_type
.atype
;
6389 assert(new_field
->type
.atype
== lttng_ust_ctl_atype_integer
);
6390 new_field
->type
.u
.integer
= field
->type
.u
.legacy
.array
.elem_type
.u
.basic
.integer
;
6392 case lttng_ust_ctl_atype_struct
:
6393 strncpy(new_field
->name
, field
->name
, LTTNG_UST_ABI_SYM_NAME_LEN
- 1);
6394 new_field
->type
.atype
= lttng_ust_ctl_atype_struct_nestable
;
6395 new_field
->type
.u
.struct_nestable
.nr_fields
= field
->type
.u
.legacy
._struct
.nr_fields
;
6396 new_field
->type
.u
.struct_nestable
.alignment
= 0;
6398 case lttng_ust_ctl_atype_variant
:
6399 strncpy(new_field
->name
, field
->name
, LTTNG_UST_ABI_SYM_NAME_LEN
- 1);
6400 new_field
->type
.atype
= lttng_ust_ctl_atype_variant_nestable
;
6401 new_field
->type
.u
.variant_nestable
.nr_choices
= field
->type
.u
.legacy
.variant
.nr_choices
;
6402 strncpy(new_field
->type
.u
.variant_nestable
.tag_name
,
6403 field
->type
.u
.legacy
.variant
.tag_name
,
6404 LTTNG_UST_ABI_SYM_NAME_LEN
- 1);
6405 new_field
->type
.u
.variant_nestable
.alignment
= 0;
6408 *new_field
= *field
;
6413 *_fields
= new_fields
;
6414 *_nr_fields
= new_nr_fields
;
6420 * Reply to a register channel notification from an application on the notify
6421 * socket. The channel metadata is also created.
6423 * The session UST registry lock is acquired in this function.
6425 * On success 0 is returned else a negative value.
6427 static int reply_ust_register_channel(int sock
, int cobjd
,
6428 size_t nr_fields
, struct lttng_ust_ctl_field
*fields
)
6430 int ret
, ret_code
= 0;
6432 uint64_t chan_reg_key
;
6433 enum lttng_ust_ctl_channel_header type
= LTTNG_UST_CTL_CHANNEL_HEADER_UNKNOWN
;
6434 struct ust_app
*app
;
6435 struct ust_app_channel
*ua_chan
;
6436 struct ust_app_session
*ua_sess
;
6437 struct ust_registry_session
*registry
;
6438 struct ust_registry_channel
*ust_reg_chan
;
6442 /* Lookup application. If not found, there is a code flow error. */
6443 app
= find_app_by_notify_sock(sock
);
6445 DBG("Application socket %d is being torn down. Abort event notify",
6448 goto error_rcu_unlock
;
6451 /* Lookup channel by UST object descriptor. */
6452 ua_chan
= find_channel_by_objd(app
, cobjd
);
6454 DBG("Application channel is being torn down. Abort event notify");
6456 goto error_rcu_unlock
;
6459 assert(ua_chan
->session
);
6460 ua_sess
= ua_chan
->session
;
6462 /* Get right session registry depending on the session buffer type. */
6463 registry
= get_session_registry(ua_sess
);
6465 DBG("Application session is being torn down. Abort event notify");
6467 goto error_rcu_unlock
;
6470 /* Depending on the buffer type, a different channel key is used. */
6471 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6472 chan_reg_key
= ua_chan
->tracing_channel_id
;
6474 chan_reg_key
= ua_chan
->key
;
6477 pthread_mutex_lock(®istry
->lock
);
6479 ust_reg_chan
= ust_registry_channel_find(registry
, chan_reg_key
);
6480 assert(ust_reg_chan
);
6482 /* Channel id is set during the object creation. */
6483 chan_id
= ust_reg_chan
->chan_id
;
6485 ret
= ust_app_fixup_legacy_context_fields(&nr_fields
, &fields
);
6487 ERR("Registering application channel due to legacy context fields fixup error: pid = %d, sock = %d",
6488 app
->pid
, app
->sock
);
6492 if (!ust_reg_chan
->register_done
) {
6494 * TODO: eventually use the registry event count for
6495 * this channel to better guess header type for per-pid
6498 type
= LTTNG_UST_CTL_CHANNEL_HEADER_LARGE
;
6499 ust_reg_chan
->nr_ctx_fields
= nr_fields
;
6500 ust_reg_chan
->ctx_fields
= fields
;
6502 ust_reg_chan
->header_type
= type
;
6504 /* Get current already assigned values. */
6505 type
= ust_reg_chan
->header_type
;
6507 * Validate that the context fields match between
6508 * registry and newcoming application.
6510 if (!match_lttng_ust_ctl_field_array(ust_reg_chan
->ctx_fields
,
6511 ust_reg_chan
->nr_ctx_fields
,
6512 fields
, nr_fields
)) {
6513 ERR("Registering application channel due to context field mismatch: pid = %d, sock = %d",
6514 app
->pid
, app
->sock
);
6520 /* Append to metadata */
6521 if (!ust_reg_chan
->metadata_dumped
) {
6522 ret_code
= ust_metadata_channel_statedump(registry
, ust_reg_chan
);
6524 ERR("Error appending channel metadata (errno = %d)", ret_code
);
6530 DBG3("UST app replying to register channel key %" PRIu64
6531 " with id %u, type = %d, ret = %d", chan_reg_key
, chan_id
, type
,
6534 ret
= lttng_ust_ctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
6536 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6537 DBG3("UST app reply channel failed. Application died: pid = %d, sock = %d",
6538 app
->pid
, app
->sock
);
6539 } else if (ret
== -EAGAIN
) {
6540 WARN("UST app reply channel failed. Communication time out: pid = %d, sock = %d",
6541 app
->pid
, app
->sock
);
6543 ERR("UST app reply channel failed with ret %d: pid = %d, sock = %d",
6544 ret
, app
->pid
, app
->sock
);
6549 /* This channel registry registration is completed. */
6550 ust_reg_chan
->register_done
= 1;
6553 pthread_mutex_unlock(®istry
->lock
);
6561 * Add event to the UST channel registry. When the event is added to the
6562 * registry, the metadata is also created. Once done, this replies to the
6563 * application with the appropriate error code.
6565 * The session UST registry lock is acquired in the function.
6567 * On success 0 is returned else a negative value.
6569 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
6570 char *sig
, size_t nr_fields
, struct lttng_ust_ctl_field
*fields
,
6571 int loglevel_value
, char *model_emf_uri
)
6574 uint32_t event_id
= 0;
6575 uint64_t chan_reg_key
;
6576 struct ust_app
*app
;
6577 struct ust_app_channel
*ua_chan
;
6578 struct ust_app_session
*ua_sess
;
6579 struct ust_registry_session
*registry
;
6583 /* Lookup application. If not found, there is a code flow error. */
6584 app
= find_app_by_notify_sock(sock
);
6586 DBG("Application socket %d is being torn down. Abort event notify",
6589 goto error_rcu_unlock
;
6592 /* Lookup channel by UST object descriptor. */
6593 ua_chan
= find_channel_by_objd(app
, cobjd
);
6595 DBG("Application channel is being torn down. Abort event notify");
6597 goto error_rcu_unlock
;
6600 assert(ua_chan
->session
);
6601 ua_sess
= ua_chan
->session
;
6603 registry
= get_session_registry(ua_sess
);
6605 DBG("Application session is being torn down. Abort event notify");
6607 goto error_rcu_unlock
;
6610 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
6611 chan_reg_key
= ua_chan
->tracing_channel_id
;
6613 chan_reg_key
= ua_chan
->key
;
6616 pthread_mutex_lock(®istry
->lock
);
6619 * From this point on, this call acquires the ownership of the sig, fields
6620 * and model_emf_uri meaning any free are done inside it if needed. These
6621 * three variables MUST NOT be read/write after this.
6623 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
6624 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
6625 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
6629 model_emf_uri
= NULL
;
6632 * The return value is returned to ustctl so in case of an error, the
6633 * application can be notified. In case of an error, it's important not to
6634 * return a negative error or else the application will get closed.
6636 ret
= lttng_ust_ctl_reply_register_event(sock
, event_id
, ret_code
);
6638 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6639 DBG3("UST app reply event failed. Application died: pid = %d, sock = %d.",
6640 app
->pid
, app
->sock
);
6641 } else if (ret
== -EAGAIN
) {
6642 WARN("UST app reply event failed. Communication time out: pid = %d, sock = %d",
6643 app
->pid
, app
->sock
);
6645 ERR("UST app reply event failed with ret %d: pid = %d, sock = %d",
6646 ret
, app
->pid
, app
->sock
);
6649 * No need to wipe the create event since the application socket will
6650 * get close on error hence cleaning up everything by itself.
6655 DBG3("UST registry event %s with id %" PRId32
" added successfully",
6659 pthread_mutex_unlock(®istry
->lock
);
6664 free(model_emf_uri
);
6669 * Add enum to the UST session registry. Once done, this replies to the
6670 * application with the appropriate error code.
6672 * The session UST registry lock is acquired within this function.
6674 * On success 0 is returned else a negative value.
6676 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
6677 struct lttng_ust_ctl_enum_entry
*entries
, size_t nr_entries
)
6679 int ret
= 0, ret_code
;
6680 struct ust_app
*app
;
6681 struct ust_app_session
*ua_sess
;
6682 struct ust_registry_session
*registry
;
6683 uint64_t enum_id
= -1ULL;
6687 /* Lookup application. If not found, there is a code flow error. */
6688 app
= find_app_by_notify_sock(sock
);
6690 /* Return an error since this is not an error */
6691 DBG("Application socket %d is being torn down. Aborting enum registration",
6695 goto error_rcu_unlock
;
6698 /* Lookup session by UST object descriptor. */
6699 ua_sess
= find_session_by_objd(app
, sobjd
);
6701 /* Return an error since this is not an error */
6702 DBG("Application session is being torn down (session not found). Aborting enum registration.");
6704 goto error_rcu_unlock
;
6707 registry
= get_session_registry(ua_sess
);
6709 DBG("Application session is being torn down (registry not found). Aborting enum registration.");
6711 goto error_rcu_unlock
;
6714 pthread_mutex_lock(®istry
->lock
);
6717 * From this point on, the callee acquires the ownership of
6718 * entries. The variable entries MUST NOT be read/written after
6721 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
6722 entries
, nr_entries
, &enum_id
);
6726 * The return value is returned to ustctl so in case of an error, the
6727 * application can be notified. In case of an error, it's important not to
6728 * return a negative error or else the application will get closed.
6730 ret
= lttng_ust_ctl_reply_register_enum(sock
, enum_id
, ret_code
);
6732 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6733 DBG3("UST app reply enum failed. Application died: pid = %d, sock = %d",
6734 app
->pid
, app
->sock
);
6735 } else if (ret
== -EAGAIN
) {
6736 WARN("UST app reply enum failed. Communication time out: pid = %d, sock = %d",
6737 app
->pid
, app
->sock
);
6739 ERR("UST app reply enum failed with ret %d: pid = %d, sock = %d",
6740 ret
, app
->pid
, app
->sock
);
6743 * No need to wipe the create enum since the application socket will
6744 * get close on error hence cleaning up everything by itself.
6749 DBG3("UST registry enum %s added successfully or already found", name
);
6752 pthread_mutex_unlock(®istry
->lock
);
6759 * Handle application notification through the given notify socket.
6761 * Return 0 on success or else a negative value.
6763 int ust_app_recv_notify(int sock
)
6766 enum lttng_ust_ctl_notify_cmd cmd
;
6768 DBG3("UST app receiving notify from sock %d", sock
);
6770 ret
= lttng_ust_ctl_recv_notify(sock
, &cmd
);
6772 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6773 DBG3("UST app recv notify failed. Application died: sock = %d",
6775 } else if (ret
== -EAGAIN
) {
6776 WARN("UST app recv notify failed. Communication time out: sock = %d",
6779 ERR("UST app recv notify failed with ret %d: sock = %d",
6786 case LTTNG_UST_CTL_NOTIFY_CMD_EVENT
:
6788 int sobjd
, cobjd
, loglevel_value
;
6789 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
6791 struct lttng_ust_ctl_field
*fields
;
6793 DBG2("UST app ustctl register event received");
6795 ret
= lttng_ust_ctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
6796 &loglevel_value
, &sig
, &nr_fields
, &fields
,
6799 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6800 DBG3("UST app recv event failed. Application died: sock = %d",
6802 } else if (ret
== -EAGAIN
) {
6803 WARN("UST app recv event failed. Communication time out: sock = %d",
6806 ERR("UST app recv event failed with ret %d: sock = %d",
6813 * Add event to the UST registry coming from the notify socket. This
6814 * call will free if needed the sig, fields and model_emf_uri. This
6815 * code path loses the ownsership of these variables and transfer them
6816 * to the this function.
6818 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
6819 fields
, loglevel_value
, model_emf_uri
);
6826 case LTTNG_UST_CTL_NOTIFY_CMD_CHANNEL
:
6830 struct lttng_ust_ctl_field
*fields
;
6832 DBG2("UST app ustctl register channel received");
6834 ret
= lttng_ust_ctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
6837 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6838 DBG3("UST app recv channel failed. Application died: sock = %d",
6840 } else if (ret
== -EAGAIN
) {
6841 WARN("UST app recv channel failed. Communication time out: sock = %d",
6844 ERR("UST app recv channel failed with ret %d: sock = %d)",
6851 * The fields ownership are transfered to this function call meaning
6852 * that if needed it will be freed. After this, it's invalid to access
6853 * fields or clean it up.
6855 ret
= reply_ust_register_channel(sock
, cobjd
, nr_fields
,
6863 case LTTNG_UST_CTL_NOTIFY_CMD_ENUM
:
6866 char name
[LTTNG_UST_ABI_SYM_NAME_LEN
];
6868 struct lttng_ust_ctl_enum_entry
*entries
;
6870 DBG2("UST app ustctl register enum received");
6872 ret
= lttng_ust_ctl_recv_register_enum(sock
, &sobjd
, name
,
6873 &entries
, &nr_entries
);
6875 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
6876 DBG3("UST app recv enum failed. Application died: sock = %d",
6878 } else if (ret
== -EAGAIN
) {
6879 WARN("UST app recv enum failed. Communication time out: sock = %d",
6882 ERR("UST app recv enum failed with ret %d: sock = %d",
6888 /* Callee assumes ownership of entries */
6889 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
6890 entries
, nr_entries
);
6898 /* Should NEVER happen. */
6907 * Once the notify socket hangs up, this is called. First, it tries to find the
6908 * corresponding application. On failure, the call_rcu to close the socket is
6909 * executed. If an application is found, it tries to delete it from the notify
6910 * socket hash table. Whathever the result, it proceeds to the call_rcu.
6912 * Note that an object needs to be allocated here so on ENOMEM failure, the
6913 * call RCU is not done but the rest of the cleanup is.
6915 void ust_app_notify_sock_unregister(int sock
)
6918 struct lttng_ht_iter iter
;
6919 struct ust_app
*app
;
6920 struct ust_app_notify_sock_obj
*obj
;
6926 obj
= zmalloc(sizeof(*obj
));
6929 * An ENOMEM is kind of uncool. If this strikes we continue the
6930 * procedure but the call_rcu will not be called. In this case, we
6931 * accept the fd leak rather than possibly creating an unsynchronized
6932 * state between threads.
6934 * TODO: The notify object should be created once the notify socket is
6935 * registered and stored independantely from the ust app object. The
6936 * tricky part is to synchronize the teardown of the application and
6937 * this notify object. Let's keep that in mind so we can avoid this
6938 * kind of shenanigans with ENOMEM in the teardown path.
6945 DBG("UST app notify socket unregister %d", sock
);
6948 * Lookup application by notify socket. If this fails, this means that the
6949 * hash table delete has already been done by the application
6950 * unregistration process so we can safely close the notify socket in a
6953 app
= find_app_by_notify_sock(sock
);
6958 iter
.iter
.node
= &app
->notify_sock_n
.node
;
6961 * Whatever happens here either we fail or succeed, in both cases we have
6962 * to close the socket after a grace period to continue to the call RCU
6963 * here. If the deletion is successful, the application is not visible
6964 * anymore by other threads and is it fails it means that it was already
6965 * deleted from the hash table so either way we just have to close the
6968 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
6974 * Close socket after a grace period to avoid for the socket to be reused
6975 * before the application object is freed creating potential race between
6976 * threads trying to add unique in the global hash table.
6979 call_rcu(&obj
->head
, close_notify_sock_rcu
);
6984 * Destroy a ust app data structure and free its memory.
6986 void ust_app_destroy(struct ust_app
*app
)
6992 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
6996 * Take a snapshot for a given UST session. The snapshot is sent to the given
6999 * Returns LTTNG_OK on success or a LTTNG_ERR error code.
7001 enum lttng_error_code
ust_app_snapshot_record(
7002 const struct ltt_ust_session
*usess
,
7003 const struct consumer_output
*output
, int wait
,
7004 uint64_t nb_packets_per_stream
)
7007 enum lttng_error_code status
= LTTNG_OK
;
7008 struct lttng_ht_iter iter
;
7009 struct ust_app
*app
;
7010 char *trace_path
= NULL
;
7017 switch (usess
->buffer_type
) {
7018 case LTTNG_BUFFER_PER_UID
:
7020 struct buffer_reg_uid
*reg
;
7022 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7023 struct buffer_reg_channel
*buf_reg_chan
;
7024 struct consumer_socket
*socket
;
7025 char pathname
[PATH_MAX
];
7026 size_t consumer_path_offset
= 0;
7028 if (!reg
->registry
->reg
.ust
->metadata_key
) {
7029 /* Skip since no metadata is present */
7033 /* Get consumer socket to use to push the metadata.*/
7034 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7037 status
= LTTNG_ERR_INVALID
;
7041 memset(pathname
, 0, sizeof(pathname
));
7042 ret
= snprintf(pathname
, sizeof(pathname
),
7043 DEFAULT_UST_TRACE_UID_PATH
,
7044 reg
->uid
, reg
->bits_per_long
);
7046 PERROR("snprintf snapshot path");
7047 status
= LTTNG_ERR_INVALID
;
7050 /* Free path allowed on previous iteration. */
7052 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
7053 &consumer_path_offset
);
7055 status
= LTTNG_ERR_INVALID
;
7058 /* Add the UST default trace dir to path. */
7059 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7060 buf_reg_chan
, node
.node
) {
7061 status
= consumer_snapshot_channel(socket
,
7062 buf_reg_chan
->consumer_key
,
7063 output
, 0, usess
->uid
,
7064 usess
->gid
, &trace_path
[consumer_path_offset
], wait
,
7065 nb_packets_per_stream
);
7066 if (status
!= LTTNG_OK
) {
7070 status
= consumer_snapshot_channel(socket
,
7071 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
7072 usess
->uid
, usess
->gid
, &trace_path
[consumer_path_offset
],
7074 if (status
!= LTTNG_OK
) {
7080 case LTTNG_BUFFER_PER_PID
:
7082 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7083 struct consumer_socket
*socket
;
7084 struct lttng_ht_iter chan_iter
;
7085 struct ust_app_channel
*ua_chan
;
7086 struct ust_app_session
*ua_sess
;
7087 struct ust_registry_session
*registry
;
7088 char pathname
[PATH_MAX
];
7089 size_t consumer_path_offset
= 0;
7091 ua_sess
= lookup_session_by_app(usess
, app
);
7093 /* Session not associated with this app. */
7097 /* Get the right consumer socket for the application. */
7098 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7101 status
= LTTNG_ERR_INVALID
;
7105 /* Add the UST default trace dir to path. */
7106 memset(pathname
, 0, sizeof(pathname
));
7107 ret
= snprintf(pathname
, sizeof(pathname
), "%s",
7110 status
= LTTNG_ERR_INVALID
;
7111 PERROR("snprintf snapshot path");
7114 /* Free path allowed on previous iteration. */
7116 trace_path
= setup_channel_trace_path(usess
->consumer
, pathname
,
7117 &consumer_path_offset
);
7119 status
= LTTNG_ERR_INVALID
;
7122 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7123 ua_chan
, node
.node
) {
7124 status
= consumer_snapshot_channel(socket
,
7125 ua_chan
->key
, output
, 0,
7126 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7127 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7128 &trace_path
[consumer_path_offset
], wait
,
7129 nb_packets_per_stream
);
7133 case LTTNG_ERR_CHAN_NOT_FOUND
:
7140 registry
= get_session_registry(ua_sess
);
7142 DBG("Application session is being torn down. Skip application.");
7145 status
= consumer_snapshot_channel(socket
,
7146 registry
->metadata_key
, output
, 1,
7147 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7148 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7149 &trace_path
[consumer_path_offset
], wait
, 0);
7153 case LTTNG_ERR_CHAN_NOT_FOUND
:
7173 * Return the size taken by one more packet per stream.
7175 uint64_t ust_app_get_size_one_more_packet_per_stream(
7176 const struct ltt_ust_session
*usess
, uint64_t cur_nr_packets
)
7178 uint64_t tot_size
= 0;
7179 struct ust_app
*app
;
7180 struct lttng_ht_iter iter
;
7184 switch (usess
->buffer_type
) {
7185 case LTTNG_BUFFER_PER_UID
:
7187 struct buffer_reg_uid
*reg
;
7189 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7190 struct buffer_reg_channel
*buf_reg_chan
;
7193 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7194 buf_reg_chan
, node
.node
) {
7195 if (cur_nr_packets
>= buf_reg_chan
->num_subbuf
) {
7197 * Don't take channel into account if we
7198 * already grab all its packets.
7202 tot_size
+= buf_reg_chan
->subbuf_size
* buf_reg_chan
->stream_count
;
7208 case LTTNG_BUFFER_PER_PID
:
7211 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7212 struct ust_app_channel
*ua_chan
;
7213 struct ust_app_session
*ua_sess
;
7214 struct lttng_ht_iter chan_iter
;
7216 ua_sess
= lookup_session_by_app(usess
, app
);
7218 /* Session not associated with this app. */
7222 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7223 ua_chan
, node
.node
) {
7224 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
7226 * Don't take channel into account if we
7227 * already grab all its packets.
7231 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;
7245 int ust_app_uid_get_channel_runtime_stats(uint64_t ust_session_id
,
7246 struct cds_list_head
*buffer_reg_uid_list
,
7247 struct consumer_output
*consumer
, uint64_t uchan_id
,
7248 int overwrite
, uint64_t *discarded
, uint64_t *lost
)
7251 uint64_t consumer_chan_key
;
7256 ret
= buffer_reg_uid_consumer_channel_key(
7257 buffer_reg_uid_list
, uchan_id
, &consumer_chan_key
);
7265 ret
= consumer_get_lost_packets(ust_session_id
,
7266 consumer_chan_key
, consumer
, lost
);
7268 ret
= consumer_get_discarded_events(ust_session_id
,
7269 consumer_chan_key
, consumer
, discarded
);
7276 int ust_app_pid_get_channel_runtime_stats(struct ltt_ust_session
*usess
,
7277 struct ltt_ust_channel
*uchan
,
7278 struct consumer_output
*consumer
, int overwrite
,
7279 uint64_t *discarded
, uint64_t *lost
)
7282 struct lttng_ht_iter iter
;
7283 struct lttng_ht_node_str
*ua_chan_node
;
7284 struct ust_app
*app
;
7285 struct ust_app_session
*ua_sess
;
7286 struct ust_app_channel
*ua_chan
;
7293 * Iterate over every registered applications. Sum counters for
7294 * all applications containing requested session and channel.
7296 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7297 struct lttng_ht_iter uiter
;
7299 ua_sess
= lookup_session_by_app(usess
, app
);
7300 if (ua_sess
== NULL
) {
7305 lttng_ht_lookup(ua_sess
->channels
, (void *) uchan
->name
, &uiter
);
7306 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
7307 /* If the session is found for the app, the channel must be there */
7308 assert(ua_chan_node
);
7310 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
7315 ret
= consumer_get_lost_packets(usess
->id
, ua_chan
->key
,
7322 uint64_t _discarded
;
7324 ret
= consumer_get_discarded_events(usess
->id
,
7325 ua_chan
->key
, consumer
, &_discarded
);
7329 (*discarded
) += _discarded
;
7338 int ust_app_regenerate_statedump(struct ltt_ust_session
*usess
,
7339 struct ust_app
*app
)
7342 struct ust_app_session
*ua_sess
;
7344 DBG("Regenerating the metadata for ust app pid %d", app
->pid
);
7348 ua_sess
= lookup_session_by_app(usess
, app
);
7349 if (ua_sess
== NULL
) {
7350 /* The session is in teardown process. Ignore and continue. */
7354 pthread_mutex_lock(&ua_sess
->lock
);
7356 if (ua_sess
->deleted
) {
7360 pthread_mutex_lock(&app
->sock_lock
);
7361 ret
= lttng_ust_ctl_regenerate_statedump(app
->sock
, ua_sess
->handle
);
7362 pthread_mutex_unlock(&app
->sock_lock
);
7365 pthread_mutex_unlock(&ua_sess
->lock
);
7369 health_code_update();
7374 * Regenerate the statedump for each app in the session.
7376 int ust_app_regenerate_statedump_all(struct ltt_ust_session
*usess
)
7379 struct lttng_ht_iter iter
;
7380 struct ust_app
*app
;
7382 DBG("Regenerating the metadata for all UST apps");
7386 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7387 if (!app
->compatible
) {
7391 ret
= ust_app_regenerate_statedump(usess
, app
);
7393 /* Continue to the next app even on error */
7404 * Rotate all the channels of a session.
7406 * Return LTTNG_OK on success or else an LTTng error code.
7408 enum lttng_error_code
ust_app_rotate_session(struct ltt_session
*session
)
7411 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7412 struct lttng_ht_iter iter
;
7413 struct ust_app
*app
;
7414 struct ltt_ust_session
*usess
= session
->ust_session
;
7420 switch (usess
->buffer_type
) {
7421 case LTTNG_BUFFER_PER_UID
:
7423 struct buffer_reg_uid
*reg
;
7425 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7426 struct buffer_reg_channel
*buf_reg_chan
;
7427 struct consumer_socket
*socket
;
7429 /* Get consumer socket to use to push the metadata.*/
7430 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7433 cmd_ret
= LTTNG_ERR_INVALID
;
7437 /* Rotate the data channels. */
7438 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7439 buf_reg_chan
, node
.node
) {
7440 ret
= consumer_rotate_channel(socket
,
7441 buf_reg_chan
->consumer_key
,
7442 usess
->uid
, usess
->gid
,
7444 /* is_metadata_channel */ false);
7446 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7452 * The metadata channel might not be present.
7454 * Consumer stream allocation can be done
7455 * asynchronously and can fail on intermediary
7456 * operations (i.e add context) and lead to data
7457 * channels created with no metadata channel.
7459 if (!reg
->registry
->reg
.ust
->metadata_key
) {
7460 /* Skip since no metadata is present. */
7464 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7466 ret
= consumer_rotate_channel(socket
,
7467 reg
->registry
->reg
.ust
->metadata_key
,
7468 usess
->uid
, usess
->gid
,
7470 /* is_metadata_channel */ true);
7472 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7478 case LTTNG_BUFFER_PER_PID
:
7480 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7481 struct consumer_socket
*socket
;
7482 struct lttng_ht_iter chan_iter
;
7483 struct ust_app_channel
*ua_chan
;
7484 struct ust_app_session
*ua_sess
;
7485 struct ust_registry_session
*registry
;
7487 ua_sess
= lookup_session_by_app(usess
, app
);
7489 /* Session not associated with this app. */
7493 /* Get the right consumer socket for the application. */
7494 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7497 cmd_ret
= LTTNG_ERR_INVALID
;
7501 registry
= get_session_registry(ua_sess
);
7503 DBG("Application session is being torn down. Skip application.");
7507 /* Rotate the data channels. */
7508 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7509 ua_chan
, node
.node
) {
7510 ret
= consumer_rotate_channel(socket
,
7512 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7513 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7515 /* is_metadata_channel */ false);
7517 /* Per-PID buffer and application going away. */
7518 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7520 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7525 /* Rotate the metadata channel. */
7526 (void) push_metadata(registry
, usess
->consumer
);
7527 ret
= consumer_rotate_channel(socket
,
7528 registry
->metadata_key
,
7529 lttng_credentials_get_uid(&ua_sess
->effective_credentials
),
7530 lttng_credentials_get_gid(&ua_sess
->effective_credentials
),
7532 /* is_metadata_channel */ true);
7534 /* Per-PID buffer and application going away. */
7535 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
)
7537 cmd_ret
= LTTNG_ERR_ROTATION_FAIL_CONSUMER
;
7555 enum lttng_error_code
ust_app_create_channel_subdirectories(
7556 const struct ltt_ust_session
*usess
)
7558 enum lttng_error_code ret
= LTTNG_OK
;
7559 struct lttng_ht_iter iter
;
7560 enum lttng_trace_chunk_status chunk_status
;
7561 char *pathname_index
;
7564 assert(usess
->current_trace_chunk
);
7567 switch (usess
->buffer_type
) {
7568 case LTTNG_BUFFER_PER_UID
:
7570 struct buffer_reg_uid
*reg
;
7572 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7573 fmt_ret
= asprintf(&pathname_index
,
7574 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
"/" DEFAULT_INDEX_DIR
,
7575 reg
->uid
, reg
->bits_per_long
);
7577 ERR("Failed to format channel index directory");
7578 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7583 * Create the index subdirectory which will take care
7584 * of implicitly creating the channel's path.
7586 chunk_status
= lttng_trace_chunk_create_subdirectory(
7587 usess
->current_trace_chunk
,
7589 free(pathname_index
);
7590 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7591 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7597 case LTTNG_BUFFER_PER_PID
:
7599 struct ust_app
*app
;
7602 * Create the toplevel ust/ directory in case no apps are running.
7604 chunk_status
= lttng_trace_chunk_create_subdirectory(
7605 usess
->current_trace_chunk
,
7606 DEFAULT_UST_TRACE_DIR
);
7607 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7608 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7612 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
,
7614 struct ust_app_session
*ua_sess
;
7615 struct ust_registry_session
*registry
;
7617 ua_sess
= lookup_session_by_app(usess
, app
);
7619 /* Session not associated with this app. */
7623 registry
= get_session_registry(ua_sess
);
7625 DBG("Application session is being torn down. Skip application.");
7629 fmt_ret
= asprintf(&pathname_index
,
7630 DEFAULT_UST_TRACE_DIR
"/%s/" DEFAULT_INDEX_DIR
,
7633 ERR("Failed to format channel index directory");
7634 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7638 * Create the index subdirectory which will take care
7639 * of implicitly creating the channel's path.
7641 chunk_status
= lttng_trace_chunk_create_subdirectory(
7642 usess
->current_trace_chunk
,
7644 free(pathname_index
);
7645 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
7646 ret
= LTTNG_ERR_CREATE_DIR_FAIL
;
7663 * Clear all the channels of a session.
7665 * Return LTTNG_OK on success or else an LTTng error code.
7667 enum lttng_error_code
ust_app_clear_session(struct ltt_session
*session
)
7670 enum lttng_error_code cmd_ret
= LTTNG_OK
;
7671 struct lttng_ht_iter iter
;
7672 struct ust_app
*app
;
7673 struct ltt_ust_session
*usess
= session
->ust_session
;
7679 if (usess
->active
) {
7680 ERR("Expecting inactive session %s (%" PRIu64
")", session
->name
, session
->id
);
7681 cmd_ret
= LTTNG_ERR_FATAL
;
7685 switch (usess
->buffer_type
) {
7686 case LTTNG_BUFFER_PER_UID
:
7688 struct buffer_reg_uid
*reg
;
7690 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7691 struct buffer_reg_channel
*buf_reg_chan
;
7692 struct consumer_socket
*socket
;
7694 /* Get consumer socket to use to push the metadata.*/
7695 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
7698 cmd_ret
= LTTNG_ERR_INVALID
;
7702 /* Clear the data channels. */
7703 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
7704 buf_reg_chan
, node
.node
) {
7705 ret
= consumer_clear_channel(socket
,
7706 buf_reg_chan
->consumer_key
);
7712 (void) push_metadata(reg
->registry
->reg
.ust
, usess
->consumer
);
7715 * Clear the metadata channel.
7716 * Metadata channel is not cleared per se but we still need to
7717 * perform a rotation operation on it behind the scene.
7719 ret
= consumer_clear_channel(socket
,
7720 reg
->registry
->reg
.ust
->metadata_key
);
7727 case LTTNG_BUFFER_PER_PID
:
7729 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7730 struct consumer_socket
*socket
;
7731 struct lttng_ht_iter chan_iter
;
7732 struct ust_app_channel
*ua_chan
;
7733 struct ust_app_session
*ua_sess
;
7734 struct ust_registry_session
*registry
;
7736 ua_sess
= lookup_session_by_app(usess
, app
);
7738 /* Session not associated with this app. */
7742 /* Get the right consumer socket for the application. */
7743 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
7746 cmd_ret
= LTTNG_ERR_INVALID
;
7750 registry
= get_session_registry(ua_sess
);
7752 DBG("Application session is being torn down. Skip application.");
7756 /* Clear the data channels. */
7757 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
7758 ua_chan
, node
.node
) {
7759 ret
= consumer_clear_channel(socket
, ua_chan
->key
);
7761 /* Per-PID buffer and application going away. */
7762 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7769 (void) push_metadata(registry
, usess
->consumer
);
7772 * Clear the metadata channel.
7773 * Metadata channel is not cleared per se but we still need to
7774 * perform rotation operation on it behind the scene.
7776 ret
= consumer_clear_channel(socket
, registry
->metadata_key
);
7778 /* Per-PID buffer and application going away. */
7779 if (ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7797 case LTTCOMM_CONSUMERD_RELAYD_CLEAR_DISALLOWED
:
7798 cmd_ret
= LTTNG_ERR_CLEAR_RELAY_DISALLOWED
;
7801 cmd_ret
= LTTNG_ERR_CLEAR_FAIL_CONSUMER
;
7811 * This function skips the metadata channel as the begin/end timestamps of a
7812 * metadata packet are useless.
7814 * Moreover, opening a packet after a "clear" will cause problems for live
7815 * sessions as it will introduce padding that was not part of the first trace
7816 * chunk. The relay daemon expects the content of the metadata stream of
7817 * successive metadata trace chunks to be strict supersets of one another.
7819 * For example, flushing a packet at the beginning of the metadata stream of
7820 * a trace chunk resulting from a "clear" session command will cause the
7821 * size of the metadata stream of the new trace chunk to not match the size of
7822 * the metadata stream of the original chunk. This will confuse the relay
7823 * daemon as the same "offset" in a metadata stream will no longer point
7824 * to the same content.
7826 enum lttng_error_code
ust_app_open_packets(struct ltt_session
*session
)
7828 enum lttng_error_code ret
= LTTNG_OK
;
7829 struct lttng_ht_iter iter
;
7830 struct ltt_ust_session
*usess
= session
->ust_session
;
7836 switch (usess
->buffer_type
) {
7837 case LTTNG_BUFFER_PER_UID
:
7839 struct buffer_reg_uid
*reg
;
7841 cds_list_for_each_entry (
7842 reg
, &usess
->buffer_reg_uid_list
, lnode
) {
7843 struct buffer_reg_channel
*buf_reg_chan
;
7844 struct consumer_socket
*socket
;
7846 socket
= consumer_find_socket_by_bitness(
7847 reg
->bits_per_long
, usess
->consumer
);
7849 ret
= LTTNG_ERR_FATAL
;
7853 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
,
7854 &iter
.iter
, buf_reg_chan
, node
.node
) {
7855 const int open_ret
=
7856 consumer_open_channel_packets(
7858 buf_reg_chan
->consumer_key
);
7861 ret
= LTTNG_ERR_UNK
;
7868 case LTTNG_BUFFER_PER_PID
:
7870 struct ust_app
*app
;
7872 cds_lfht_for_each_entry (
7873 ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
7874 struct consumer_socket
*socket
;
7875 struct lttng_ht_iter chan_iter
;
7876 struct ust_app_channel
*ua_chan
;
7877 struct ust_app_session
*ua_sess
;
7878 struct ust_registry_session
*registry
;
7880 ua_sess
= lookup_session_by_app(usess
, app
);
7882 /* Session not associated with this app. */
7886 /* Get the right consumer socket for the application. */
7887 socket
= consumer_find_socket_by_bitness(
7888 app
->bits_per_long
, usess
->consumer
);
7890 ret
= LTTNG_ERR_FATAL
;
7894 registry
= get_session_registry(ua_sess
);
7896 DBG("Application session is being torn down. Skip application.");
7900 cds_lfht_for_each_entry(ua_sess
->channels
->ht
,
7901 &chan_iter
.iter
, ua_chan
, node
.node
) {
7902 const int open_ret
=
7903 consumer_open_channel_packets(
7909 * Per-PID buffer and application going
7912 if (open_ret
== -LTTNG_ERR_CHAN_NOT_FOUND
) {
7916 ret
= LTTNG_ERR_UNK
;