2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
44 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
46 /* Next available channel key. Access under next_channel_key_lock. */
47 static uint64_t _next_channel_key
;
48 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
50 /* Next available session ID. Access under next_session_id_lock. */
51 static uint64_t _next_session_id
;
52 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
55 * Return the incremented value of next_channel_key.
57 static uint64_t get_next_channel_key(void)
61 pthread_mutex_lock(&next_channel_key_lock
);
62 ret
= ++_next_channel_key
;
63 pthread_mutex_unlock(&next_channel_key_lock
);
68 * Return the atomically incremented value of next_session_id.
70 static uint64_t get_next_session_id(void)
74 pthread_mutex_lock(&next_session_id_lock
);
75 ret
= ++_next_session_id
;
76 pthread_mutex_unlock(&next_session_id_lock
);
80 static void copy_channel_attr_to_ustctl(
81 struct ustctl_consumer_channel_attr
*attr
,
82 struct lttng_ust_channel_attr
*uattr
)
84 /* Copy event attributes since the layout is different. */
85 attr
->subbuf_size
= uattr
->subbuf_size
;
86 attr
->num_subbuf
= uattr
->num_subbuf
;
87 attr
->overwrite
= uattr
->overwrite
;
88 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
89 attr
->read_timer_interval
= uattr
->read_timer_interval
;
90 attr
->output
= uattr
->output
;
94 * Match function for the hash table lookup.
96 * It matches an ust app event based on three attributes which are the event
97 * name, the filter bytecode and the loglevel.
99 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
101 struct ust_app_event
*event
;
102 const struct ust_app_ht_key
*key
;
103 int ev_loglevel_value
;
108 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
110 ev_loglevel_value
= event
->attr
.loglevel
;
112 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
115 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
119 /* Event loglevel. */
120 if (ev_loglevel_value
!= key
->loglevel_type
) {
121 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
122 && key
->loglevel_type
== 0 &&
123 ev_loglevel_value
== -1) {
125 * Match is accepted. This is because on event creation, the
126 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
127 * -1 are accepted for this loglevel type since 0 is the one set by
128 * the API when receiving an enable event.
135 /* One of the filters is NULL, fail. */
136 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
140 if (key
->filter
&& event
->filter
) {
141 /* Both filters exists, check length followed by the bytecode. */
142 if (event
->filter
->len
!= key
->filter
->len
||
143 memcmp(event
->filter
->data
, key
->filter
->data
,
144 event
->filter
->len
) != 0) {
149 /* One of the exclusions is NULL, fail. */
150 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
154 if (key
->exclusion
&& event
->exclusion
) {
155 /* Both exclusions exists, check count followed by the names. */
156 if (event
->exclusion
->count
!= key
->exclusion
->count
||
157 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
158 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
172 * Unique add of an ust app event in the given ht. This uses the custom
173 * ht_match_ust_app_event match function and the event name as hash.
175 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
176 struct ust_app_event
*event
)
178 struct cds_lfht_node
*node_ptr
;
179 struct ust_app_ht_key key
;
183 assert(ua_chan
->events
);
186 ht
= ua_chan
->events
;
187 key
.name
= event
->attr
.name
;
188 key
.filter
= event
->filter
;
189 key
.loglevel_type
= event
->attr
.loglevel
;
190 key
.exclusion
= event
->exclusion
;
192 node_ptr
= cds_lfht_add_unique(ht
->ht
,
193 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
194 ht_match_ust_app_event
, &key
, &event
->node
.node
);
195 assert(node_ptr
== &event
->node
.node
);
199 * Close the notify socket from the given RCU head object. This MUST be called
200 * through a call_rcu().
202 static void close_notify_sock_rcu(struct rcu_head
*head
)
205 struct ust_app_notify_sock_obj
*obj
=
206 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
208 /* Must have a valid fd here. */
209 assert(obj
->fd
>= 0);
211 ret
= close(obj
->fd
);
213 ERR("close notify sock %d RCU", obj
->fd
);
215 lttng_fd_put(LTTNG_FD_APPS
, 1);
221 * Return the session registry according to the buffer type of the given
224 * A registry per UID object MUST exists before calling this function or else
225 * it assert() if not found. RCU read side lock must be acquired.
227 static struct ust_registry_session
*get_session_registry(
228 struct ust_app_session
*ua_sess
)
230 struct ust_registry_session
*registry
= NULL
;
234 switch (ua_sess
->buffer_type
) {
235 case LTTNG_BUFFER_PER_PID
:
237 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
241 registry
= reg_pid
->registry
->reg
.ust
;
244 case LTTNG_BUFFER_PER_UID
:
246 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
247 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
251 registry
= reg_uid
->registry
->reg
.ust
;
263 * Delete ust context safely. RCU read lock must be held before calling
267 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
,
275 pthread_mutex_lock(&app
->sock_lock
);
276 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
277 pthread_mutex_unlock(&app
->sock_lock
);
278 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
279 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
280 sock
, ua_ctx
->obj
->handle
, ret
);
288 * Delete ust app event safely. RCU read lock must be held before calling
292 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
,
299 free(ua_event
->filter
);
300 if (ua_event
->exclusion
!= NULL
)
301 free(ua_event
->exclusion
);
302 if (ua_event
->obj
!= NULL
) {
303 pthread_mutex_lock(&app
->sock_lock
);
304 ret
= ustctl_release_object(sock
, ua_event
->obj
);
305 pthread_mutex_unlock(&app
->sock_lock
);
306 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
307 ERR("UST app sock %d release event obj failed with ret %d",
316 * Release ust data object of the given stream.
318 * Return 0 on success or else a negative value.
320 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
328 pthread_mutex_lock(&app
->sock_lock
);
329 ret
= ustctl_release_object(sock
, stream
->obj
);
330 pthread_mutex_unlock(&app
->sock_lock
);
331 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
332 ERR("UST app sock %d release stream obj failed with ret %d",
335 lttng_fd_put(LTTNG_FD_APPS
, 2);
343 * Delete ust app stream safely. RCU read lock must be held before calling
347 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
,
352 (void) release_ust_app_stream(sock
, stream
, app
);
357 * We need to execute ht_destroy outside of RCU read-side critical
358 * section and outside of call_rcu thread, so we postpone its execution
359 * using ht_cleanup_push. It is simpler than to change the semantic of
360 * the many callers of delete_ust_app_session().
363 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
365 struct ust_app_channel
*ua_chan
=
366 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
368 ht_cleanup_push(ua_chan
->ctx
);
369 ht_cleanup_push(ua_chan
->events
);
374 * Delete ust app channel safely. RCU read lock must be held before calling
378 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
382 struct lttng_ht_iter iter
;
383 struct ust_app_event
*ua_event
;
384 struct ust_app_ctx
*ua_ctx
;
385 struct ust_app_stream
*stream
, *stmp
;
386 struct ust_registry_session
*registry
;
390 DBG3("UST app deleting channel %s", ua_chan
->name
);
393 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
394 cds_list_del(&stream
->list
);
395 delete_ust_app_stream(sock
, stream
, app
);
399 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
400 cds_list_del(&ua_ctx
->list
);
401 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
403 delete_ust_app_ctx(sock
, ua_ctx
, app
);
407 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
409 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
411 delete_ust_app_event(sock
, ua_event
, app
);
414 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
415 /* Wipe and free registry from session registry. */
416 registry
= get_session_registry(ua_chan
->session
);
418 ust_registry_channel_del_free(registry
, ua_chan
->key
);
422 if (ua_chan
->obj
!= NULL
) {
423 /* Remove channel from application UST object descriptor. */
424 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
425 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
427 pthread_mutex_lock(&app
->sock_lock
);
428 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
429 pthread_mutex_unlock(&app
->sock_lock
);
430 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
431 ERR("UST app sock %d release channel obj failed with ret %d",
434 lttng_fd_put(LTTNG_FD_APPS
, 1);
437 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
440 int ust_app_register_done(struct ust_app
*app
)
444 pthread_mutex_lock(&app
->sock_lock
);
445 ret
= ustctl_register_done(app
->sock
);
446 pthread_mutex_unlock(&app
->sock_lock
);
450 int ust_app_release_object(struct ust_app
*app
, struct lttng_ust_object_data
*data
)
455 pthread_mutex_lock(&app
->sock_lock
);
460 ret
= ustctl_release_object(sock
, data
);
462 pthread_mutex_unlock(&app
->sock_lock
);
468 * Push metadata to consumer socket.
470 * RCU read-side lock must be held to guarantee existance of socket.
471 * Must be called with the ust app session lock held.
472 * Must be called with the registry lock held.
474 * On success, return the len of metadata pushed or else a negative value.
475 * Returning a -EPIPE return value means we could not send the metadata,
476 * but it can be caused by recoverable errors (e.g. the application has
477 * terminated concurrently).
479 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
480 struct consumer_socket
*socket
, int send_zero_data
)
483 char *metadata_str
= NULL
;
484 size_t len
, offset
, new_metadata_len_sent
;
486 uint64_t metadata_key
;
491 metadata_key
= registry
->metadata_key
;
494 * Means that no metadata was assigned to the session. This can
495 * happens if no start has been done previously.
502 * On a push metadata error either the consumer is dead or the
503 * metadata channel has been destroyed because its endpoint
504 * might have died (e.g: relayd), or because the application has
505 * exited. If so, the metadata closed flag is set to 1 so we
506 * deny pushing metadata again which is not valid anymore on the
509 if (registry
->metadata_closed
) {
513 offset
= registry
->metadata_len_sent
;
514 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
515 new_metadata_len_sent
= registry
->metadata_len
;
517 DBG3("No metadata to push for metadata key %" PRIu64
,
518 registry
->metadata_key
);
520 if (send_zero_data
) {
521 DBG("No metadata to push");
527 /* Allocate only what we have to send. */
528 metadata_str
= zmalloc(len
);
530 PERROR("zmalloc ust app metadata string");
534 /* Copy what we haven't sent out. */
535 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
538 pthread_mutex_unlock(®istry
->lock
);
540 * We need to unlock the registry while we push metadata to
541 * break a circular dependency between the consumerd metadata
542 * lock and the sessiond registry lock. Indeed, pushing metadata
543 * to the consumerd awaits that it gets pushed all the way to
544 * relayd, but doing so requires grabbing the metadata lock. If
545 * a concurrent metadata request is being performed by
546 * consumerd, this can try to grab the registry lock on the
547 * sessiond while holding the metadata lock on the consumer
548 * daemon. Those push and pull schemes are performed on two
549 * different bidirectionnal communication sockets.
551 ret
= consumer_push_metadata(socket
, metadata_key
,
552 metadata_str
, len
, offset
);
553 pthread_mutex_lock(®istry
->lock
);
556 * There is an acceptable race here between the registry
557 * metadata key assignment and the creation on the
558 * consumer. The session daemon can concurrently push
559 * metadata for this registry while being created on the
560 * consumer since the metadata key of the registry is
561 * assigned *before* it is setup to avoid the consumer
562 * to ask for metadata that could possibly be not found
563 * in the session daemon.
565 * The metadata will get pushed either by the session
566 * being stopped or the consumer requesting metadata if
567 * that race is triggered.
569 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
572 ERR("Error pushing metadata to consumer");
578 * Metadata may have been concurrently pushed, since
579 * we're not holding the registry lock while pushing to
580 * consumer. This is handled by the fact that we send
581 * the metadata content, size, and the offset at which
582 * that metadata belongs. This may arrive out of order
583 * on the consumer side, and the consumer is able to
584 * deal with overlapping fragments. The consumer
585 * supports overlapping fragments, which must be
586 * contiguous starting from offset 0. We keep the
587 * largest metadata_len_sent value of the concurrent
590 registry
->metadata_len_sent
=
591 max_t(size_t, registry
->metadata_len_sent
,
592 new_metadata_len_sent
);
601 * On error, flag the registry that the metadata is
602 * closed. We were unable to push anything and this
603 * means that either the consumer is not responding or
604 * the metadata cache has been destroyed on the
607 registry
->metadata_closed
= 1;
615 * For a given application and session, push metadata to consumer.
616 * Either sock or consumer is required : if sock is NULL, the default
617 * socket to send the metadata is retrieved from consumer, if sock
618 * is not NULL we use it to send the metadata.
619 * RCU read-side lock must be held while calling this function,
620 * therefore ensuring existance of registry. It also ensures existance
621 * of socket throughout this function.
623 * Return 0 on success else a negative error.
624 * Returning a -EPIPE return value means we could not send the metadata,
625 * but it can be caused by recoverable errors (e.g. the application has
626 * terminated concurrently).
628 static int push_metadata(struct ust_registry_session
*registry
,
629 struct consumer_output
*consumer
)
633 struct consumer_socket
*socket
;
638 pthread_mutex_lock(®istry
->lock
);
639 if (registry
->metadata_closed
) {
644 /* Get consumer socket to use to push the metadata.*/
645 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
652 ret
= ust_app_push_metadata(registry
, socket
, 0);
657 pthread_mutex_unlock(®istry
->lock
);
661 pthread_mutex_unlock(®istry
->lock
);
666 * Send to the consumer a close metadata command for the given session. Once
667 * done, the metadata channel is deleted and the session metadata pointer is
668 * nullified. The session lock MUST be held unless the application is
669 * in the destroy path.
671 * Return 0 on success else a negative value.
673 static int close_metadata(struct ust_registry_session
*registry
,
674 struct consumer_output
*consumer
)
677 struct consumer_socket
*socket
;
684 pthread_mutex_lock(®istry
->lock
);
686 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
691 /* Get consumer socket to use to push the metadata.*/
692 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
699 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
706 * Metadata closed. Even on error this means that the consumer is not
707 * responding or not found so either way a second close should NOT be emit
710 registry
->metadata_closed
= 1;
712 pthread_mutex_unlock(®istry
->lock
);
718 * We need to execute ht_destroy outside of RCU read-side critical
719 * section and outside of call_rcu thread, so we postpone its execution
720 * using ht_cleanup_push. It is simpler than to change the semantic of
721 * the many callers of delete_ust_app_session().
724 void delete_ust_app_session_rcu(struct rcu_head
*head
)
726 struct ust_app_session
*ua_sess
=
727 caa_container_of(head
, struct ust_app_session
, rcu_head
);
729 ht_cleanup_push(ua_sess
->channels
);
734 * Delete ust app session safely. RCU read lock must be held before calling
738 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
742 struct lttng_ht_iter iter
;
743 struct ust_app_channel
*ua_chan
;
744 struct ust_registry_session
*registry
;
748 pthread_mutex_lock(&ua_sess
->lock
);
750 assert(!ua_sess
->deleted
);
751 ua_sess
->deleted
= true;
753 registry
= get_session_registry(ua_sess
);
755 /* Push metadata for application before freeing the application. */
756 (void) push_metadata(registry
, ua_sess
->consumer
);
759 * Don't ask to close metadata for global per UID buffers. Close
760 * metadata only on destroy trace session in this case. Also, the
761 * previous push metadata could have flag the metadata registry to
762 * close so don't send a close command if closed.
764 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
765 /* And ask to close it for this session registry. */
766 (void) close_metadata(registry
, ua_sess
->consumer
);
770 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
772 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
774 delete_ust_app_channel(sock
, ua_chan
, app
);
777 /* In case of per PID, the registry is kept in the session. */
778 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
779 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
781 buffer_reg_pid_remove(reg_pid
);
782 buffer_reg_pid_destroy(reg_pid
);
786 if (ua_sess
->handle
!= -1) {
787 pthread_mutex_lock(&app
->sock_lock
);
788 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
789 pthread_mutex_unlock(&app
->sock_lock
);
790 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
791 ERR("UST app sock %d release session handle failed with ret %d",
795 pthread_mutex_unlock(&ua_sess
->lock
);
797 consumer_output_put(ua_sess
->consumer
);
799 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
803 * Delete a traceable application structure from the global list. Never call
804 * this function outside of a call_rcu call.
806 * RCU read side lock should _NOT_ be held when calling this function.
809 void delete_ust_app(struct ust_app
*app
)
812 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
814 /* Delete ust app sessions info */
819 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
821 /* Free every object in the session and the session. */
823 delete_ust_app_session(sock
, ua_sess
, app
);
827 ht_cleanup_push(app
->sessions
);
828 ht_cleanup_push(app
->ust_objd
);
831 * Wait until we have deleted the application from the sock hash table
832 * before closing this socket, otherwise an application could re-use the
833 * socket ID and race with the teardown, using the same hash table entry.
835 * It's OK to leave the close in call_rcu. We want it to stay unique for
836 * all RCU readers that could run concurrently with unregister app,
837 * therefore we _need_ to only close that socket after a grace period. So
838 * it should stay in this RCU callback.
840 * This close() is a very important step of the synchronization model so
841 * every modification to this function must be carefully reviewed.
847 lttng_fd_put(LTTNG_FD_APPS
, 1);
849 DBG2("UST app pid %d deleted", app
->pid
);
854 * URCU intermediate call to delete an UST app.
857 void delete_ust_app_rcu(struct rcu_head
*head
)
859 struct lttng_ht_node_ulong
*node
=
860 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
861 struct ust_app
*app
=
862 caa_container_of(node
, struct ust_app
, pid_n
);
864 DBG3("Call RCU deleting app PID %d", app
->pid
);
869 * Delete the session from the application ht and delete the data structure by
870 * freeing every object inside and releasing them.
872 static void destroy_app_session(struct ust_app
*app
,
873 struct ust_app_session
*ua_sess
)
876 struct lttng_ht_iter iter
;
881 iter
.iter
.node
= &ua_sess
->node
.node
;
882 ret
= lttng_ht_del(app
->sessions
, &iter
);
884 /* Already scheduled for teardown. */
888 /* Once deleted, free the data structure. */
889 delete_ust_app_session(app
->sock
, ua_sess
, app
);
896 * Alloc new UST app session.
899 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
901 struct ust_app_session
*ua_sess
;
903 /* Init most of the default value by allocating and zeroing */
904 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
905 if (ua_sess
== NULL
) {
910 ua_sess
->handle
= -1;
911 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
912 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
913 pthread_mutex_init(&ua_sess
->lock
, NULL
);
922 * Alloc new UST app channel.
925 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
926 struct ust_app_session
*ua_sess
,
927 struct lttng_ust_channel_attr
*attr
)
929 struct ust_app_channel
*ua_chan
;
931 /* Init most of the default value by allocating and zeroing */
932 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
933 if (ua_chan
== NULL
) {
938 /* Setup channel name */
939 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
940 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
942 ua_chan
->enabled
= 1;
943 ua_chan
->handle
= -1;
944 ua_chan
->session
= ua_sess
;
945 ua_chan
->key
= get_next_channel_key();
946 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
947 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
948 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
950 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
951 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
953 /* Copy attributes */
955 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
956 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
957 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
958 ua_chan
->attr
.overwrite
= attr
->overwrite
;
959 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
960 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
961 ua_chan
->attr
.output
= attr
->output
;
963 /* By default, the channel is a per cpu channel. */
964 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
966 DBG3("UST app channel %s allocated", ua_chan
->name
);
975 * Allocate and initialize a UST app stream.
977 * Return newly allocated stream pointer or NULL on error.
979 struct ust_app_stream
*ust_app_alloc_stream(void)
981 struct ust_app_stream
*stream
= NULL
;
983 stream
= zmalloc(sizeof(*stream
));
984 if (stream
== NULL
) {
985 PERROR("zmalloc ust app stream");
989 /* Zero could be a valid value for a handle so flag it to -1. */
997 * Alloc new UST app event.
1000 struct ust_app_event
*alloc_ust_app_event(char *name
,
1001 struct lttng_ust_event
*attr
)
1003 struct ust_app_event
*ua_event
;
1005 /* Init most of the default value by allocating and zeroing */
1006 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1007 if (ua_event
== NULL
) {
1012 ua_event
->enabled
= 1;
1013 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1014 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1015 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1017 /* Copy attributes */
1019 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1022 DBG3("UST app event %s allocated", ua_event
->name
);
1031 * Alloc new UST app context.
1034 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
1036 struct ust_app_ctx
*ua_ctx
;
1038 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1039 if (ua_ctx
== NULL
) {
1043 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1046 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1049 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1056 * Allocate a filter and copy the given original filter.
1058 * Return allocated filter or NULL on error.
1060 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1061 struct lttng_filter_bytecode
*orig_f
)
1063 struct lttng_filter_bytecode
*filter
= NULL
;
1065 /* Copy filter bytecode */
1066 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1068 PERROR("zmalloc alloc filter bytecode");
1072 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1079 * Create a liblttng-ust filter bytecode from given bytecode.
1081 * Return allocated filter or NULL on error.
1083 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1084 struct lttng_filter_bytecode
*orig_f
)
1086 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1088 /* Copy filter bytecode */
1089 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1091 PERROR("zmalloc alloc ust filter bytecode");
1095 assert(sizeof(struct lttng_filter_bytecode
) ==
1096 sizeof(struct lttng_ust_filter_bytecode
));
1097 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1103 * Find an ust_app using the sock and return it. RCU read side lock must be
1104 * held before calling this helper function.
1106 struct ust_app
*ust_app_find_by_sock(int sock
)
1108 struct lttng_ht_node_ulong
*node
;
1109 struct lttng_ht_iter iter
;
1111 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1112 node
= lttng_ht_iter_get_node_ulong(&iter
);
1114 DBG2("UST app find by sock %d not found", sock
);
1118 return caa_container_of(node
, struct ust_app
, sock_n
);
1125 * Find an ust_app using the notify sock and return it. RCU read side lock must
1126 * be held before calling this helper function.
1128 static struct ust_app
*find_app_by_notify_sock(int sock
)
1130 struct lttng_ht_node_ulong
*node
;
1131 struct lttng_ht_iter iter
;
1133 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1135 node
= lttng_ht_iter_get_node_ulong(&iter
);
1137 DBG2("UST app find by notify sock %d not found", sock
);
1141 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1148 * Lookup for an ust app event based on event name, filter bytecode and the
1151 * Return an ust_app_event object or NULL on error.
1153 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1154 char *name
, struct lttng_filter_bytecode
*filter
,
1156 const struct lttng_event_exclusion
*exclusion
)
1158 struct lttng_ht_iter iter
;
1159 struct lttng_ht_node_str
*node
;
1160 struct ust_app_event
*event
= NULL
;
1161 struct ust_app_ht_key key
;
1166 /* Setup key for event lookup. */
1168 key
.filter
= filter
;
1169 key
.loglevel_type
= loglevel_value
;
1170 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1171 key
.exclusion
= exclusion
;
1173 /* Lookup using the event name as hash and a custom match fct. */
1174 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1175 ht_match_ust_app_event
, &key
, &iter
.iter
);
1176 node
= lttng_ht_iter_get_node_str(&iter
);
1181 event
= caa_container_of(node
, struct ust_app_event
, node
);
1188 * Create the channel context on the tracer.
1190 * Called with UST app session lock held.
1193 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1194 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1198 health_code_update();
1200 pthread_mutex_lock(&app
->sock_lock
);
1201 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1202 ua_chan
->obj
, &ua_ctx
->obj
);
1203 pthread_mutex_unlock(&app
->sock_lock
);
1205 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1206 ERR("UST app create channel context failed for app (pid: %d) "
1207 "with ret %d", app
->pid
, ret
);
1210 * This is normal behavior, an application can die during the
1211 * creation process. Don't report an error so the execution can
1212 * continue normally.
1215 DBG3("UST app disable event failed. Application is dead.");
1220 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1222 DBG2("UST app context handle %d created successfully for channel %s",
1223 ua_ctx
->handle
, ua_chan
->name
);
1226 health_code_update();
1231 * Set the filter on the tracer.
1234 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1235 struct ust_app
*app
)
1238 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1240 health_code_update();
1242 if (!ua_event
->filter
) {
1247 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1248 if (!ust_bytecode
) {
1249 ret
= -LTTNG_ERR_NOMEM
;
1252 pthread_mutex_lock(&app
->sock_lock
);
1253 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1255 pthread_mutex_unlock(&app
->sock_lock
);
1257 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1258 ERR("UST app event %s filter failed for app (pid: %d) "
1259 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1262 * This is normal behavior, an application can die during the
1263 * creation process. Don't report an error so the execution can
1264 * continue normally.
1267 DBG3("UST app filter event failed. Application is dead.");
1272 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1275 health_code_update();
1281 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1282 struct lttng_event_exclusion
*exclusion
)
1284 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1285 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1286 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1288 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1289 if (!ust_exclusion
) {
1294 assert(sizeof(struct lttng_event_exclusion
) ==
1295 sizeof(struct lttng_ust_event_exclusion
));
1296 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1298 return ust_exclusion
;
1302 * Set event exclusions on the tracer.
1305 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1306 struct ust_app
*app
)
1309 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1311 health_code_update();
1313 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1318 ust_exclusion
= create_ust_exclusion_from_exclusion(
1319 ua_event
->exclusion
);
1320 if (!ust_exclusion
) {
1321 ret
= -LTTNG_ERR_NOMEM
;
1324 pthread_mutex_lock(&app
->sock_lock
);
1325 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1326 pthread_mutex_unlock(&app
->sock_lock
);
1328 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1329 ERR("UST app event %s exclusions failed for app (pid: %d) "
1330 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1333 * This is normal behavior, an application can die during the
1334 * creation process. Don't report an error so the execution can
1335 * continue normally.
1338 DBG3("UST app event exclusion failed. Application is dead.");
1343 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1346 health_code_update();
1347 free(ust_exclusion
);
1352 * Disable the specified event on to UST tracer for the UST session.
1354 static int disable_ust_event(struct ust_app
*app
,
1355 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1359 health_code_update();
1361 pthread_mutex_lock(&app
->sock_lock
);
1362 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1363 pthread_mutex_unlock(&app
->sock_lock
);
1365 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1366 ERR("UST app event %s disable failed for app (pid: %d) "
1367 "and session handle %d with ret %d",
1368 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1371 * This is normal behavior, an application can die during the
1372 * creation process. Don't report an error so the execution can
1373 * continue normally.
1376 DBG3("UST app disable event failed. Application is dead.");
1381 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1382 ua_event
->attr
.name
, app
->pid
);
1385 health_code_update();
1390 * Disable the specified channel on to UST tracer for the UST session.
1392 static int disable_ust_channel(struct ust_app
*app
,
1393 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1397 health_code_update();
1399 pthread_mutex_lock(&app
->sock_lock
);
1400 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1401 pthread_mutex_unlock(&app
->sock_lock
);
1403 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1404 ERR("UST app channel %s disable failed for app (pid: %d) "
1405 "and session handle %d with ret %d",
1406 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1409 * This is normal behavior, an application can die during the
1410 * creation process. Don't report an error so the execution can
1411 * continue normally.
1414 DBG3("UST app disable channel failed. Application is dead.");
1419 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1420 ua_chan
->name
, app
->pid
);
1423 health_code_update();
1428 * Enable the specified channel on to UST tracer for the UST session.
1430 static int enable_ust_channel(struct ust_app
*app
,
1431 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1435 health_code_update();
1437 pthread_mutex_lock(&app
->sock_lock
);
1438 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1439 pthread_mutex_unlock(&app
->sock_lock
);
1441 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1442 ERR("UST app channel %s enable failed for app (pid: %d) "
1443 "and session handle %d with ret %d",
1444 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1447 * This is normal behavior, an application can die during the
1448 * creation process. Don't report an error so the execution can
1449 * continue normally.
1452 DBG3("UST app enable channel failed. Application is dead.");
1457 ua_chan
->enabled
= 1;
1459 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1460 ua_chan
->name
, app
->pid
);
1463 health_code_update();
1468 * Enable the specified event on to UST tracer for the UST session.
1470 static int enable_ust_event(struct ust_app
*app
,
1471 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1475 health_code_update();
1477 pthread_mutex_lock(&app
->sock_lock
);
1478 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1479 pthread_mutex_unlock(&app
->sock_lock
);
1481 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1482 ERR("UST app event %s enable failed for app (pid: %d) "
1483 "and session handle %d with ret %d",
1484 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1487 * This is normal behavior, an application can die during the
1488 * creation process. Don't report an error so the execution can
1489 * continue normally.
1492 DBG3("UST app enable event failed. Application is dead.");
1497 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1498 ua_event
->attr
.name
, app
->pid
);
1501 health_code_update();
1506 * Send channel and stream buffer to application.
1508 * Return 0 on success. On error, a negative value is returned.
1510 static int send_channel_pid_to_ust(struct ust_app
*app
,
1511 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1514 struct ust_app_stream
*stream
, *stmp
;
1520 health_code_update();
1522 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1525 /* Send channel to the application. */
1526 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1527 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1528 ret
= -ENOTCONN
; /* Caused by app exiting. */
1530 } else if (ret
< 0) {
1534 health_code_update();
1536 /* Send all streams to application. */
1537 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1538 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1539 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1540 ret
= -ENOTCONN
; /* Caused by app exiting. */
1542 } else if (ret
< 0) {
1545 /* We don't need the stream anymore once sent to the tracer. */
1546 cds_list_del(&stream
->list
);
1547 delete_ust_app_stream(-1, stream
, app
);
1549 /* Flag the channel that it is sent to the application. */
1550 ua_chan
->is_sent
= 1;
1553 health_code_update();
1558 * Create the specified event onto the UST tracer for a UST session.
1560 * Should be called with session mutex held.
1563 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1564 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1568 health_code_update();
1570 /* Create UST event on tracer */
1571 pthread_mutex_lock(&app
->sock_lock
);
1572 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1574 pthread_mutex_unlock(&app
->sock_lock
);
1576 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1577 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1578 ua_event
->attr
.name
, app
->pid
, ret
);
1581 * This is normal behavior, an application can die during the
1582 * creation process. Don't report an error so the execution can
1583 * continue normally.
1586 DBG3("UST app create event failed. Application is dead.");
1591 ua_event
->handle
= ua_event
->obj
->handle
;
1593 DBG2("UST app event %s created successfully for pid:%d",
1594 ua_event
->attr
.name
, app
->pid
);
1596 health_code_update();
1598 /* Set filter if one is present. */
1599 if (ua_event
->filter
) {
1600 ret
= set_ust_event_filter(ua_event
, app
);
1606 /* Set exclusions for the event */
1607 if (ua_event
->exclusion
) {
1608 ret
= set_ust_event_exclusion(ua_event
, app
);
1614 /* If event not enabled, disable it on the tracer */
1615 if (ua_event
->enabled
) {
1617 * We now need to explicitly enable the event, since it
1618 * is now disabled at creation.
1620 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1623 * If we hit an EPERM, something is wrong with our enable call. If
1624 * we get an EEXIST, there is a problem on the tracer side since we
1628 case -LTTNG_UST_ERR_PERM
:
1629 /* Code flow problem */
1631 case -LTTNG_UST_ERR_EXIST
:
1632 /* It's OK for our use case. */
1643 health_code_update();
1648 * Copy data between an UST app event and a LTT event.
1650 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1651 struct ltt_ust_event
*uevent
)
1653 size_t exclusion_alloc_size
;
1655 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1656 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1658 ua_event
->enabled
= uevent
->enabled
;
1660 /* Copy event attributes */
1661 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1663 /* Copy filter bytecode */
1664 if (uevent
->filter
) {
1665 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1666 /* Filter might be NULL here in case of ENONEM. */
1669 /* Copy exclusion data */
1670 if (uevent
->exclusion
) {
1671 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1672 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1673 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1674 if (ua_event
->exclusion
== NULL
) {
1677 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1678 exclusion_alloc_size
);
1684 * Copy data between an UST app channel and a LTT channel.
1686 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1687 struct ltt_ust_channel
*uchan
)
1689 struct lttng_ht_iter iter
;
1690 struct ltt_ust_event
*uevent
;
1691 struct ltt_ust_context
*uctx
;
1692 struct ust_app_event
*ua_event
;
1693 struct ust_app_ctx
*ua_ctx
;
1695 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1697 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1698 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1700 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1701 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1703 /* Copy event attributes since the layout is different. */
1704 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1705 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1706 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1707 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1708 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1709 ua_chan
->attr
.output
= uchan
->attr
.output
;
1711 * Note that the attribute channel type is not set since the channel on the
1712 * tracing registry side does not have this information.
1715 ua_chan
->enabled
= uchan
->enabled
;
1716 ua_chan
->tracing_channel_id
= uchan
->id
;
1718 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1719 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1720 if (ua_ctx
== NULL
) {
1723 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1724 (unsigned long) ua_ctx
->ctx
.ctx
);
1725 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1726 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1729 /* Copy all events from ltt ust channel to ust app channel */
1730 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1731 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1732 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1733 if (ua_event
== NULL
) {
1734 DBG2("UST event %s not found on shadow copy channel",
1736 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1737 if (ua_event
== NULL
) {
1740 shadow_copy_event(ua_event
, uevent
);
1741 add_unique_ust_app_event(ua_chan
, ua_event
);
1745 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1749 * Copy data between a UST app session and a regular LTT session.
1751 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1752 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1754 struct lttng_ht_node_str
*ua_chan_node
;
1755 struct lttng_ht_iter iter
;
1756 struct ltt_ust_channel
*uchan
;
1757 struct ust_app_channel
*ua_chan
;
1759 struct tm
*timeinfo
;
1762 char tmp_shm_path
[PATH_MAX
];
1764 /* Get date and time for unique app path */
1766 timeinfo
= localtime(&rawtime
);
1767 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1769 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1771 ua_sess
->tracing_id
= usess
->id
;
1772 ua_sess
->id
= get_next_session_id();
1773 ua_sess
->uid
= app
->uid
;
1774 ua_sess
->gid
= app
->gid
;
1775 ua_sess
->euid
= usess
->uid
;
1776 ua_sess
->egid
= usess
->gid
;
1777 ua_sess
->buffer_type
= usess
->buffer_type
;
1778 ua_sess
->bits_per_long
= app
->bits_per_long
;
1780 /* There is only one consumer object per session possible. */
1781 consumer_output_get(usess
->consumer
);
1782 ua_sess
->consumer
= usess
->consumer
;
1784 ua_sess
->output_traces
= usess
->output_traces
;
1785 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1786 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1787 &usess
->metadata_attr
);
1789 switch (ua_sess
->buffer_type
) {
1790 case LTTNG_BUFFER_PER_PID
:
1791 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1792 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1795 case LTTNG_BUFFER_PER_UID
:
1796 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1797 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1804 PERROR("asprintf UST shadow copy session");
1809 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1810 sizeof(ua_sess
->root_shm_path
));
1811 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1812 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1813 sizeof(ua_sess
->shm_path
));
1814 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1815 if (ua_sess
->shm_path
[0]) {
1816 switch (ua_sess
->buffer_type
) {
1817 case LTTNG_BUFFER_PER_PID
:
1818 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1819 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1820 app
->name
, app
->pid
, datetime
);
1822 case LTTNG_BUFFER_PER_UID
:
1823 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1824 DEFAULT_UST_TRACE_UID_PATH
,
1825 app
->uid
, app
->bits_per_long
);
1832 PERROR("sprintf UST shadow copy session");
1836 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1837 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1838 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1841 /* Iterate over all channels in global domain. */
1842 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1844 struct lttng_ht_iter uiter
;
1846 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1847 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1848 if (ua_chan_node
!= NULL
) {
1849 /* Session exist. Contiuing. */
1853 DBG2("Channel %s not found on shadow session copy, creating it",
1855 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1856 if (ua_chan
== NULL
) {
1857 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1860 shadow_copy_channel(ua_chan
, uchan
);
1862 * The concept of metadata channel does not exist on the tracing
1863 * registry side of the session daemon so this can only be a per CPU
1864 * channel and not metadata.
1866 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1868 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1873 consumer_output_put(ua_sess
->consumer
);
1877 * Lookup sesison wrapper.
1880 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1881 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1883 /* Get right UST app session from app */
1884 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1888 * Return ust app session from the app session hashtable using the UST session
1891 static struct ust_app_session
*lookup_session_by_app(
1892 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1894 struct lttng_ht_iter iter
;
1895 struct lttng_ht_node_u64
*node
;
1897 __lookup_session_by_app(usess
, app
, &iter
);
1898 node
= lttng_ht_iter_get_node_u64(&iter
);
1903 return caa_container_of(node
, struct ust_app_session
, node
);
1910 * Setup buffer registry per PID for the given session and application. If none
1911 * is found, a new one is created, added to the global registry and
1912 * initialized. If regp is valid, it's set with the newly created object.
1914 * Return 0 on success or else a negative value.
1916 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1917 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1920 struct buffer_reg_pid
*reg_pid
;
1927 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1930 * This is the create channel path meaning that if there is NO
1931 * registry available, we have to create one for this session.
1933 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1934 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1942 /* Initialize registry. */
1943 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1944 app
->bits_per_long
, app
->uint8_t_alignment
,
1945 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1946 app
->uint64_t_alignment
, app
->long_alignment
,
1947 app
->byte_order
, app
->version
.major
,
1948 app
->version
.minor
, reg_pid
->root_shm_path
,
1950 ua_sess
->euid
, ua_sess
->egid
);
1953 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1954 * destroy the buffer registry, because it is always expected
1955 * that if the buffer registry can be found, its ust registry is
1958 buffer_reg_pid_destroy(reg_pid
);
1962 buffer_reg_pid_add(reg_pid
);
1964 DBG3("UST app buffer registry per PID created successfully");
1976 * Setup buffer registry per UID for the given session and application. If none
1977 * is found, a new one is created, added to the global registry and
1978 * initialized. If regp is valid, it's set with the newly created object.
1980 * Return 0 on success or else a negative value.
1982 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1983 struct ust_app_session
*ua_sess
,
1984 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1987 struct buffer_reg_uid
*reg_uid
;
1994 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1997 * This is the create channel path meaning that if there is NO
1998 * registry available, we have to create one for this session.
2000 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2001 LTTNG_DOMAIN_UST
, ®_uid
,
2002 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2010 /* Initialize registry. */
2011 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2012 app
->bits_per_long
, app
->uint8_t_alignment
,
2013 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2014 app
->uint64_t_alignment
, app
->long_alignment
,
2015 app
->byte_order
, app
->version
.major
,
2016 app
->version
.minor
, reg_uid
->root_shm_path
,
2017 reg_uid
->shm_path
, usess
->uid
, usess
->gid
);
2020 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2021 * destroy the buffer registry, because it is always expected
2022 * that if the buffer registry can be found, its ust registry is
2025 buffer_reg_uid_destroy(reg_uid
, NULL
);
2028 /* Add node to teardown list of the session. */
2029 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2031 buffer_reg_uid_add(reg_uid
);
2033 DBG3("UST app buffer registry per UID created successfully");
2044 * Create a session on the tracer side for the given app.
2046 * On success, ua_sess_ptr is populated with the session pointer or else left
2047 * untouched. If the session was created, is_created is set to 1. On error,
2048 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2051 * Returns 0 on success or else a negative code which is either -ENOMEM or
2052 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2054 static int create_ust_app_session(struct ltt_ust_session
*usess
,
2055 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2058 int ret
, created
= 0;
2059 struct ust_app_session
*ua_sess
;
2063 assert(ua_sess_ptr
);
2065 health_code_update();
2067 ua_sess
= lookup_session_by_app(usess
, app
);
2068 if (ua_sess
== NULL
) {
2069 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2070 app
->pid
, usess
->id
);
2071 ua_sess
= alloc_ust_app_session(app
);
2072 if (ua_sess
== NULL
) {
2073 /* Only malloc can failed so something is really wrong */
2077 shadow_copy_session(ua_sess
, usess
, app
);
2081 switch (usess
->buffer_type
) {
2082 case LTTNG_BUFFER_PER_PID
:
2083 /* Init local registry. */
2084 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2086 delete_ust_app_session(-1, ua_sess
, app
);
2090 case LTTNG_BUFFER_PER_UID
:
2091 /* Look for a global registry. If none exists, create one. */
2092 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2094 delete_ust_app_session(-1, ua_sess
, app
);
2104 health_code_update();
2106 if (ua_sess
->handle
== -1) {
2107 pthread_mutex_lock(&app
->sock_lock
);
2108 ret
= ustctl_create_session(app
->sock
);
2109 pthread_mutex_unlock(&app
->sock_lock
);
2111 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2112 ERR("Creating session for app pid %d with ret %d",
2115 DBG("UST app creating session failed. Application is dead");
2117 * This is normal behavior, an application can die during the
2118 * creation process. Don't report an error so the execution can
2119 * continue normally. This will get flagged ENOTCONN and the
2120 * caller will handle it.
2124 delete_ust_app_session(-1, ua_sess
, app
);
2125 if (ret
!= -ENOMEM
) {
2127 * Tracer is probably gone or got an internal error so let's
2128 * behave like it will soon unregister or not usable.
2135 ua_sess
->handle
= ret
;
2137 /* Add ust app session to app's HT */
2138 lttng_ht_node_init_u64(&ua_sess
->node
,
2139 ua_sess
->tracing_id
);
2140 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2142 DBG2("UST app session created successfully with handle %d", ret
);
2145 *ua_sess_ptr
= ua_sess
;
2147 *is_created
= created
;
2150 /* Everything went well. */
2154 health_code_update();
2159 * Match function for a hash table lookup of ust_app_ctx.
2161 * It matches an ust app context based on the context type and, in the case
2162 * of perf counters, their name.
2164 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2166 struct ust_app_ctx
*ctx
;
2167 const struct lttng_ust_context
*key
;
2172 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2176 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2180 /* Check the name in the case of perf thread counters. */
2181 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
2182 if (strncmp(key
->u
.perf_counter
.name
,
2183 ctx
->ctx
.u
.perf_counter
.name
,
2184 sizeof(key
->u
.perf_counter
.name
))) {
2197 * Lookup for an ust app context from an lttng_ust_context.
2199 * Must be called while holding RCU read side lock.
2200 * Return an ust_app_ctx object or NULL on error.
2203 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2204 struct lttng_ust_context
*uctx
)
2206 struct lttng_ht_iter iter
;
2207 struct lttng_ht_node_ulong
*node
;
2208 struct ust_app_ctx
*app_ctx
= NULL
;
2213 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2214 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2215 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2216 node
= lttng_ht_iter_get_node_ulong(&iter
);
2221 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2228 * Create a context for the channel on the tracer.
2230 * Called with UST app session lock held and a RCU read side lock.
2233 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2234 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2235 struct ust_app
*app
)
2238 struct ust_app_ctx
*ua_ctx
;
2240 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2242 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2248 ua_ctx
= alloc_ust_app_ctx(uctx
);
2249 if (ua_ctx
== NULL
) {
2255 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2256 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2257 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2259 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2269 * Enable on the tracer side a ust app event for the session and channel.
2271 * Called with UST app session lock held.
2274 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2275 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2279 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2284 ua_event
->enabled
= 1;
2291 * Disable on the tracer side a ust app event for the session and channel.
2293 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2294 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2298 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2303 ua_event
->enabled
= 0;
2310 * Lookup ust app channel for session and disable it on the tracer side.
2313 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2314 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2318 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2323 ua_chan
->enabled
= 0;
2330 * Lookup ust app channel for session and enable it on the tracer side. This
2331 * MUST be called with a RCU read side lock acquired.
2333 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2334 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2337 struct lttng_ht_iter iter
;
2338 struct lttng_ht_node_str
*ua_chan_node
;
2339 struct ust_app_channel
*ua_chan
;
2341 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2342 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2343 if (ua_chan_node
== NULL
) {
2344 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2345 uchan
->name
, ua_sess
->tracing_id
);
2349 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2351 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2361 * Ask the consumer to create a channel and get it if successful.
2363 * Return 0 on success or else a negative value.
2365 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2366 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2367 int bitness
, struct ust_registry_session
*registry
)
2370 unsigned int nb_fd
= 0;
2371 struct consumer_socket
*socket
;
2379 health_code_update();
2381 /* Get the right consumer socket for the application. */
2382 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2388 health_code_update();
2390 /* Need one fd for the channel. */
2391 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2393 ERR("Exhausted number of available FD upon create channel");
2398 * Ask consumer to create channel. The consumer will return the number of
2399 * stream we have to expect.
2401 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2408 * Compute the number of fd needed before receiving them. It must be 2 per
2409 * stream (2 being the default value here).
2411 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2413 /* Reserve the amount of file descriptor we need. */
2414 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2416 ERR("Exhausted number of available FD upon create channel");
2417 goto error_fd_get_stream
;
2420 health_code_update();
2423 * Now get the channel from the consumer. This call wil populate the stream
2424 * list of that channel and set the ust objects.
2426 if (usess
->consumer
->enabled
) {
2427 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2437 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2438 error_fd_get_stream
:
2440 * Initiate a destroy channel on the consumer since we had an error
2441 * handling it on our side. The return value is of no importance since we
2442 * already have a ret value set by the previous error that we need to
2445 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2447 lttng_fd_put(LTTNG_FD_APPS
, 1);
2449 health_code_update();
2455 * Duplicate the ust data object of the ust app stream and save it in the
2456 * buffer registry stream.
2458 * Return 0 on success or else a negative value.
2460 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2461 struct ust_app_stream
*stream
)
2468 /* Reserve the amount of file descriptor we need. */
2469 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2471 ERR("Exhausted number of available FD upon duplicate stream");
2475 /* Duplicate object for stream once the original is in the registry. */
2476 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2477 reg_stream
->obj
.ust
);
2479 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2480 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2481 lttng_fd_put(LTTNG_FD_APPS
, 2);
2484 stream
->handle
= stream
->obj
->handle
;
2491 * Duplicate the ust data object of the ust app. channel and save it in the
2492 * buffer registry channel.
2494 * Return 0 on success or else a negative value.
2496 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2497 struct ust_app_channel
*ua_chan
)
2504 /* Need two fds for the channel. */
2505 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2507 ERR("Exhausted number of available FD upon duplicate channel");
2511 /* Duplicate object for stream once the original is in the registry. */
2512 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2514 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2515 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2518 ua_chan
->handle
= ua_chan
->obj
->handle
;
2523 lttng_fd_put(LTTNG_FD_APPS
, 1);
2529 * For a given channel buffer registry, setup all streams of the given ust
2530 * application channel.
2532 * Return 0 on success or else a negative value.
2534 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2535 struct ust_app_channel
*ua_chan
,
2536 struct ust_app
*app
)
2539 struct ust_app_stream
*stream
, *stmp
;
2544 DBG2("UST app setup buffer registry stream");
2546 /* Send all streams to application. */
2547 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2548 struct buffer_reg_stream
*reg_stream
;
2550 ret
= buffer_reg_stream_create(®_stream
);
2556 * Keep original pointer and nullify it in the stream so the delete
2557 * stream call does not release the object.
2559 reg_stream
->obj
.ust
= stream
->obj
;
2561 buffer_reg_stream_add(reg_stream
, reg_chan
);
2563 /* We don't need the streams anymore. */
2564 cds_list_del(&stream
->list
);
2565 delete_ust_app_stream(-1, stream
, app
);
2573 * Create a buffer registry channel for the given session registry and
2574 * application channel object. If regp pointer is valid, it's set with the
2575 * created object. Important, the created object is NOT added to the session
2576 * registry hash table.
2578 * Return 0 on success else a negative value.
2580 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2581 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2584 struct buffer_reg_channel
*reg_chan
= NULL
;
2589 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2591 /* Create buffer registry channel. */
2592 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2597 reg_chan
->consumer_key
= ua_chan
->key
;
2598 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2599 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2601 /* Create and add a channel registry to session. */
2602 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2603 ua_chan
->tracing_channel_id
);
2607 buffer_reg_channel_add(reg_sess
, reg_chan
);
2616 /* Safe because the registry channel object was not added to any HT. */
2617 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2623 * Setup buffer registry channel for the given session registry and application
2624 * channel object. If regp pointer is valid, it's set with the created object.
2626 * Return 0 on success else a negative value.
2628 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2629 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2630 struct ust_app
*app
)
2637 assert(ua_chan
->obj
);
2639 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2641 /* Setup all streams for the registry. */
2642 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2647 reg_chan
->obj
.ust
= ua_chan
->obj
;
2648 ua_chan
->obj
= NULL
;
2653 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2654 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2659 * Send buffer registry channel to the application.
2661 * Return 0 on success else a negative value.
2663 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2664 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2665 struct ust_app_channel
*ua_chan
)
2668 struct buffer_reg_stream
*reg_stream
;
2675 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2677 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2682 /* Send channel to the application. */
2683 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2684 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2685 ret
= -ENOTCONN
; /* Caused by app exiting. */
2687 } else if (ret
< 0) {
2691 health_code_update();
2693 /* Send all streams to application. */
2694 pthread_mutex_lock(®_chan
->stream_list_lock
);
2695 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2696 struct ust_app_stream stream
;
2698 ret
= duplicate_stream_object(reg_stream
, &stream
);
2700 goto error_stream_unlock
;
2703 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2705 (void) release_ust_app_stream(-1, &stream
, app
);
2706 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2707 ret
= -ENOTCONN
; /* Caused by app exiting. */
2708 goto error_stream_unlock
;
2709 } else if (ret
< 0) {
2710 goto error_stream_unlock
;
2712 goto error_stream_unlock
;
2716 * The return value is not important here. This function will output an
2719 (void) release_ust_app_stream(-1, &stream
, app
);
2721 ua_chan
->is_sent
= 1;
2723 error_stream_unlock
:
2724 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2730 * Create and send to the application the created buffers with per UID buffers.
2732 * Return 0 on success else a negative value.
2734 static int create_channel_per_uid(struct ust_app
*app
,
2735 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2736 struct ust_app_channel
*ua_chan
)
2739 struct buffer_reg_uid
*reg_uid
;
2740 struct buffer_reg_channel
*reg_chan
;
2747 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2749 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2751 * The session creation handles the creation of this global registry
2752 * object. If none can be find, there is a code flow problem or a
2757 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2760 /* Create the buffer registry channel object. */
2761 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2763 ERR("Error creating the UST channel \"%s\" registry instance",
2770 * Create the buffers on the consumer side. This call populates the
2771 * ust app channel object with all streams and data object.
2773 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2774 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2776 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2780 * Let's remove the previously created buffer registry channel so
2781 * it's not visible anymore in the session registry.
2783 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2784 ua_chan
->tracing_channel_id
);
2785 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2786 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2791 * Setup the streams and add it to the session registry.
2793 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2794 ua_chan
, reg_chan
, app
);
2796 ERR("Error setting up UST channel \"%s\"",
2803 /* Send buffers to the application. */
2804 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2806 if (ret
!= -ENOTCONN
) {
2807 ERR("Error sending channel to application");
2817 * Create and send to the application the created buffers with per PID buffers.
2819 * Return 0 on success else a negative value.
2821 static int create_channel_per_pid(struct ust_app
*app
,
2822 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2823 struct ust_app_channel
*ua_chan
)
2826 struct ust_registry_session
*registry
;
2833 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2837 registry
= get_session_registry(ua_sess
);
2840 /* Create and add a new channel registry to session. */
2841 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2843 ERR("Error creating the UST channel \"%s\" registry instance",
2848 /* Create and get channel on the consumer side. */
2849 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2850 app
->bits_per_long
, registry
);
2852 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2857 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2859 if (ret
!= -ENOTCONN
) {
2860 ERR("Error sending channel to application");
2871 * From an already allocated ust app channel, create the channel buffers if
2872 * need and send it to the application. This MUST be called with a RCU read
2873 * side lock acquired.
2875 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2876 * the application exited concurrently.
2878 static int do_create_channel(struct ust_app
*app
,
2879 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2880 struct ust_app_channel
*ua_chan
)
2889 /* Handle buffer type before sending the channel to the application. */
2890 switch (usess
->buffer_type
) {
2891 case LTTNG_BUFFER_PER_UID
:
2893 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2899 case LTTNG_BUFFER_PER_PID
:
2901 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2913 /* Initialize ust objd object using the received handle and add it. */
2914 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2915 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2917 /* If channel is not enabled, disable it on the tracer */
2918 if (!ua_chan
->enabled
) {
2919 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2930 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2931 * newly created channel if not NULL.
2933 * Called with UST app session lock and RCU read-side lock held.
2935 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2936 * the application exited concurrently.
2938 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2939 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2940 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2941 struct ust_app_channel
**ua_chanp
)
2944 struct lttng_ht_iter iter
;
2945 struct lttng_ht_node_str
*ua_chan_node
;
2946 struct ust_app_channel
*ua_chan
;
2948 /* Lookup channel in the ust app session */
2949 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2950 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2951 if (ua_chan_node
!= NULL
) {
2952 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2956 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2957 if (ua_chan
== NULL
) {
2958 /* Only malloc can fail here */
2962 shadow_copy_channel(ua_chan
, uchan
);
2964 /* Set channel type. */
2965 ua_chan
->attr
.type
= type
;
2967 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2972 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2975 /* Only add the channel if successful on the tracer side. */
2976 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2980 *ua_chanp
= ua_chan
;
2983 /* Everything went well. */
2987 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2993 * Create UST app event and create it on the tracer side.
2995 * Called with ust app session mutex held.
2998 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2999 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3000 struct ust_app
*app
)
3003 struct ust_app_event
*ua_event
;
3005 /* Get event node */
3006 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3007 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3008 if (ua_event
!= NULL
) {
3013 /* Does not exist so create one */
3014 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3015 if (ua_event
== NULL
) {
3016 /* Only malloc can failed so something is really wrong */
3020 shadow_copy_event(ua_event
, uevent
);
3022 /* Create it on the tracer side */
3023 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3025 /* Not found previously means that it does not exist on the tracer */
3026 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
3030 add_unique_ust_app_event(ua_chan
, ua_event
);
3032 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3039 /* Valid. Calling here is already in a read side lock */
3040 delete_ust_app_event(-1, ua_event
, app
);
3045 * Create UST metadata and open it on the tracer side.
3047 * Called with UST app session lock held and RCU read side lock.
3049 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3050 struct ust_app
*app
, struct consumer_output
*consumer
)
3053 struct ust_app_channel
*metadata
;
3054 struct consumer_socket
*socket
;
3055 struct ust_registry_session
*registry
;
3061 registry
= get_session_registry(ua_sess
);
3064 pthread_mutex_lock(®istry
->lock
);
3066 /* Metadata already exists for this registry or it was closed previously */
3067 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3072 /* Allocate UST metadata */
3073 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3075 /* malloc() failed */
3080 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3082 /* Need one fd for the channel. */
3083 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3085 ERR("Exhausted number of available FD upon create metadata");
3089 /* Get the right consumer socket for the application. */
3090 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3093 goto error_consumer
;
3097 * Keep metadata key so we can identify it on the consumer side. Assign it
3098 * to the registry *before* we ask the consumer so we avoid the race of the
3099 * consumer requesting the metadata and the ask_channel call on our side
3100 * did not returned yet.
3102 registry
->metadata_key
= metadata
->key
;
3105 * Ask the metadata channel creation to the consumer. The metadata object
3106 * will be created by the consumer and kept their. However, the stream is
3107 * never added or monitored until we do a first push metadata to the
3110 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3113 /* Nullify the metadata key so we don't try to close it later on. */
3114 registry
->metadata_key
= 0;
3115 goto error_consumer
;
3119 * The setup command will make the metadata stream be sent to the relayd,
3120 * if applicable, and the thread managing the metadatas. This is important
3121 * because after this point, if an error occurs, the only way the stream
3122 * can be deleted is to be monitored in the consumer.
3124 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3126 /* Nullify the metadata key so we don't try to close it later on. */
3127 registry
->metadata_key
= 0;
3128 goto error_consumer
;
3131 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3132 metadata
->key
, app
->pid
);
3135 lttng_fd_put(LTTNG_FD_APPS
, 1);
3136 delete_ust_app_channel(-1, metadata
, app
);
3138 pthread_mutex_unlock(®istry
->lock
);
3143 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3144 * acquired before calling this function.
3146 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3148 struct ust_app
*app
= NULL
;
3149 struct lttng_ht_node_ulong
*node
;
3150 struct lttng_ht_iter iter
;
3152 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3153 node
= lttng_ht_iter_get_node_ulong(&iter
);
3155 DBG2("UST app no found with pid %d", pid
);
3159 DBG2("Found UST app by pid %d", pid
);
3161 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3168 * Allocate and init an UST app object using the registration information and
3169 * the command socket. This is called when the command socket connects to the
3172 * The object is returned on success or else NULL.
3174 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3176 struct ust_app
*lta
= NULL
;
3181 DBG3("UST app creating application for socket %d", sock
);
3183 if ((msg
->bits_per_long
== 64 &&
3184 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3185 || (msg
->bits_per_long
== 32 &&
3186 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3187 ERR("Registration failed: application \"%s\" (pid: %d) has "
3188 "%d-bit long, but no consumerd for this size is available.\n",
3189 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3193 lta
= zmalloc(sizeof(struct ust_app
));
3199 lta
->ppid
= msg
->ppid
;
3200 lta
->uid
= msg
->uid
;
3201 lta
->gid
= msg
->gid
;
3203 lta
->bits_per_long
= msg
->bits_per_long
;
3204 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3205 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3206 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3207 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3208 lta
->long_alignment
= msg
->long_alignment
;
3209 lta
->byte_order
= msg
->byte_order
;
3211 lta
->v_major
= msg
->major
;
3212 lta
->v_minor
= msg
->minor
;
3213 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3214 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3215 lta
->notify_sock
= -1;
3217 /* Copy name and make sure it's NULL terminated. */
3218 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3219 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3222 * Before this can be called, when receiving the registration information,
3223 * the application compatibility is checked. So, at this point, the
3224 * application can work with this session daemon.
3226 lta
->compatible
= 1;
3228 lta
->pid
= msg
->pid
;
3229 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3231 pthread_mutex_init(<a
->sock_lock
, NULL
);
3232 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3234 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3240 * For a given application object, add it to every hash table.
3242 void ust_app_add(struct ust_app
*app
)
3245 assert(app
->notify_sock
>= 0);
3250 * On a re-registration, we want to kick out the previous registration of
3253 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3256 * The socket _should_ be unique until _we_ call close. So, a add_unique
3257 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3258 * already in the table.
3260 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3262 /* Add application to the notify socket hash table. */
3263 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3264 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3266 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3267 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3268 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3275 * Set the application version into the object.
3277 * Return 0 on success else a negative value either an errno code or a
3278 * LTTng-UST error code.
3280 int ust_app_version(struct ust_app
*app
)
3286 pthread_mutex_lock(&app
->sock_lock
);
3287 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3288 pthread_mutex_unlock(&app
->sock_lock
);
3290 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3291 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3293 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3301 * Unregister app by removing it from the global traceable app list and freeing
3304 * The socket is already closed at this point so no close to sock.
3306 void ust_app_unregister(int sock
)
3308 struct ust_app
*lta
;
3309 struct lttng_ht_node_ulong
*node
;
3310 struct lttng_ht_iter ust_app_sock_iter
;
3311 struct lttng_ht_iter iter
;
3312 struct ust_app_session
*ua_sess
;
3317 /* Get the node reference for a call_rcu */
3318 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3319 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3322 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3323 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3326 * For per-PID buffers, perform "push metadata" and flush all
3327 * application streams before removing app from hash tables,
3328 * ensuring proper behavior of data_pending check.
3329 * Remove sessions so they are not visible during deletion.
3331 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3333 struct ust_registry_session
*registry
;
3335 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3337 /* The session was already removed so scheduled for teardown. */
3341 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3342 (void) ust_app_flush_app_session(lta
, ua_sess
);
3346 * Add session to list for teardown. This is safe since at this point we
3347 * are the only one using this list.
3349 pthread_mutex_lock(&ua_sess
->lock
);
3351 if (ua_sess
->deleted
) {
3352 pthread_mutex_unlock(&ua_sess
->lock
);
3357 * Normally, this is done in the delete session process which is
3358 * executed in the call rcu below. However, upon registration we can't
3359 * afford to wait for the grace period before pushing data or else the
3360 * data pending feature can race between the unregistration and stop
3361 * command where the data pending command is sent *before* the grace
3364 * The close metadata below nullifies the metadata pointer in the
3365 * session so the delete session will NOT push/close a second time.
3367 registry
= get_session_registry(ua_sess
);
3369 /* Push metadata for application before freeing the application. */
3370 (void) push_metadata(registry
, ua_sess
->consumer
);
3373 * Don't ask to close metadata for global per UID buffers. Close
3374 * metadata only on destroy trace session in this case. Also, the
3375 * previous push metadata could have flag the metadata registry to
3376 * close so don't send a close command if closed.
3378 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3379 /* And ask to close it for this session registry. */
3380 (void) close_metadata(registry
, ua_sess
->consumer
);
3383 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3385 pthread_mutex_unlock(&ua_sess
->lock
);
3388 /* Remove application from PID hash table */
3389 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3393 * Remove application from notify hash table. The thread handling the
3394 * notify socket could have deleted the node so ignore on error because
3395 * either way it's valid. The close of that socket is handled by the other
3398 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3399 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3402 * Ignore return value since the node might have been removed before by an
3403 * add replace during app registration because the PID can be reassigned by
3406 iter
.iter
.node
= <a
->pid_n
.node
;
3407 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3409 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3414 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3421 * Fill events array with all events name of all registered apps.
3423 int ust_app_list_events(struct lttng_event
**events
)
3426 size_t nbmem
, count
= 0;
3427 struct lttng_ht_iter iter
;
3428 struct ust_app
*app
;
3429 struct lttng_event
*tmp_event
;
3431 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3432 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3433 if (tmp_event
== NULL
) {
3434 PERROR("zmalloc ust app events");
3441 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3442 struct lttng_ust_tracepoint_iter uiter
;
3444 health_code_update();
3446 if (!app
->compatible
) {
3448 * TODO: In time, we should notice the caller of this error by
3449 * telling him that this is a version error.
3453 pthread_mutex_lock(&app
->sock_lock
);
3454 handle
= ustctl_tracepoint_list(app
->sock
);
3456 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3457 ERR("UST app list events getting handle failed for app pid %d",
3460 pthread_mutex_unlock(&app
->sock_lock
);
3464 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3465 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3466 /* Handle ustctl error. */
3470 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3471 ERR("UST app tp list get failed for app %d with ret %d",
3474 DBG3("UST app tp list get failed. Application is dead");
3476 * This is normal behavior, an application can die during the
3477 * creation process. Don't report an error so the execution can
3478 * continue normally. Continue normal execution.
3483 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3484 if (release_ret
< 0 &&
3485 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3486 release_ret
!= -EPIPE
) {
3487 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3489 pthread_mutex_unlock(&app
->sock_lock
);
3493 health_code_update();
3494 if (count
>= nbmem
) {
3495 /* In case the realloc fails, we free the memory */
3496 struct lttng_event
*new_tmp_event
;
3499 new_nbmem
= nbmem
<< 1;
3500 DBG2("Reallocating event list from %zu to %zu entries",
3502 new_tmp_event
= realloc(tmp_event
,
3503 new_nbmem
* sizeof(struct lttng_event
));
3504 if (new_tmp_event
== NULL
) {
3507 PERROR("realloc ust app events");
3510 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3511 if (release_ret
< 0 &&
3512 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3513 release_ret
!= -EPIPE
) {
3514 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3516 pthread_mutex_unlock(&app
->sock_lock
);
3519 /* Zero the new memory */
3520 memset(new_tmp_event
+ nbmem
, 0,
3521 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3523 tmp_event
= new_tmp_event
;
3525 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3526 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3527 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3528 tmp_event
[count
].pid
= app
->pid
;
3529 tmp_event
[count
].enabled
= -1;
3532 ret
= ustctl_release_handle(app
->sock
, handle
);
3533 pthread_mutex_unlock(&app
->sock_lock
);
3534 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3535 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3540 *events
= tmp_event
;
3542 DBG2("UST app list events done (%zu events)", count
);
3547 health_code_update();
3552 * Fill events array with all events name of all registered apps.
3554 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3557 size_t nbmem
, count
= 0;
3558 struct lttng_ht_iter iter
;
3559 struct ust_app
*app
;
3560 struct lttng_event_field
*tmp_event
;
3562 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3563 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3564 if (tmp_event
== NULL
) {
3565 PERROR("zmalloc ust app event fields");
3572 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3573 struct lttng_ust_field_iter uiter
;
3575 health_code_update();
3577 if (!app
->compatible
) {
3579 * TODO: In time, we should notice the caller of this error by
3580 * telling him that this is a version error.
3584 pthread_mutex_lock(&app
->sock_lock
);
3585 handle
= ustctl_tracepoint_field_list(app
->sock
);
3587 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3588 ERR("UST app list field getting handle failed for app pid %d",
3591 pthread_mutex_unlock(&app
->sock_lock
);
3595 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3596 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3597 /* Handle ustctl error. */
3601 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3602 ERR("UST app tp list field failed for app %d with ret %d",
3605 DBG3("UST app tp list field failed. Application is dead");
3607 * This is normal behavior, an application can die during the
3608 * creation process. Don't report an error so the execution can
3609 * continue normally. Reset list and count for next app.
3614 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3615 pthread_mutex_unlock(&app
->sock_lock
);
3616 if (release_ret
< 0 &&
3617 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3618 release_ret
!= -EPIPE
) {
3619 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3624 health_code_update();
3625 if (count
>= nbmem
) {
3626 /* In case the realloc fails, we free the memory */
3627 struct lttng_event_field
*new_tmp_event
;
3630 new_nbmem
= nbmem
<< 1;
3631 DBG2("Reallocating event field list from %zu to %zu entries",
3633 new_tmp_event
= realloc(tmp_event
,
3634 new_nbmem
* sizeof(struct lttng_event_field
));
3635 if (new_tmp_event
== NULL
) {
3638 PERROR("realloc ust app event fields");
3641 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3642 pthread_mutex_unlock(&app
->sock_lock
);
3644 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3645 release_ret
!= -EPIPE
) {
3646 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3650 /* Zero the new memory */
3651 memset(new_tmp_event
+ nbmem
, 0,
3652 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3654 tmp_event
= new_tmp_event
;
3657 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3658 /* Mapping between these enums matches 1 to 1. */
3659 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3660 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3662 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3663 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3664 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3665 tmp_event
[count
].event
.pid
= app
->pid
;
3666 tmp_event
[count
].event
.enabled
= -1;
3669 ret
= ustctl_release_handle(app
->sock
, handle
);
3670 pthread_mutex_unlock(&app
->sock_lock
);
3672 ret
!= -LTTNG_UST_ERR_EXITING
&&
3674 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3679 *fields
= tmp_event
;
3681 DBG2("UST app list event fields done (%zu events)", count
);
3686 health_code_update();
3691 * Free and clean all traceable apps of the global list.
3693 * Should _NOT_ be called with RCU read-side lock held.
3695 void ust_app_clean_list(void)
3698 struct ust_app
*app
;
3699 struct lttng_ht_iter iter
;
3701 DBG2("UST app cleaning registered apps hash table");
3706 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3707 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3709 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3713 /* Cleanup socket hash table */
3714 if (ust_app_ht_by_sock
) {
3715 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3717 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3722 /* Cleanup notify socket hash table */
3723 if (ust_app_ht_by_notify_sock
) {
3724 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3725 notify_sock_n
.node
) {
3726 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3732 /* Destroy is done only when the ht is empty */
3734 ht_cleanup_push(ust_app_ht
);
3736 if (ust_app_ht_by_sock
) {
3737 ht_cleanup_push(ust_app_ht_by_sock
);
3739 if (ust_app_ht_by_notify_sock
) {
3740 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3745 * Init UST app hash table.
3747 int ust_app_ht_alloc(void)
3749 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3753 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3754 if (!ust_app_ht_by_sock
) {
3757 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3758 if (!ust_app_ht_by_notify_sock
) {
3765 * For a specific UST session, disable the channel for all registered apps.
3767 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3768 struct ltt_ust_channel
*uchan
)
3771 struct lttng_ht_iter iter
;
3772 struct lttng_ht_node_str
*ua_chan_node
;
3773 struct ust_app
*app
;
3774 struct ust_app_session
*ua_sess
;
3775 struct ust_app_channel
*ua_chan
;
3777 if (usess
== NULL
|| uchan
== NULL
) {
3778 ERR("Disabling UST global channel with NULL values");
3783 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3784 uchan
->name
, usess
->id
);
3788 /* For every registered applications */
3789 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3790 struct lttng_ht_iter uiter
;
3791 if (!app
->compatible
) {
3793 * TODO: In time, we should notice the caller of this error by
3794 * telling him that this is a version error.
3798 ua_sess
= lookup_session_by_app(usess
, app
);
3799 if (ua_sess
== NULL
) {
3804 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3805 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3806 /* If the session if found for the app, the channel must be there */
3807 assert(ua_chan_node
);
3809 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3810 /* The channel must not be already disabled */
3811 assert(ua_chan
->enabled
== 1);
3813 /* Disable channel onto application */
3814 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3816 /* XXX: We might want to report this error at some point... */
3828 * For a specific UST session, enable the channel for all registered apps.
3830 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3831 struct ltt_ust_channel
*uchan
)
3834 struct lttng_ht_iter iter
;
3835 struct ust_app
*app
;
3836 struct ust_app_session
*ua_sess
;
3838 if (usess
== NULL
|| uchan
== NULL
) {
3839 ERR("Adding UST global channel to NULL values");
3844 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3845 uchan
->name
, usess
->id
);
3849 /* For every registered applications */
3850 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3851 if (!app
->compatible
) {
3853 * TODO: In time, we should notice the caller of this error by
3854 * telling him that this is a version error.
3858 ua_sess
= lookup_session_by_app(usess
, app
);
3859 if (ua_sess
== NULL
) {
3863 /* Enable channel onto application */
3864 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3866 /* XXX: We might want to report this error at some point... */
3878 * Disable an event in a channel and for a specific session.
3880 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3881 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3884 struct lttng_ht_iter iter
, uiter
;
3885 struct lttng_ht_node_str
*ua_chan_node
;
3886 struct ust_app
*app
;
3887 struct ust_app_session
*ua_sess
;
3888 struct ust_app_channel
*ua_chan
;
3889 struct ust_app_event
*ua_event
;
3891 DBG("UST app disabling event %s for all apps in channel "
3892 "%s for session id %" PRIu64
,
3893 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3897 /* For all registered applications */
3898 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3899 if (!app
->compatible
) {
3901 * TODO: In time, we should notice the caller of this error by
3902 * telling him that this is a version error.
3906 ua_sess
= lookup_session_by_app(usess
, app
);
3907 if (ua_sess
== NULL
) {
3912 /* Lookup channel in the ust app session */
3913 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3914 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3915 if (ua_chan_node
== NULL
) {
3916 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3917 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3920 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3922 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3923 uevent
->filter
, uevent
->attr
.loglevel
,
3925 if (ua_event
== NULL
) {
3926 DBG2("Event %s not found in channel %s for app pid %d."
3927 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3931 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3933 /* XXX: Report error someday... */
3944 * For a specific UST session, create the channel for all registered apps.
3946 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3947 struct ltt_ust_channel
*uchan
)
3949 int ret
= 0, created
;
3950 struct lttng_ht_iter iter
;
3951 struct ust_app
*app
;
3952 struct ust_app_session
*ua_sess
= NULL
;
3954 /* Very wrong code flow */
3958 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3959 uchan
->name
, usess
->id
);
3963 /* For every registered applications */
3964 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3965 if (!app
->compatible
) {
3967 * TODO: In time, we should notice the caller of this error by
3968 * telling him that this is a version error.
3972 if (!trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
3978 * Create session on the tracer side and add it to app session HT. Note
3979 * that if session exist, it will simply return a pointer to the ust
3982 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3987 * The application's socket is not valid. Either a bad socket
3988 * or a timeout on it. We can't inform the caller that for a
3989 * specific app, the session failed so lets continue here.
3991 ret
= 0; /* Not an error. */
3995 goto error_rcu_unlock
;
4000 pthread_mutex_lock(&ua_sess
->lock
);
4002 if (ua_sess
->deleted
) {
4003 pthread_mutex_unlock(&ua_sess
->lock
);
4007 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4008 sizeof(uchan
->name
))) {
4009 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
4012 /* Create channel onto application. We don't need the chan ref. */
4013 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
4014 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
4016 pthread_mutex_unlock(&ua_sess
->lock
);
4018 /* Cleanup the created session if it's the case. */
4020 destroy_app_session(app
, ua_sess
);
4025 * The application's socket is not valid. Either a bad socket
4026 * or a timeout on it. We can't inform the caller that for a
4027 * specific app, the session failed so lets continue here.
4029 ret
= 0; /* Not an error. */
4033 goto error_rcu_unlock
;
4044 * Enable event for a specific session and channel on the tracer.
4046 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4047 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4050 struct lttng_ht_iter iter
, uiter
;
4051 struct lttng_ht_node_str
*ua_chan_node
;
4052 struct ust_app
*app
;
4053 struct ust_app_session
*ua_sess
;
4054 struct ust_app_channel
*ua_chan
;
4055 struct ust_app_event
*ua_event
;
4057 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4058 uevent
->attr
.name
, usess
->id
);
4061 * NOTE: At this point, this function is called only if the session and
4062 * channel passed are already created for all apps. and enabled on the
4068 /* For all registered applications */
4069 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4070 if (!app
->compatible
) {
4072 * TODO: In time, we should notice the caller of this error by
4073 * telling him that this is a version error.
4077 ua_sess
= lookup_session_by_app(usess
, app
);
4079 /* The application has problem or is probably dead. */
4083 pthread_mutex_lock(&ua_sess
->lock
);
4085 if (ua_sess
->deleted
) {
4086 pthread_mutex_unlock(&ua_sess
->lock
);
4090 /* Lookup channel in the ust app session */
4091 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4092 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4094 * It is possible that the channel cannot be found is
4095 * the channel/event creation occurs concurrently with
4096 * an application exit.
4098 if (!ua_chan_node
) {
4099 pthread_mutex_unlock(&ua_sess
->lock
);
4103 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4105 /* Get event node */
4106 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4107 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4108 if (ua_event
== NULL
) {
4109 DBG3("UST app enable event %s not found for app PID %d."
4110 "Skipping app", uevent
->attr
.name
, app
->pid
);
4114 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4116 pthread_mutex_unlock(&ua_sess
->lock
);
4120 pthread_mutex_unlock(&ua_sess
->lock
);
4129 * For a specific existing UST session and UST channel, creates the event for
4130 * all registered apps.
4132 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4133 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4136 struct lttng_ht_iter iter
, uiter
;
4137 struct lttng_ht_node_str
*ua_chan_node
;
4138 struct ust_app
*app
;
4139 struct ust_app_session
*ua_sess
;
4140 struct ust_app_channel
*ua_chan
;
4142 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4143 uevent
->attr
.name
, usess
->id
);
4147 /* For all registered applications */
4148 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4149 if (!app
->compatible
) {
4151 * TODO: In time, we should notice the caller of this error by
4152 * telling him that this is a version error.
4156 ua_sess
= lookup_session_by_app(usess
, app
);
4158 /* The application has problem or is probably dead. */
4162 pthread_mutex_lock(&ua_sess
->lock
);
4164 if (ua_sess
->deleted
) {
4165 pthread_mutex_unlock(&ua_sess
->lock
);
4169 /* Lookup channel in the ust app session */
4170 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4171 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4172 /* If the channel is not found, there is a code flow error */
4173 assert(ua_chan_node
);
4175 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4177 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4178 pthread_mutex_unlock(&ua_sess
->lock
);
4180 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4181 /* Possible value at this point: -ENOMEM. If so, we stop! */
4184 DBG2("UST app event %s already exist on app PID %d",
4185 uevent
->attr
.name
, app
->pid
);
4196 * Start tracing for a specific UST session and app.
4199 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4202 struct ust_app_session
*ua_sess
;
4204 DBG("Starting tracing for ust app pid %d", app
->pid
);
4208 if (!app
->compatible
) {
4212 ua_sess
= lookup_session_by_app(usess
, app
);
4213 if (ua_sess
== NULL
) {
4214 /* The session is in teardown process. Ignore and continue. */
4218 pthread_mutex_lock(&ua_sess
->lock
);
4220 if (ua_sess
->deleted
) {
4221 pthread_mutex_unlock(&ua_sess
->lock
);
4225 /* Upon restart, we skip the setup, already done */
4226 if (ua_sess
->started
) {
4230 /* Create directories if consumer is LOCAL and has a path defined. */
4231 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
4232 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
4233 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
4234 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
4236 if (errno
!= EEXIST
) {
4237 ERR("Trace directory creation error");
4244 * Create the metadata for the application. This returns gracefully if a
4245 * metadata was already set for the session.
4247 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4252 health_code_update();
4255 /* This start the UST tracing */
4256 pthread_mutex_lock(&app
->sock_lock
);
4257 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4258 pthread_mutex_unlock(&app
->sock_lock
);
4260 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4261 ERR("Error starting tracing for app pid: %d (ret: %d)",
4264 DBG("UST app start session failed. Application is dead.");
4266 * This is normal behavior, an application can die during the
4267 * creation process. Don't report an error so the execution can
4268 * continue normally.
4270 pthread_mutex_unlock(&ua_sess
->lock
);
4276 /* Indicate that the session has been started once */
4277 ua_sess
->started
= 1;
4279 pthread_mutex_unlock(&ua_sess
->lock
);
4281 health_code_update();
4283 /* Quiescent wait after starting trace */
4284 pthread_mutex_lock(&app
->sock_lock
);
4285 ret
= ustctl_wait_quiescent(app
->sock
);
4286 pthread_mutex_unlock(&app
->sock_lock
);
4287 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4288 ERR("UST app wait quiescent failed for app pid %d ret %d",
4294 health_code_update();
4298 pthread_mutex_unlock(&ua_sess
->lock
);
4300 health_code_update();
4305 * Stop tracing for a specific UST session and app.
4308 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4311 struct ust_app_session
*ua_sess
;
4312 struct ust_registry_session
*registry
;
4314 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4318 if (!app
->compatible
) {
4319 goto end_no_session
;
4322 ua_sess
= lookup_session_by_app(usess
, app
);
4323 if (ua_sess
== NULL
) {
4324 goto end_no_session
;
4327 pthread_mutex_lock(&ua_sess
->lock
);
4329 if (ua_sess
->deleted
) {
4330 pthread_mutex_unlock(&ua_sess
->lock
);
4331 goto end_no_session
;
4335 * If started = 0, it means that stop trace has been called for a session
4336 * that was never started. It's possible since we can have a fail start
4337 * from either the application manager thread or the command thread. Simply
4338 * indicate that this is a stop error.
4340 if (!ua_sess
->started
) {
4341 goto error_rcu_unlock
;
4344 health_code_update();
4346 /* This inhibits UST tracing */
4347 pthread_mutex_lock(&app
->sock_lock
);
4348 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4349 pthread_mutex_unlock(&app
->sock_lock
);
4351 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4352 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4355 DBG("UST app stop session failed. Application is dead.");
4357 * This is normal behavior, an application can die during the
4358 * creation process. Don't report an error so the execution can
4359 * continue normally.
4363 goto error_rcu_unlock
;
4366 health_code_update();
4368 /* Quiescent wait after stopping trace */
4369 pthread_mutex_lock(&app
->sock_lock
);
4370 ret
= ustctl_wait_quiescent(app
->sock
);
4371 pthread_mutex_unlock(&app
->sock_lock
);
4372 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4373 ERR("UST app wait quiescent failed for app pid %d ret %d",
4377 health_code_update();
4379 registry
= get_session_registry(ua_sess
);
4382 /* Push metadata for application before freeing the application. */
4383 (void) push_metadata(registry
, ua_sess
->consumer
);
4386 pthread_mutex_unlock(&ua_sess
->lock
);
4389 health_code_update();
4393 pthread_mutex_unlock(&ua_sess
->lock
);
4395 health_code_update();
4400 int ust_app_flush_app_session(struct ust_app
*app
,
4401 struct ust_app_session
*ua_sess
)
4403 int ret
, retval
= 0;
4404 struct lttng_ht_iter iter
;
4405 struct ust_app_channel
*ua_chan
;
4406 struct consumer_socket
*socket
;
4408 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4412 if (!app
->compatible
) {
4413 goto end_not_compatible
;
4416 pthread_mutex_lock(&ua_sess
->lock
);
4418 if (ua_sess
->deleted
) {
4422 health_code_update();
4424 /* Flushing buffers */
4425 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4428 /* Flush buffers and push metadata. */
4429 switch (ua_sess
->buffer_type
) {
4430 case LTTNG_BUFFER_PER_PID
:
4431 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4433 health_code_update();
4434 assert(ua_chan
->is_sent
);
4435 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4437 ERR("Error flushing consumer channel");
4443 case LTTNG_BUFFER_PER_UID
:
4449 health_code_update();
4452 pthread_mutex_unlock(&ua_sess
->lock
);
4456 health_code_update();
4461 * Flush buffers for all applications for a specific UST session.
4462 * Called with UST session lock held.
4465 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4470 DBG("Flushing session buffers for all ust apps");
4474 /* Flush buffers and push metadata. */
4475 switch (usess
->buffer_type
) {
4476 case LTTNG_BUFFER_PER_UID
:
4478 struct buffer_reg_uid
*reg
;
4479 struct lttng_ht_iter iter
;
4481 /* Flush all per UID buffers associated to that session. */
4482 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4483 struct ust_registry_session
*ust_session_reg
;
4484 struct buffer_reg_channel
*reg_chan
;
4485 struct consumer_socket
*socket
;
4487 /* Get consumer socket to use to push the metadata.*/
4488 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4491 /* Ignore request if no consumer is found for the session. */
4495 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4496 reg_chan
, node
.node
) {
4498 * The following call will print error values so the return
4499 * code is of little importance because whatever happens, we
4500 * have to try them all.
4502 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4505 ust_session_reg
= reg
->registry
->reg
.ust
;
4506 /* Push metadata. */
4507 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4511 case LTTNG_BUFFER_PER_PID
:
4513 struct ust_app_session
*ua_sess
;
4514 struct lttng_ht_iter iter
;
4515 struct ust_app
*app
;
4517 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4518 ua_sess
= lookup_session_by_app(usess
, app
);
4519 if (ua_sess
== NULL
) {
4522 (void) ust_app_flush_app_session(app
, ua_sess
);
4533 health_code_update();
4538 * Destroy a specific UST session in apps.
4540 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4543 struct ust_app_session
*ua_sess
;
4544 struct lttng_ht_iter iter
;
4545 struct lttng_ht_node_u64
*node
;
4547 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4551 if (!app
->compatible
) {
4555 __lookup_session_by_app(usess
, app
, &iter
);
4556 node
= lttng_ht_iter_get_node_u64(&iter
);
4558 /* Session is being or is deleted. */
4561 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4563 health_code_update();
4564 destroy_app_session(app
, ua_sess
);
4566 health_code_update();
4568 /* Quiescent wait after stopping trace */
4569 pthread_mutex_lock(&app
->sock_lock
);
4570 ret
= ustctl_wait_quiescent(app
->sock
);
4571 pthread_mutex_unlock(&app
->sock_lock
);
4572 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4573 ERR("UST app wait quiescent failed for app pid %d ret %d",
4578 health_code_update();
4583 * Start tracing for the UST session.
4585 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4588 struct lttng_ht_iter iter
;
4589 struct ust_app
*app
;
4591 DBG("Starting all UST traces");
4595 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4596 ret
= ust_app_start_trace(usess
, app
);
4598 /* Continue to next apps even on error */
4609 * Start tracing for the UST session.
4610 * Called with UST session lock held.
4612 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4615 struct lttng_ht_iter iter
;
4616 struct ust_app
*app
;
4618 DBG("Stopping all UST traces");
4622 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4623 ret
= ust_app_stop_trace(usess
, app
);
4625 /* Continue to next apps even on error */
4630 (void) ust_app_flush_session(usess
);
4638 * Destroy app UST session.
4640 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4643 struct lttng_ht_iter iter
;
4644 struct ust_app
*app
;
4646 DBG("Destroy all UST traces");
4650 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4651 ret
= destroy_trace(usess
, app
);
4653 /* Continue to next apps even on error */
4664 void ust_app_global_create(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4667 struct lttng_ht_iter iter
, uiter
;
4668 struct ust_app_session
*ua_sess
= NULL
;
4669 struct ust_app_channel
*ua_chan
;
4670 struct ust_app_event
*ua_event
;
4671 struct ust_app_ctx
*ua_ctx
;
4674 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &is_created
);
4676 /* Tracer is probably gone or ENOMEM. */
4680 /* App session already created. */
4685 pthread_mutex_lock(&ua_sess
->lock
);
4687 if (ua_sess
->deleted
) {
4688 pthread_mutex_unlock(&ua_sess
->lock
);
4693 * We can iterate safely here over all UST app session since the create ust
4694 * app session above made a shadow copy of the UST global domain from the
4697 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4699 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4700 if (ret
< 0 && ret
!= -ENOTCONN
) {
4702 * Stop everything. On error, the application
4703 * failed, no more file descriptor are available
4704 * or ENOMEM so stopping here is the only thing
4705 * we can do for now. The only exception is
4706 * -ENOTCONN, which indicates that the application
4713 * Add context using the list so they are enabled in the same order the
4716 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4717 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4724 /* For each events */
4725 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4727 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4734 pthread_mutex_unlock(&ua_sess
->lock
);
4736 if (usess
->active
) {
4737 ret
= ust_app_start_trace(usess
, app
);
4742 DBG2("UST trace started for app pid %d", app
->pid
);
4745 /* Everything went well at this point. */
4749 pthread_mutex_unlock(&ua_sess
->lock
);
4752 destroy_app_session(app
, ua_sess
);
4758 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4760 struct ust_app_session
*ua_sess
;
4762 ua_sess
= lookup_session_by_app(usess
, app
);
4763 if (ua_sess
== NULL
) {
4766 destroy_app_session(app
, ua_sess
);
4770 * Add channels/events from UST global domain to registered apps at sock.
4772 * Called with session lock held.
4773 * Called with RCU read-side lock held.
4775 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4779 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
4780 app
->sock
, usess
->id
);
4782 if (!app
->compatible
) {
4786 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4787 ust_app_global_create(usess
, app
);
4789 ust_app_global_destroy(usess
, app
);
4794 * Called with session lock held.
4796 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
4798 struct lttng_ht_iter iter
;
4799 struct ust_app
*app
;
4802 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4803 ust_app_global_update(usess
, app
);
4809 * Add context to a specific channel for global UST domain.
4811 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4812 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4815 struct lttng_ht_node_str
*ua_chan_node
;
4816 struct lttng_ht_iter iter
, uiter
;
4817 struct ust_app_channel
*ua_chan
= NULL
;
4818 struct ust_app_session
*ua_sess
;
4819 struct ust_app
*app
;
4823 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4824 if (!app
->compatible
) {
4826 * TODO: In time, we should notice the caller of this error by
4827 * telling him that this is a version error.
4831 ua_sess
= lookup_session_by_app(usess
, app
);
4832 if (ua_sess
== NULL
) {
4836 pthread_mutex_lock(&ua_sess
->lock
);
4838 if (ua_sess
->deleted
) {
4839 pthread_mutex_unlock(&ua_sess
->lock
);
4843 /* Lookup channel in the ust app session */
4844 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4845 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4846 if (ua_chan_node
== NULL
) {
4849 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4851 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4856 pthread_mutex_unlock(&ua_sess
->lock
);
4864 * Enable event for a channel from a UST session for a specific PID.
4866 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4867 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4870 struct lttng_ht_iter iter
;
4871 struct lttng_ht_node_str
*ua_chan_node
;
4872 struct ust_app
*app
;
4873 struct ust_app_session
*ua_sess
;
4874 struct ust_app_channel
*ua_chan
;
4875 struct ust_app_event
*ua_event
;
4877 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4881 app
= ust_app_find_by_pid(pid
);
4883 ERR("UST app enable event per PID %d not found", pid
);
4888 if (!app
->compatible
) {
4893 ua_sess
= lookup_session_by_app(usess
, app
);
4895 /* The application has problem or is probably dead. */
4900 pthread_mutex_lock(&ua_sess
->lock
);
4902 if (ua_sess
->deleted
) {
4907 /* Lookup channel in the ust app session */
4908 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4909 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4910 /* If the channel is not found, there is a code flow error */
4911 assert(ua_chan_node
);
4913 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4915 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4916 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4917 if (ua_event
== NULL
) {
4918 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4923 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4930 pthread_mutex_unlock(&ua_sess
->lock
);
4937 * Calibrate registered applications.
4939 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4942 struct lttng_ht_iter iter
;
4943 struct ust_app
*app
;
4947 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4948 if (!app
->compatible
) {
4950 * TODO: In time, we should notice the caller of this error by
4951 * telling him that this is a version error.
4956 health_code_update();
4958 pthread_mutex_lock(&app
->sock_lock
);
4959 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4960 pthread_mutex_unlock(&app
->sock_lock
);
4964 /* Means that it's not implemented on the tracer side. */
4968 DBG2("Calibrate app PID %d returned with error %d",
4975 DBG("UST app global domain calibration finished");
4979 health_code_update();
4985 * Receive registration and populate the given msg structure.
4987 * On success return 0 else a negative value returned by the ustctl call.
4989 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4992 uint32_t pid
, ppid
, uid
, gid
;
4996 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4997 &pid
, &ppid
, &uid
, &gid
,
4998 &msg
->bits_per_long
,
4999 &msg
->uint8_t_alignment
,
5000 &msg
->uint16_t_alignment
,
5001 &msg
->uint32_t_alignment
,
5002 &msg
->uint64_t_alignment
,
5003 &msg
->long_alignment
,
5010 case LTTNG_UST_ERR_EXITING
:
5011 DBG3("UST app recv reg message failed. Application died");
5013 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5014 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5015 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5016 LTTNG_UST_ABI_MINOR_VERSION
);
5019 ERR("UST app recv reg message failed with ret %d", ret
);
5024 msg
->pid
= (pid_t
) pid
;
5025 msg
->ppid
= (pid_t
) ppid
;
5026 msg
->uid
= (uid_t
) uid
;
5027 msg
->gid
= (gid_t
) gid
;
5034 * Return a ust app channel object using the application object and the channel
5035 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5036 * lock MUST be acquired before calling this function.
5038 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5041 struct lttng_ht_node_ulong
*node
;
5042 struct lttng_ht_iter iter
;
5043 struct ust_app_channel
*ua_chan
= NULL
;
5047 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5048 node
= lttng_ht_iter_get_node_ulong(&iter
);
5050 DBG2("UST app channel find by objd %d not found", objd
);
5054 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5061 * Reply to a register channel notification from an application on the notify
5062 * socket. The channel metadata is also created.
5064 * The session UST registry lock is acquired in this function.
5066 * On success 0 is returned else a negative value.
5068 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
5069 size_t nr_fields
, struct ustctl_field
*fields
)
5071 int ret
, ret_code
= 0;
5072 uint32_t chan_id
, reg_count
;
5073 uint64_t chan_reg_key
;
5074 enum ustctl_channel_header type
;
5075 struct ust_app
*app
;
5076 struct ust_app_channel
*ua_chan
;
5077 struct ust_app_session
*ua_sess
;
5078 struct ust_registry_session
*registry
;
5079 struct ust_registry_channel
*chan_reg
;
5083 /* Lookup application. If not found, there is a code flow error. */
5084 app
= find_app_by_notify_sock(sock
);
5086 DBG("Application socket %d is being teardown. Abort event notify",
5090 goto error_rcu_unlock
;
5093 /* Lookup channel by UST object descriptor. */
5094 ua_chan
= find_channel_by_objd(app
, cobjd
);
5096 DBG("Application channel is being teardown. Abort event notify");
5099 goto error_rcu_unlock
;
5102 assert(ua_chan
->session
);
5103 ua_sess
= ua_chan
->session
;
5105 /* Get right session registry depending on the session buffer type. */
5106 registry
= get_session_registry(ua_sess
);
5109 /* Depending on the buffer type, a different channel key is used. */
5110 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5111 chan_reg_key
= ua_chan
->tracing_channel_id
;
5113 chan_reg_key
= ua_chan
->key
;
5116 pthread_mutex_lock(®istry
->lock
);
5118 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5121 if (!chan_reg
->register_done
) {
5122 reg_count
= ust_registry_get_event_count(chan_reg
);
5123 if (reg_count
< 31) {
5124 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
5126 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5129 chan_reg
->nr_ctx_fields
= nr_fields
;
5130 chan_reg
->ctx_fields
= fields
;
5131 chan_reg
->header_type
= type
;
5133 /* Get current already assigned values. */
5134 type
= chan_reg
->header_type
;
5136 /* Set to NULL so the error path does not do a double free. */
5139 /* Channel id is set during the object creation. */
5140 chan_id
= chan_reg
->chan_id
;
5142 /* Append to metadata */
5143 if (!chan_reg
->metadata_dumped
) {
5144 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5146 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5152 DBG3("UST app replying to register channel key %" PRIu64
5153 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5156 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5158 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5159 ERR("UST app reply channel failed with ret %d", ret
);
5161 DBG3("UST app reply channel failed. Application died");
5166 /* This channel registry registration is completed. */
5167 chan_reg
->register_done
= 1;
5170 pthread_mutex_unlock(®istry
->lock
);
5180 * Add event to the UST channel registry. When the event is added to the
5181 * registry, the metadata is also created. Once done, this replies to the
5182 * application with the appropriate error code.
5184 * The session UST registry lock is acquired in the function.
5186 * On success 0 is returned else a negative value.
5188 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5189 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5190 int loglevel_value
, char *model_emf_uri
)
5193 uint32_t event_id
= 0;
5194 uint64_t chan_reg_key
;
5195 struct ust_app
*app
;
5196 struct ust_app_channel
*ua_chan
;
5197 struct ust_app_session
*ua_sess
;
5198 struct ust_registry_session
*registry
;
5202 /* Lookup application. If not found, there is a code flow error. */
5203 app
= find_app_by_notify_sock(sock
);
5205 DBG("Application socket %d is being teardown. Abort event notify",
5210 free(model_emf_uri
);
5211 goto error_rcu_unlock
;
5214 /* Lookup channel by UST object descriptor. */
5215 ua_chan
= find_channel_by_objd(app
, cobjd
);
5217 DBG("Application channel is being teardown. Abort event notify");
5221 free(model_emf_uri
);
5222 goto error_rcu_unlock
;
5225 assert(ua_chan
->session
);
5226 ua_sess
= ua_chan
->session
;
5228 registry
= get_session_registry(ua_sess
);
5231 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5232 chan_reg_key
= ua_chan
->tracing_channel_id
;
5234 chan_reg_key
= ua_chan
->key
;
5237 pthread_mutex_lock(®istry
->lock
);
5240 * From this point on, this call acquires the ownership of the sig, fields
5241 * and model_emf_uri meaning any free are done inside it if needed. These
5242 * three variables MUST NOT be read/write after this.
5244 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5245 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5246 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5250 * The return value is returned to ustctl so in case of an error, the
5251 * application can be notified. In case of an error, it's important not to
5252 * return a negative error or else the application will get closed.
5254 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5256 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5257 ERR("UST app reply event failed with ret %d", ret
);
5259 DBG3("UST app reply event failed. Application died");
5262 * No need to wipe the create event since the application socket will
5263 * get close on error hence cleaning up everything by itself.
5268 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5272 pthread_mutex_unlock(®istry
->lock
);
5279 * Handle application notification through the given notify socket.
5281 * Return 0 on success or else a negative value.
5283 int ust_app_recv_notify(int sock
)
5286 enum ustctl_notify_cmd cmd
;
5288 DBG3("UST app receiving notify from sock %d", sock
);
5290 ret
= ustctl_recv_notify(sock
, &cmd
);
5292 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5293 ERR("UST app recv notify failed with ret %d", ret
);
5295 DBG3("UST app recv notify failed. Application died");
5301 case USTCTL_NOTIFY_CMD_EVENT
:
5303 int sobjd
, cobjd
, loglevel_value
;
5304 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5306 struct ustctl_field
*fields
;
5308 DBG2("UST app ustctl register event received");
5310 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5311 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5314 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5315 ERR("UST app recv event failed with ret %d", ret
);
5317 DBG3("UST app recv event failed. Application died");
5323 * Add event to the UST registry coming from the notify socket. This
5324 * call will free if needed the sig, fields and model_emf_uri. This
5325 * code path loses the ownsership of these variables and transfer them
5326 * to the this function.
5328 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5329 fields
, loglevel_value
, model_emf_uri
);
5336 case USTCTL_NOTIFY_CMD_CHANNEL
:
5340 struct ustctl_field
*fields
;
5342 DBG2("UST app ustctl register channel received");
5344 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5347 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5348 ERR("UST app recv channel failed with ret %d", ret
);
5350 DBG3("UST app recv channel failed. Application died");
5356 * The fields ownership are transfered to this function call meaning
5357 * that if needed it will be freed. After this, it's invalid to access
5358 * fields or clean it up.
5360 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
5369 /* Should NEVER happen. */
5378 * Once the notify socket hangs up, this is called. First, it tries to find the
5379 * corresponding application. On failure, the call_rcu to close the socket is
5380 * executed. If an application is found, it tries to delete it from the notify
5381 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5383 * Note that an object needs to be allocated here so on ENOMEM failure, the
5384 * call RCU is not done but the rest of the cleanup is.
5386 void ust_app_notify_sock_unregister(int sock
)
5389 struct lttng_ht_iter iter
;
5390 struct ust_app
*app
;
5391 struct ust_app_notify_sock_obj
*obj
;
5397 obj
= zmalloc(sizeof(*obj
));
5400 * An ENOMEM is kind of uncool. If this strikes we continue the
5401 * procedure but the call_rcu will not be called. In this case, we
5402 * accept the fd leak rather than possibly creating an unsynchronized
5403 * state between threads.
5405 * TODO: The notify object should be created once the notify socket is
5406 * registered and stored independantely from the ust app object. The
5407 * tricky part is to synchronize the teardown of the application and
5408 * this notify object. Let's keep that in mind so we can avoid this
5409 * kind of shenanigans with ENOMEM in the teardown path.
5416 DBG("UST app notify socket unregister %d", sock
);
5419 * Lookup application by notify socket. If this fails, this means that the
5420 * hash table delete has already been done by the application
5421 * unregistration process so we can safely close the notify socket in a
5424 app
= find_app_by_notify_sock(sock
);
5429 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5432 * Whatever happens here either we fail or succeed, in both cases we have
5433 * to close the socket after a grace period to continue to the call RCU
5434 * here. If the deletion is successful, the application is not visible
5435 * anymore by other threads and is it fails it means that it was already
5436 * deleted from the hash table so either way we just have to close the
5439 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5445 * Close socket after a grace period to avoid for the socket to be reused
5446 * before the application object is freed creating potential race between
5447 * threads trying to add unique in the global hash table.
5450 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5455 * Destroy a ust app data structure and free its memory.
5457 void ust_app_destroy(struct ust_app
*app
)
5463 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5467 * Take a snapshot for a given UST session. The snapshot is sent to the given
5470 * Return 0 on success or else a negative value.
5472 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5473 struct snapshot_output
*output
, int wait
,
5474 uint64_t nb_packets_per_stream
)
5477 unsigned int snapshot_done
= 0;
5478 struct lttng_ht_iter iter
;
5479 struct ust_app
*app
;
5480 char pathname
[PATH_MAX
];
5487 switch (usess
->buffer_type
) {
5488 case LTTNG_BUFFER_PER_UID
:
5490 struct buffer_reg_uid
*reg
;
5492 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5493 struct buffer_reg_channel
*reg_chan
;
5494 struct consumer_socket
*socket
;
5496 /* Get consumer socket to use to push the metadata.*/
5497 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5504 memset(pathname
, 0, sizeof(pathname
));
5505 ret
= snprintf(pathname
, sizeof(pathname
),
5506 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5507 reg
->uid
, reg
->bits_per_long
);
5509 PERROR("snprintf snapshot path");
5513 /* Add the UST default trace dir to path. */
5514 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5515 reg_chan
, node
.node
) {
5516 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5517 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5518 nb_packets_per_stream
);
5523 ret
= consumer_snapshot_channel(socket
,
5524 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5525 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5533 case LTTNG_BUFFER_PER_PID
:
5535 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5536 struct consumer_socket
*socket
;
5537 struct lttng_ht_iter chan_iter
;
5538 struct ust_app_channel
*ua_chan
;
5539 struct ust_app_session
*ua_sess
;
5540 struct ust_registry_session
*registry
;
5542 ua_sess
= lookup_session_by_app(usess
, app
);
5544 /* Session not associated with this app. */
5548 /* Get the right consumer socket for the application. */
5549 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5556 /* Add the UST default trace dir to path. */
5557 memset(pathname
, 0, sizeof(pathname
));
5558 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5561 PERROR("snprintf snapshot path");
5565 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5566 ua_chan
, node
.node
) {
5567 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5568 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5569 nb_packets_per_stream
);
5575 registry
= get_session_registry(ua_sess
);
5577 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5578 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5591 if (!snapshot_done
) {
5593 * If no snapshot was made and we are not in the error path, this means
5594 * that there are no buffers thus no (prior) application to snapshot
5595 * data from so we have simply NO data.
5606 * Return the size taken by one more packet per stream.
5608 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5609 uint64_t cur_nr_packets
)
5611 uint64_t tot_size
= 0;
5612 struct ust_app
*app
;
5613 struct lttng_ht_iter iter
;
5617 switch (usess
->buffer_type
) {
5618 case LTTNG_BUFFER_PER_UID
:
5620 struct buffer_reg_uid
*reg
;
5622 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5623 struct buffer_reg_channel
*reg_chan
;
5626 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5627 reg_chan
, node
.node
) {
5628 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5630 * Don't take channel into account if we
5631 * already grab all its packets.
5635 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5641 case LTTNG_BUFFER_PER_PID
:
5644 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5645 struct ust_app_channel
*ua_chan
;
5646 struct ust_app_session
*ua_sess
;
5647 struct lttng_ht_iter chan_iter
;
5649 ua_sess
= lookup_session_by_app(usess
, app
);
5651 /* Session not associated with this app. */
5655 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5656 ua_chan
, node
.node
) {
5657 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5659 * Don't take channel into account if we
5660 * already grab all its packets.
5664 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;