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",
794 /* Remove session from application UST object descriptor. */
795 iter
.iter
.node
= &ua_sess
->ust_objd_node
.node
;
796 ret
= lttng_ht_del(app
->ust_sessions_objd
, &iter
);
800 pthread_mutex_unlock(&ua_sess
->lock
);
802 consumer_output_put(ua_sess
->consumer
);
804 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
808 * Delete a traceable application structure from the global list. Never call
809 * this function outside of a call_rcu call.
811 * RCU read side lock should _NOT_ be held when calling this function.
814 void delete_ust_app(struct ust_app
*app
)
817 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
819 /* Delete ust app sessions info */
824 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
826 /* Free every object in the session and the session. */
828 delete_ust_app_session(sock
, ua_sess
, app
);
832 ht_cleanup_push(app
->sessions
);
833 ht_cleanup_push(app
->ust_sessions_objd
);
834 ht_cleanup_push(app
->ust_objd
);
837 * Wait until we have deleted the application from the sock hash table
838 * before closing this socket, otherwise an application could re-use the
839 * socket ID and race with the teardown, using the same hash table entry.
841 * It's OK to leave the close in call_rcu. We want it to stay unique for
842 * all RCU readers that could run concurrently with unregister app,
843 * therefore we _need_ to only close that socket after a grace period. So
844 * it should stay in this RCU callback.
846 * This close() is a very important step of the synchronization model so
847 * every modification to this function must be carefully reviewed.
853 lttng_fd_put(LTTNG_FD_APPS
, 1);
855 DBG2("UST app pid %d deleted", app
->pid
);
860 * URCU intermediate call to delete an UST app.
863 void delete_ust_app_rcu(struct rcu_head
*head
)
865 struct lttng_ht_node_ulong
*node
=
866 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
867 struct ust_app
*app
=
868 caa_container_of(node
, struct ust_app
, pid_n
);
870 DBG3("Call RCU deleting app PID %d", app
->pid
);
875 * Delete the session from the application ht and delete the data structure by
876 * freeing every object inside and releasing them.
878 static void destroy_app_session(struct ust_app
*app
,
879 struct ust_app_session
*ua_sess
)
882 struct lttng_ht_iter iter
;
887 iter
.iter
.node
= &ua_sess
->node
.node
;
888 ret
= lttng_ht_del(app
->sessions
, &iter
);
890 /* Already scheduled for teardown. */
894 /* Once deleted, free the data structure. */
895 delete_ust_app_session(app
->sock
, ua_sess
, app
);
902 * Alloc new UST app session.
905 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
907 struct ust_app_session
*ua_sess
;
909 /* Init most of the default value by allocating and zeroing */
910 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
911 if (ua_sess
== NULL
) {
916 ua_sess
->handle
= -1;
917 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
918 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
919 pthread_mutex_init(&ua_sess
->lock
, NULL
);
928 * Alloc new UST app channel.
931 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
932 struct ust_app_session
*ua_sess
,
933 struct lttng_ust_channel_attr
*attr
)
935 struct ust_app_channel
*ua_chan
;
937 /* Init most of the default value by allocating and zeroing */
938 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
939 if (ua_chan
== NULL
) {
944 /* Setup channel name */
945 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
946 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
948 ua_chan
->enabled
= 1;
949 ua_chan
->handle
= -1;
950 ua_chan
->session
= ua_sess
;
951 ua_chan
->key
= get_next_channel_key();
952 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
953 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
954 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
956 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
957 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
959 /* Copy attributes */
961 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
962 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
963 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
964 ua_chan
->attr
.overwrite
= attr
->overwrite
;
965 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
966 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
967 ua_chan
->attr
.output
= attr
->output
;
969 /* By default, the channel is a per cpu channel. */
970 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
972 DBG3("UST app channel %s allocated", ua_chan
->name
);
981 * Allocate and initialize a UST app stream.
983 * Return newly allocated stream pointer or NULL on error.
985 struct ust_app_stream
*ust_app_alloc_stream(void)
987 struct ust_app_stream
*stream
= NULL
;
989 stream
= zmalloc(sizeof(*stream
));
990 if (stream
== NULL
) {
991 PERROR("zmalloc ust app stream");
995 /* Zero could be a valid value for a handle so flag it to -1. */
1003 * Alloc new UST app event.
1006 struct ust_app_event
*alloc_ust_app_event(char *name
,
1007 struct lttng_ust_event
*attr
)
1009 struct ust_app_event
*ua_event
;
1011 /* Init most of the default value by allocating and zeroing */
1012 ua_event
= zmalloc(sizeof(struct ust_app_event
));
1013 if (ua_event
== NULL
) {
1018 ua_event
->enabled
= 1;
1019 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
1020 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1021 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
1023 /* Copy attributes */
1025 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
1028 DBG3("UST app event %s allocated", ua_event
->name
);
1037 * Alloc new UST app context.
1040 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
1042 struct ust_app_ctx
*ua_ctx
;
1044 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
1045 if (ua_ctx
== NULL
) {
1049 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
1052 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
1055 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
1062 * Allocate a filter and copy the given original filter.
1064 * Return allocated filter or NULL on error.
1066 static struct lttng_filter_bytecode
*copy_filter_bytecode(
1067 struct lttng_filter_bytecode
*orig_f
)
1069 struct lttng_filter_bytecode
*filter
= NULL
;
1071 /* Copy filter bytecode */
1072 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1074 PERROR("zmalloc alloc filter bytecode");
1078 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1085 * Create a liblttng-ust filter bytecode from given bytecode.
1087 * Return allocated filter or NULL on error.
1089 static struct lttng_ust_filter_bytecode
*create_ust_bytecode_from_bytecode(
1090 struct lttng_filter_bytecode
*orig_f
)
1092 struct lttng_ust_filter_bytecode
*filter
= NULL
;
1094 /* Copy filter bytecode */
1095 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
1097 PERROR("zmalloc alloc ust filter bytecode");
1101 assert(sizeof(struct lttng_filter_bytecode
) ==
1102 sizeof(struct lttng_ust_filter_bytecode
));
1103 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1109 * Find an ust_app using the sock and return it. RCU read side lock must be
1110 * held before calling this helper function.
1112 struct ust_app
*ust_app_find_by_sock(int sock
)
1114 struct lttng_ht_node_ulong
*node
;
1115 struct lttng_ht_iter iter
;
1117 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1118 node
= lttng_ht_iter_get_node_ulong(&iter
);
1120 DBG2("UST app find by sock %d not found", sock
);
1124 return caa_container_of(node
, struct ust_app
, sock_n
);
1131 * Find an ust_app using the notify sock and return it. RCU read side lock must
1132 * be held before calling this helper function.
1134 static struct ust_app
*find_app_by_notify_sock(int sock
)
1136 struct lttng_ht_node_ulong
*node
;
1137 struct lttng_ht_iter iter
;
1139 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1141 node
= lttng_ht_iter_get_node_ulong(&iter
);
1143 DBG2("UST app find by notify sock %d not found", sock
);
1147 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1154 * Lookup for an ust app event based on event name, filter bytecode and the
1157 * Return an ust_app_event object or NULL on error.
1159 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1160 char *name
, struct lttng_filter_bytecode
*filter
,
1162 const struct lttng_event_exclusion
*exclusion
)
1164 struct lttng_ht_iter iter
;
1165 struct lttng_ht_node_str
*node
;
1166 struct ust_app_event
*event
= NULL
;
1167 struct ust_app_ht_key key
;
1172 /* Setup key for event lookup. */
1174 key
.filter
= filter
;
1175 key
.loglevel_type
= loglevel_value
;
1176 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1177 key
.exclusion
= exclusion
;
1179 /* Lookup using the event name as hash and a custom match fct. */
1180 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1181 ht_match_ust_app_event
, &key
, &iter
.iter
);
1182 node
= lttng_ht_iter_get_node_str(&iter
);
1187 event
= caa_container_of(node
, struct ust_app_event
, node
);
1194 * Create the channel context on the tracer.
1196 * Called with UST app session lock held.
1199 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1200 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1204 health_code_update();
1206 pthread_mutex_lock(&app
->sock_lock
);
1207 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1208 ua_chan
->obj
, &ua_ctx
->obj
);
1209 pthread_mutex_unlock(&app
->sock_lock
);
1211 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1212 ERR("UST app create channel context failed for app (pid: %d) "
1213 "with ret %d", app
->pid
, ret
);
1216 * This is normal behavior, an application can die during the
1217 * creation process. Don't report an error so the execution can
1218 * continue normally.
1221 DBG3("UST app disable event failed. Application is dead.");
1226 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1228 DBG2("UST app context handle %d created successfully for channel %s",
1229 ua_ctx
->handle
, ua_chan
->name
);
1232 health_code_update();
1237 * Set the filter on the tracer.
1240 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1241 struct ust_app
*app
)
1244 struct lttng_ust_filter_bytecode
*ust_bytecode
= NULL
;
1246 health_code_update();
1248 if (!ua_event
->filter
) {
1253 ust_bytecode
= create_ust_bytecode_from_bytecode(ua_event
->filter
);
1254 if (!ust_bytecode
) {
1255 ret
= -LTTNG_ERR_NOMEM
;
1258 pthread_mutex_lock(&app
->sock_lock
);
1259 ret
= ustctl_set_filter(app
->sock
, ust_bytecode
,
1261 pthread_mutex_unlock(&app
->sock_lock
);
1263 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1264 ERR("UST app event %s filter failed for app (pid: %d) "
1265 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1268 * This is normal behavior, an application can die during the
1269 * creation process. Don't report an error so the execution can
1270 * continue normally.
1273 DBG3("UST app filter event failed. Application is dead.");
1278 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1281 health_code_update();
1287 struct lttng_ust_event_exclusion
*create_ust_exclusion_from_exclusion(
1288 struct lttng_event_exclusion
*exclusion
)
1290 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1291 size_t exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1292 LTTNG_UST_SYM_NAME_LEN
* exclusion
->count
;
1294 ust_exclusion
= zmalloc(exclusion_alloc_size
);
1295 if (!ust_exclusion
) {
1300 assert(sizeof(struct lttng_event_exclusion
) ==
1301 sizeof(struct lttng_ust_event_exclusion
));
1302 memcpy(ust_exclusion
, exclusion
, exclusion_alloc_size
);
1304 return ust_exclusion
;
1308 * Set event exclusions on the tracer.
1311 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1312 struct ust_app
*app
)
1315 struct lttng_ust_event_exclusion
*ust_exclusion
= NULL
;
1317 health_code_update();
1319 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1324 ust_exclusion
= create_ust_exclusion_from_exclusion(
1325 ua_event
->exclusion
);
1326 if (!ust_exclusion
) {
1327 ret
= -LTTNG_ERR_NOMEM
;
1330 pthread_mutex_lock(&app
->sock_lock
);
1331 ret
= ustctl_set_exclusion(app
->sock
, ust_exclusion
, ua_event
->obj
);
1332 pthread_mutex_unlock(&app
->sock_lock
);
1334 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1335 ERR("UST app event %s exclusions failed for app (pid: %d) "
1336 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1339 * This is normal behavior, an application can die during the
1340 * creation process. Don't report an error so the execution can
1341 * continue normally.
1344 DBG3("UST app event exclusion failed. Application is dead.");
1349 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1352 health_code_update();
1353 free(ust_exclusion
);
1358 * Disable the specified event on to UST tracer for the UST session.
1360 static int disable_ust_event(struct ust_app
*app
,
1361 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1365 health_code_update();
1367 pthread_mutex_lock(&app
->sock_lock
);
1368 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1369 pthread_mutex_unlock(&app
->sock_lock
);
1371 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1372 ERR("UST app event %s disable failed for app (pid: %d) "
1373 "and session handle %d with ret %d",
1374 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1377 * This is normal behavior, an application can die during the
1378 * creation process. Don't report an error so the execution can
1379 * continue normally.
1382 DBG3("UST app disable event failed. Application is dead.");
1387 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1388 ua_event
->attr
.name
, app
->pid
);
1391 health_code_update();
1396 * Disable the specified channel on to UST tracer for the UST session.
1398 static int disable_ust_channel(struct ust_app
*app
,
1399 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1403 health_code_update();
1405 pthread_mutex_lock(&app
->sock_lock
);
1406 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1407 pthread_mutex_unlock(&app
->sock_lock
);
1409 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1410 ERR("UST app channel %s disable failed for app (pid: %d) "
1411 "and session handle %d with ret %d",
1412 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1415 * This is normal behavior, an application can die during the
1416 * creation process. Don't report an error so the execution can
1417 * continue normally.
1420 DBG3("UST app disable channel failed. Application is dead.");
1425 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1426 ua_chan
->name
, app
->pid
);
1429 health_code_update();
1434 * Enable the specified channel on to UST tracer for the UST session.
1436 static int enable_ust_channel(struct ust_app
*app
,
1437 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1441 health_code_update();
1443 pthread_mutex_lock(&app
->sock_lock
);
1444 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1445 pthread_mutex_unlock(&app
->sock_lock
);
1447 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1448 ERR("UST app channel %s enable failed for app (pid: %d) "
1449 "and session handle %d with ret %d",
1450 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1453 * This is normal behavior, an application can die during the
1454 * creation process. Don't report an error so the execution can
1455 * continue normally.
1458 DBG3("UST app enable channel failed. Application is dead.");
1463 ua_chan
->enabled
= 1;
1465 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1466 ua_chan
->name
, app
->pid
);
1469 health_code_update();
1474 * Enable the specified event on to UST tracer for the UST session.
1476 static int enable_ust_event(struct ust_app
*app
,
1477 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1481 health_code_update();
1483 pthread_mutex_lock(&app
->sock_lock
);
1484 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1485 pthread_mutex_unlock(&app
->sock_lock
);
1487 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1488 ERR("UST app event %s enable failed for app (pid: %d) "
1489 "and session handle %d with ret %d",
1490 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1493 * This is normal behavior, an application can die during the
1494 * creation process. Don't report an error so the execution can
1495 * continue normally.
1498 DBG3("UST app enable event failed. Application is dead.");
1503 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1504 ua_event
->attr
.name
, app
->pid
);
1507 health_code_update();
1512 * Send channel and stream buffer to application.
1514 * Return 0 on success. On error, a negative value is returned.
1516 static int send_channel_pid_to_ust(struct ust_app
*app
,
1517 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1520 struct ust_app_stream
*stream
, *stmp
;
1526 health_code_update();
1528 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1531 /* Send channel to the application. */
1532 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1533 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1534 ret
= -ENOTCONN
; /* Caused by app exiting. */
1536 } else if (ret
< 0) {
1540 health_code_update();
1542 /* Send all streams to application. */
1543 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1544 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1545 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
1546 ret
= -ENOTCONN
; /* Caused by app exiting. */
1548 } else if (ret
< 0) {
1551 /* We don't need the stream anymore once sent to the tracer. */
1552 cds_list_del(&stream
->list
);
1553 delete_ust_app_stream(-1, stream
, app
);
1555 /* Flag the channel that it is sent to the application. */
1556 ua_chan
->is_sent
= 1;
1559 health_code_update();
1564 * Create the specified event onto the UST tracer for a UST session.
1566 * Should be called with session mutex held.
1569 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1570 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1574 health_code_update();
1576 /* Create UST event on tracer */
1577 pthread_mutex_lock(&app
->sock_lock
);
1578 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1580 pthread_mutex_unlock(&app
->sock_lock
);
1582 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1583 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1584 ua_event
->attr
.name
, app
->pid
, ret
);
1587 * This is normal behavior, an application can die during the
1588 * creation process. Don't report an error so the execution can
1589 * continue normally.
1592 DBG3("UST app create event failed. Application is dead.");
1597 ua_event
->handle
= ua_event
->obj
->handle
;
1599 DBG2("UST app event %s created successfully for pid:%d",
1600 ua_event
->attr
.name
, app
->pid
);
1602 health_code_update();
1604 /* Set filter if one is present. */
1605 if (ua_event
->filter
) {
1606 ret
= set_ust_event_filter(ua_event
, app
);
1612 /* Set exclusions for the event */
1613 if (ua_event
->exclusion
) {
1614 ret
= set_ust_event_exclusion(ua_event
, app
);
1620 /* If event not enabled, disable it on the tracer */
1621 if (ua_event
->enabled
) {
1623 * We now need to explicitly enable the event, since it
1624 * is now disabled at creation.
1626 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1629 * If we hit an EPERM, something is wrong with our enable call. If
1630 * we get an EEXIST, there is a problem on the tracer side since we
1634 case -LTTNG_UST_ERR_PERM
:
1635 /* Code flow problem */
1637 case -LTTNG_UST_ERR_EXIST
:
1638 /* It's OK for our use case. */
1649 health_code_update();
1654 * Copy data between an UST app event and a LTT event.
1656 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1657 struct ltt_ust_event
*uevent
)
1659 size_t exclusion_alloc_size
;
1661 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1662 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1664 ua_event
->enabled
= uevent
->enabled
;
1666 /* Copy event attributes */
1667 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1669 /* Copy filter bytecode */
1670 if (uevent
->filter
) {
1671 ua_event
->filter
= copy_filter_bytecode(uevent
->filter
);
1672 /* Filter might be NULL here in case of ENONEM. */
1675 /* Copy exclusion data */
1676 if (uevent
->exclusion
) {
1677 exclusion_alloc_size
= sizeof(struct lttng_event_exclusion
) +
1678 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1679 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1680 if (ua_event
->exclusion
== NULL
) {
1683 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1684 exclusion_alloc_size
);
1690 * Copy data between an UST app channel and a LTT channel.
1692 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1693 struct ltt_ust_channel
*uchan
)
1695 struct lttng_ht_iter iter
;
1696 struct ltt_ust_event
*uevent
;
1697 struct ltt_ust_context
*uctx
;
1698 struct ust_app_event
*ua_event
;
1699 struct ust_app_ctx
*ua_ctx
;
1701 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1703 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1704 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1706 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1707 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1709 /* Copy event attributes since the layout is different. */
1710 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1711 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1712 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1713 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1714 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1715 ua_chan
->attr
.output
= uchan
->attr
.output
;
1717 * Note that the attribute channel type is not set since the channel on the
1718 * tracing registry side does not have this information.
1721 ua_chan
->enabled
= uchan
->enabled
;
1722 ua_chan
->tracing_channel_id
= uchan
->id
;
1724 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1725 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1726 if (ua_ctx
== NULL
) {
1729 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1730 (unsigned long) ua_ctx
->ctx
.ctx
);
1731 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1732 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1735 /* Copy all events from ltt ust channel to ust app channel */
1736 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1737 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1738 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1739 if (ua_event
== NULL
) {
1740 DBG2("UST event %s not found on shadow copy channel",
1742 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1743 if (ua_event
== NULL
) {
1746 shadow_copy_event(ua_event
, uevent
);
1747 add_unique_ust_app_event(ua_chan
, ua_event
);
1751 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1755 * Copy data between a UST app session and a regular LTT session.
1757 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1758 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1760 struct lttng_ht_node_str
*ua_chan_node
;
1761 struct lttng_ht_iter iter
;
1762 struct ltt_ust_channel
*uchan
;
1763 struct ust_app_channel
*ua_chan
;
1765 struct tm
*timeinfo
;
1768 char tmp_shm_path
[PATH_MAX
];
1770 /* Get date and time for unique app path */
1772 timeinfo
= localtime(&rawtime
);
1773 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1775 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1777 ua_sess
->tracing_id
= usess
->id
;
1778 ua_sess
->id
= get_next_session_id();
1779 ua_sess
->uid
= app
->uid
;
1780 ua_sess
->gid
= app
->gid
;
1781 ua_sess
->euid
= usess
->uid
;
1782 ua_sess
->egid
= usess
->gid
;
1783 ua_sess
->buffer_type
= usess
->buffer_type
;
1784 ua_sess
->bits_per_long
= app
->bits_per_long
;
1786 /* There is only one consumer object per session possible. */
1787 consumer_output_get(usess
->consumer
);
1788 ua_sess
->consumer
= usess
->consumer
;
1790 ua_sess
->output_traces
= usess
->output_traces
;
1791 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1792 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1793 &usess
->metadata_attr
);
1795 switch (ua_sess
->buffer_type
) {
1796 case LTTNG_BUFFER_PER_PID
:
1797 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1798 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1801 case LTTNG_BUFFER_PER_UID
:
1802 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1803 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1810 PERROR("asprintf UST shadow copy session");
1815 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1816 sizeof(ua_sess
->root_shm_path
));
1817 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1818 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1819 sizeof(ua_sess
->shm_path
));
1820 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1821 if (ua_sess
->shm_path
[0]) {
1822 switch (ua_sess
->buffer_type
) {
1823 case LTTNG_BUFFER_PER_PID
:
1824 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1825 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1826 app
->name
, app
->pid
, datetime
);
1828 case LTTNG_BUFFER_PER_UID
:
1829 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1830 DEFAULT_UST_TRACE_UID_PATH
,
1831 app
->uid
, app
->bits_per_long
);
1838 PERROR("sprintf UST shadow copy session");
1842 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1843 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1844 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1847 /* Iterate over all channels in global domain. */
1848 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1850 struct lttng_ht_iter uiter
;
1852 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1853 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1854 if (ua_chan_node
!= NULL
) {
1855 /* Session exist. Contiuing. */
1859 DBG2("Channel %s not found on shadow session copy, creating it",
1861 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1862 if (ua_chan
== NULL
) {
1863 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1866 shadow_copy_channel(ua_chan
, uchan
);
1868 * The concept of metadata channel does not exist on the tracing
1869 * registry side of the session daemon so this can only be a per CPU
1870 * channel and not metadata.
1872 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1874 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1879 consumer_output_put(ua_sess
->consumer
);
1883 * Lookup sesison wrapper.
1886 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1887 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1889 /* Get right UST app session from app */
1890 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1894 * Return ust app session from the app session hashtable using the UST session
1897 static struct ust_app_session
*lookup_session_by_app(
1898 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1900 struct lttng_ht_iter iter
;
1901 struct lttng_ht_node_u64
*node
;
1903 __lookup_session_by_app(usess
, app
, &iter
);
1904 node
= lttng_ht_iter_get_node_u64(&iter
);
1909 return caa_container_of(node
, struct ust_app_session
, node
);
1916 * Setup buffer registry per PID for the given session and application. If none
1917 * is found, a new one is created, added to the global registry and
1918 * initialized. If regp is valid, it's set with the newly created object.
1920 * Return 0 on success or else a negative value.
1922 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1923 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1926 struct buffer_reg_pid
*reg_pid
;
1933 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1936 * This is the create channel path meaning that if there is NO
1937 * registry available, we have to create one for this session.
1939 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1940 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1948 /* Initialize registry. */
1949 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1950 app
->bits_per_long
, app
->uint8_t_alignment
,
1951 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1952 app
->uint64_t_alignment
, app
->long_alignment
,
1953 app
->byte_order
, app
->version
.major
,
1954 app
->version
.minor
, reg_pid
->root_shm_path
,
1956 ua_sess
->euid
, ua_sess
->egid
);
1959 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1960 * destroy the buffer registry, because it is always expected
1961 * that if the buffer registry can be found, its ust registry is
1964 buffer_reg_pid_destroy(reg_pid
);
1968 buffer_reg_pid_add(reg_pid
);
1970 DBG3("UST app buffer registry per PID created successfully");
1982 * Setup buffer registry per UID for the given session and application. If none
1983 * is found, a new one is created, added to the global registry and
1984 * initialized. If regp is valid, it's set with the newly created object.
1986 * Return 0 on success or else a negative value.
1988 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1989 struct ust_app_session
*ua_sess
,
1990 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1993 struct buffer_reg_uid
*reg_uid
;
2000 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2003 * This is the create channel path meaning that if there is NO
2004 * registry available, we have to create one for this session.
2006 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
2007 LTTNG_DOMAIN_UST
, ®_uid
,
2008 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
2016 /* Initialize registry. */
2017 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
2018 app
->bits_per_long
, app
->uint8_t_alignment
,
2019 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
2020 app
->uint64_t_alignment
, app
->long_alignment
,
2021 app
->byte_order
, app
->version
.major
,
2022 app
->version
.minor
, reg_uid
->root_shm_path
,
2023 reg_uid
->shm_path
, usess
->uid
, usess
->gid
);
2026 * reg_uid->registry->reg.ust is NULL upon error, so we need to
2027 * destroy the buffer registry, because it is always expected
2028 * that if the buffer registry can be found, its ust registry is
2031 buffer_reg_uid_destroy(reg_uid
, NULL
);
2034 /* Add node to teardown list of the session. */
2035 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
2037 buffer_reg_uid_add(reg_uid
);
2039 DBG3("UST app buffer registry per UID created successfully");
2050 * Create a session on the tracer side for the given app.
2052 * On success, ua_sess_ptr is populated with the session pointer or else left
2053 * untouched. If the session was created, is_created is set to 1. On error,
2054 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
2057 * Returns 0 on success or else a negative code which is either -ENOMEM or
2058 * -ENOTCONN which is the default code if the ustctl_create_session fails.
2060 static int create_ust_app_session(struct ltt_ust_session
*usess
,
2061 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
2064 int ret
, created
= 0;
2065 struct ust_app_session
*ua_sess
;
2069 assert(ua_sess_ptr
);
2071 health_code_update();
2073 ua_sess
= lookup_session_by_app(usess
, app
);
2074 if (ua_sess
== NULL
) {
2075 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
2076 app
->pid
, usess
->id
);
2077 ua_sess
= alloc_ust_app_session(app
);
2078 if (ua_sess
== NULL
) {
2079 /* Only malloc can failed so something is really wrong */
2083 shadow_copy_session(ua_sess
, usess
, app
);
2087 switch (usess
->buffer_type
) {
2088 case LTTNG_BUFFER_PER_PID
:
2089 /* Init local registry. */
2090 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
2092 delete_ust_app_session(-1, ua_sess
, app
);
2096 case LTTNG_BUFFER_PER_UID
:
2097 /* Look for a global registry. If none exists, create one. */
2098 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
2100 delete_ust_app_session(-1, ua_sess
, app
);
2110 health_code_update();
2112 if (ua_sess
->handle
== -1) {
2113 pthread_mutex_lock(&app
->sock_lock
);
2114 ret
= ustctl_create_session(app
->sock
);
2115 pthread_mutex_unlock(&app
->sock_lock
);
2117 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
2118 ERR("Creating session for app pid %d with ret %d",
2121 DBG("UST app creating session failed. Application is dead");
2123 * This is normal behavior, an application can die during the
2124 * creation process. Don't report an error so the execution can
2125 * continue normally. This will get flagged ENOTCONN and the
2126 * caller will handle it.
2130 delete_ust_app_session(-1, ua_sess
, app
);
2131 if (ret
!= -ENOMEM
) {
2133 * Tracer is probably gone or got an internal error so let's
2134 * behave like it will soon unregister or not usable.
2141 ua_sess
->handle
= ret
;
2143 /* Add ust app session to app's HT */
2144 lttng_ht_node_init_u64(&ua_sess
->node
,
2145 ua_sess
->tracing_id
);
2146 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
2147 lttng_ht_node_init_ulong(&ua_sess
->ust_objd_node
, ua_sess
->handle
);
2148 lttng_ht_add_unique_ulong(app
->ust_sessions_objd
,
2149 &ua_sess
->ust_objd_node
);
2151 DBG2("UST app session created successfully with handle %d", ret
);
2154 *ua_sess_ptr
= ua_sess
;
2156 *is_created
= created
;
2159 /* Everything went well. */
2163 health_code_update();
2168 * Match function for a hash table lookup of ust_app_ctx.
2170 * It matches an ust app context based on the context type and, in the case
2171 * of perf counters, their name.
2173 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2175 struct ust_app_ctx
*ctx
;
2176 const struct lttng_ust_context
*key
;
2181 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2185 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2189 /* Check the name in the case of perf thread counters. */
2190 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
2191 if (strncmp(key
->u
.perf_counter
.name
,
2192 ctx
->ctx
.u
.perf_counter
.name
,
2193 sizeof(key
->u
.perf_counter
.name
))) {
2206 * Lookup for an ust app context from an lttng_ust_context.
2208 * Must be called while holding RCU read side lock.
2209 * Return an ust_app_ctx object or NULL on error.
2212 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2213 struct lttng_ust_context
*uctx
)
2215 struct lttng_ht_iter iter
;
2216 struct lttng_ht_node_ulong
*node
;
2217 struct ust_app_ctx
*app_ctx
= NULL
;
2222 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2223 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2224 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2225 node
= lttng_ht_iter_get_node_ulong(&iter
);
2230 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2237 * Create a context for the channel on the tracer.
2239 * Called with UST app session lock held and a RCU read side lock.
2242 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2243 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2244 struct ust_app
*app
)
2247 struct ust_app_ctx
*ua_ctx
;
2249 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2251 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2257 ua_ctx
= alloc_ust_app_ctx(uctx
);
2258 if (ua_ctx
== NULL
) {
2264 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2265 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2266 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2268 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2278 * Enable on the tracer side a ust app event for the session and channel.
2280 * Called with UST app session lock held.
2283 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2284 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2288 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2293 ua_event
->enabled
= 1;
2300 * Disable on the tracer side a ust app event for the session and channel.
2302 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2303 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2307 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2312 ua_event
->enabled
= 0;
2319 * Lookup ust app channel for session and disable it on the tracer side.
2322 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2323 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2327 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2332 ua_chan
->enabled
= 0;
2339 * Lookup ust app channel for session and enable it on the tracer side. This
2340 * MUST be called with a RCU read side lock acquired.
2342 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2343 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2346 struct lttng_ht_iter iter
;
2347 struct lttng_ht_node_str
*ua_chan_node
;
2348 struct ust_app_channel
*ua_chan
;
2350 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2351 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2352 if (ua_chan_node
== NULL
) {
2353 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2354 uchan
->name
, ua_sess
->tracing_id
);
2358 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2360 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2370 * Ask the consumer to create a channel and get it if successful.
2372 * Return 0 on success or else a negative value.
2374 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2375 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2376 int bitness
, struct ust_registry_session
*registry
)
2379 unsigned int nb_fd
= 0;
2380 struct consumer_socket
*socket
;
2388 health_code_update();
2390 /* Get the right consumer socket for the application. */
2391 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2397 health_code_update();
2399 /* Need one fd for the channel. */
2400 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2402 ERR("Exhausted number of available FD upon create channel");
2407 * Ask consumer to create channel. The consumer will return the number of
2408 * stream we have to expect.
2410 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2417 * Compute the number of fd needed before receiving them. It must be 2 per
2418 * stream (2 being the default value here).
2420 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2422 /* Reserve the amount of file descriptor we need. */
2423 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2425 ERR("Exhausted number of available FD upon create channel");
2426 goto error_fd_get_stream
;
2429 health_code_update();
2432 * Now get the channel from the consumer. This call wil populate the stream
2433 * list of that channel and set the ust objects.
2435 if (usess
->consumer
->enabled
) {
2436 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2446 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2447 error_fd_get_stream
:
2449 * Initiate a destroy channel on the consumer since we had an error
2450 * handling it on our side. The return value is of no importance since we
2451 * already have a ret value set by the previous error that we need to
2454 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2456 lttng_fd_put(LTTNG_FD_APPS
, 1);
2458 health_code_update();
2464 * Duplicate the ust data object of the ust app stream and save it in the
2465 * buffer registry stream.
2467 * Return 0 on success or else a negative value.
2469 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2470 struct ust_app_stream
*stream
)
2477 /* Reserve the amount of file descriptor we need. */
2478 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2480 ERR("Exhausted number of available FD upon duplicate stream");
2484 /* Duplicate object for stream once the original is in the registry. */
2485 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2486 reg_stream
->obj
.ust
);
2488 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2489 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2490 lttng_fd_put(LTTNG_FD_APPS
, 2);
2493 stream
->handle
= stream
->obj
->handle
;
2500 * Duplicate the ust data object of the ust app. channel and save it in the
2501 * buffer registry channel.
2503 * Return 0 on success or else a negative value.
2505 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2506 struct ust_app_channel
*ua_chan
)
2513 /* Need two fds for the channel. */
2514 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2516 ERR("Exhausted number of available FD upon duplicate channel");
2520 /* Duplicate object for stream once the original is in the registry. */
2521 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2523 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2524 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2527 ua_chan
->handle
= ua_chan
->obj
->handle
;
2532 lttng_fd_put(LTTNG_FD_APPS
, 1);
2538 * For a given channel buffer registry, setup all streams of the given ust
2539 * application channel.
2541 * Return 0 on success or else a negative value.
2543 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2544 struct ust_app_channel
*ua_chan
,
2545 struct ust_app
*app
)
2548 struct ust_app_stream
*stream
, *stmp
;
2553 DBG2("UST app setup buffer registry stream");
2555 /* Send all streams to application. */
2556 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2557 struct buffer_reg_stream
*reg_stream
;
2559 ret
= buffer_reg_stream_create(®_stream
);
2565 * Keep original pointer and nullify it in the stream so the delete
2566 * stream call does not release the object.
2568 reg_stream
->obj
.ust
= stream
->obj
;
2570 buffer_reg_stream_add(reg_stream
, reg_chan
);
2572 /* We don't need the streams anymore. */
2573 cds_list_del(&stream
->list
);
2574 delete_ust_app_stream(-1, stream
, app
);
2582 * Create a buffer registry channel for the given session registry and
2583 * application channel object. If regp pointer is valid, it's set with the
2584 * created object. Important, the created object is NOT added to the session
2585 * registry hash table.
2587 * Return 0 on success else a negative value.
2589 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2590 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2593 struct buffer_reg_channel
*reg_chan
= NULL
;
2598 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2600 /* Create buffer registry channel. */
2601 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2606 reg_chan
->consumer_key
= ua_chan
->key
;
2607 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2608 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2610 /* Create and add a channel registry to session. */
2611 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2612 ua_chan
->tracing_channel_id
);
2616 buffer_reg_channel_add(reg_sess
, reg_chan
);
2625 /* Safe because the registry channel object was not added to any HT. */
2626 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2632 * Setup buffer registry channel for the given session registry and application
2633 * channel object. If regp pointer is valid, it's set with the created object.
2635 * Return 0 on success else a negative value.
2637 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2638 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
,
2639 struct ust_app
*app
)
2646 assert(ua_chan
->obj
);
2648 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2650 /* Setup all streams for the registry. */
2651 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
, app
);
2656 reg_chan
->obj
.ust
= ua_chan
->obj
;
2657 ua_chan
->obj
= NULL
;
2662 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2663 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2668 * Send buffer registry channel to the application.
2670 * Return 0 on success else a negative value.
2672 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2673 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2674 struct ust_app_channel
*ua_chan
)
2677 struct buffer_reg_stream
*reg_stream
;
2684 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2686 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2691 /* Send channel to the application. */
2692 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2693 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2694 ret
= -ENOTCONN
; /* Caused by app exiting. */
2696 } else if (ret
< 0) {
2700 health_code_update();
2702 /* Send all streams to application. */
2703 pthread_mutex_lock(®_chan
->stream_list_lock
);
2704 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2705 struct ust_app_stream stream
;
2707 ret
= duplicate_stream_object(reg_stream
, &stream
);
2709 goto error_stream_unlock
;
2712 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2714 (void) release_ust_app_stream(-1, &stream
, app
);
2715 if (ret
== -EPIPE
|| ret
== -LTTNG_UST_ERR_EXITING
) {
2716 ret
= -ENOTCONN
; /* Caused by app exiting. */
2717 goto error_stream_unlock
;
2718 } else if (ret
< 0) {
2719 goto error_stream_unlock
;
2721 goto error_stream_unlock
;
2725 * The return value is not important here. This function will output an
2728 (void) release_ust_app_stream(-1, &stream
, app
);
2730 ua_chan
->is_sent
= 1;
2732 error_stream_unlock
:
2733 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2739 * Create and send to the application the created buffers with per UID buffers.
2741 * Return 0 on success else a negative value.
2743 static int create_channel_per_uid(struct ust_app
*app
,
2744 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2745 struct ust_app_channel
*ua_chan
)
2748 struct buffer_reg_uid
*reg_uid
;
2749 struct buffer_reg_channel
*reg_chan
;
2756 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2758 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2760 * The session creation handles the creation of this global registry
2761 * object. If none can be find, there is a code flow problem or a
2766 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2769 /* Create the buffer registry channel object. */
2770 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2772 ERR("Error creating the UST channel \"%s\" registry instance",
2779 * Create the buffers on the consumer side. This call populates the
2780 * ust app channel object with all streams and data object.
2782 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2783 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2785 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2789 * Let's remove the previously created buffer registry channel so
2790 * it's not visible anymore in the session registry.
2792 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2793 ua_chan
->tracing_channel_id
);
2794 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2795 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2800 * Setup the streams and add it to the session registry.
2802 ret
= setup_buffer_reg_channel(reg_uid
->registry
,
2803 ua_chan
, reg_chan
, app
);
2805 ERR("Error setting up UST channel \"%s\"",
2812 /* Send buffers to the application. */
2813 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2815 if (ret
!= -ENOTCONN
) {
2816 ERR("Error sending channel to application");
2826 * Create and send to the application the created buffers with per PID buffers.
2828 * Return 0 on success else a negative value.
2830 static int create_channel_per_pid(struct ust_app
*app
,
2831 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2832 struct ust_app_channel
*ua_chan
)
2835 struct ust_registry_session
*registry
;
2842 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2846 registry
= get_session_registry(ua_sess
);
2849 /* Create and add a new channel registry to session. */
2850 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2852 ERR("Error creating the UST channel \"%s\" registry instance",
2857 /* Create and get channel on the consumer side. */
2858 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2859 app
->bits_per_long
, registry
);
2861 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2866 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2868 if (ret
!= -ENOTCONN
) {
2869 ERR("Error sending channel to application");
2880 * From an already allocated ust app channel, create the channel buffers if
2881 * need and send it to the application. This MUST be called with a RCU read
2882 * side lock acquired.
2884 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2885 * the application exited concurrently.
2887 static int do_create_channel(struct ust_app
*app
,
2888 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2889 struct ust_app_channel
*ua_chan
)
2898 /* Handle buffer type before sending the channel to the application. */
2899 switch (usess
->buffer_type
) {
2900 case LTTNG_BUFFER_PER_UID
:
2902 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2908 case LTTNG_BUFFER_PER_PID
:
2910 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2922 /* Initialize ust objd object using the received handle and add it. */
2923 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2924 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2926 /* If channel is not enabled, disable it on the tracer */
2927 if (!ua_chan
->enabled
) {
2928 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2939 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2940 * newly created channel if not NULL.
2942 * Called with UST app session lock and RCU read-side lock held.
2944 * Return 0 on success or else a negative value. Returns -ENOTCONN if
2945 * the application exited concurrently.
2947 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2948 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2949 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2950 struct ust_app_channel
**ua_chanp
)
2953 struct lttng_ht_iter iter
;
2954 struct lttng_ht_node_str
*ua_chan_node
;
2955 struct ust_app_channel
*ua_chan
;
2957 /* Lookup channel in the ust app session */
2958 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2959 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2960 if (ua_chan_node
!= NULL
) {
2961 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2965 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2966 if (ua_chan
== NULL
) {
2967 /* Only malloc can fail here */
2971 shadow_copy_channel(ua_chan
, uchan
);
2973 /* Set channel type. */
2974 ua_chan
->attr
.type
= type
;
2976 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2981 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2984 /* Only add the channel if successful on the tracer side. */
2985 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2989 *ua_chanp
= ua_chan
;
2992 /* Everything went well. */
2996 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
3002 * Create UST app event and create it on the tracer side.
3004 * Called with ust app session mutex held.
3007 int create_ust_app_event(struct ust_app_session
*ua_sess
,
3008 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
3009 struct ust_app
*app
)
3012 struct ust_app_event
*ua_event
;
3014 /* Get event node */
3015 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3016 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3017 if (ua_event
!= NULL
) {
3022 /* Does not exist so create one */
3023 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
3024 if (ua_event
== NULL
) {
3025 /* Only malloc can failed so something is really wrong */
3029 shadow_copy_event(ua_event
, uevent
);
3031 /* Create it on the tracer side */
3032 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
3034 /* Not found previously means that it does not exist on the tracer */
3035 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
3039 add_unique_ust_app_event(ua_chan
, ua_event
);
3041 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
3048 /* Valid. Calling here is already in a read side lock */
3049 delete_ust_app_event(-1, ua_event
, app
);
3054 * Create UST metadata and open it on the tracer side.
3056 * Called with UST app session lock held and RCU read side lock.
3058 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
3059 struct ust_app
*app
, struct consumer_output
*consumer
)
3062 struct ust_app_channel
*metadata
;
3063 struct consumer_socket
*socket
;
3064 struct ust_registry_session
*registry
;
3070 registry
= get_session_registry(ua_sess
);
3073 pthread_mutex_lock(®istry
->lock
);
3075 /* Metadata already exists for this registry or it was closed previously */
3076 if (registry
->metadata_key
|| registry
->metadata_closed
) {
3081 /* Allocate UST metadata */
3082 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
3084 /* malloc() failed */
3089 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
3091 /* Need one fd for the channel. */
3092 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
3094 ERR("Exhausted number of available FD upon create metadata");
3098 /* Get the right consumer socket for the application. */
3099 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
3102 goto error_consumer
;
3106 * Keep metadata key so we can identify it on the consumer side. Assign it
3107 * to the registry *before* we ask the consumer so we avoid the race of the
3108 * consumer requesting the metadata and the ask_channel call on our side
3109 * did not returned yet.
3111 registry
->metadata_key
= metadata
->key
;
3114 * Ask the metadata channel creation to the consumer. The metadata object
3115 * will be created by the consumer and kept their. However, the stream is
3116 * never added or monitored until we do a first push metadata to the
3119 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
3122 /* Nullify the metadata key so we don't try to close it later on. */
3123 registry
->metadata_key
= 0;
3124 goto error_consumer
;
3128 * The setup command will make the metadata stream be sent to the relayd,
3129 * if applicable, and the thread managing the metadatas. This is important
3130 * because after this point, if an error occurs, the only way the stream
3131 * can be deleted is to be monitored in the consumer.
3133 ret
= consumer_setup_metadata(socket
, metadata
->key
);
3135 /* Nullify the metadata key so we don't try to close it later on. */
3136 registry
->metadata_key
= 0;
3137 goto error_consumer
;
3140 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
3141 metadata
->key
, app
->pid
);
3144 lttng_fd_put(LTTNG_FD_APPS
, 1);
3145 delete_ust_app_channel(-1, metadata
, app
);
3147 pthread_mutex_unlock(®istry
->lock
);
3152 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
3153 * acquired before calling this function.
3155 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
3157 struct ust_app
*app
= NULL
;
3158 struct lttng_ht_node_ulong
*node
;
3159 struct lttng_ht_iter iter
;
3161 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
3162 node
= lttng_ht_iter_get_node_ulong(&iter
);
3164 DBG2("UST app no found with pid %d", pid
);
3168 DBG2("Found UST app by pid %d", pid
);
3170 app
= caa_container_of(node
, struct ust_app
, pid_n
);
3177 * Allocate and init an UST app object using the registration information and
3178 * the command socket. This is called when the command socket connects to the
3181 * The object is returned on success or else NULL.
3183 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
3185 struct ust_app
*lta
= NULL
;
3190 DBG3("UST app creating application for socket %d", sock
);
3192 if ((msg
->bits_per_long
== 64 &&
3193 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3194 || (msg
->bits_per_long
== 32 &&
3195 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3196 ERR("Registration failed: application \"%s\" (pid: %d) has "
3197 "%d-bit long, but no consumerd for this size is available.\n",
3198 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3202 lta
= zmalloc(sizeof(struct ust_app
));
3208 lta
->ppid
= msg
->ppid
;
3209 lta
->uid
= msg
->uid
;
3210 lta
->gid
= msg
->gid
;
3212 lta
->bits_per_long
= msg
->bits_per_long
;
3213 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3214 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3215 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3216 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3217 lta
->long_alignment
= msg
->long_alignment
;
3218 lta
->byte_order
= msg
->byte_order
;
3220 lta
->v_major
= msg
->major
;
3221 lta
->v_minor
= msg
->minor
;
3222 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3223 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3224 lta
->ust_sessions_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3225 lta
->notify_sock
= -1;
3227 /* Copy name and make sure it's NULL terminated. */
3228 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3229 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3232 * Before this can be called, when receiving the registration information,
3233 * the application compatibility is checked. So, at this point, the
3234 * application can work with this session daemon.
3236 lta
->compatible
= 1;
3238 lta
->pid
= msg
->pid
;
3239 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3241 pthread_mutex_init(<a
->sock_lock
, NULL
);
3242 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3244 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3250 * For a given application object, add it to every hash table.
3252 void ust_app_add(struct ust_app
*app
)
3255 assert(app
->notify_sock
>= 0);
3260 * On a re-registration, we want to kick out the previous registration of
3263 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3266 * The socket _should_ be unique until _we_ call close. So, a add_unique
3267 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3268 * already in the table.
3270 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3272 /* Add application to the notify socket hash table. */
3273 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3274 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3276 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3277 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3278 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3285 * Set the application version into the object.
3287 * Return 0 on success else a negative value either an errno code or a
3288 * LTTng-UST error code.
3290 int ust_app_version(struct ust_app
*app
)
3296 pthread_mutex_lock(&app
->sock_lock
);
3297 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3298 pthread_mutex_unlock(&app
->sock_lock
);
3300 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3301 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3303 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3311 * Unregister app by removing it from the global traceable app list and freeing
3314 * The socket is already closed at this point so no close to sock.
3316 void ust_app_unregister(int sock
)
3318 struct ust_app
*lta
;
3319 struct lttng_ht_node_ulong
*node
;
3320 struct lttng_ht_iter ust_app_sock_iter
;
3321 struct lttng_ht_iter iter
;
3322 struct ust_app_session
*ua_sess
;
3327 /* Get the node reference for a call_rcu */
3328 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3329 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3332 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3333 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3336 * For per-PID buffers, perform "push metadata" and flush all
3337 * application streams before removing app from hash tables,
3338 * ensuring proper behavior of data_pending check.
3339 * Remove sessions so they are not visible during deletion.
3341 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3343 struct ust_registry_session
*registry
;
3345 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3347 /* The session was already removed so scheduled for teardown. */
3351 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3352 (void) ust_app_flush_app_session(lta
, ua_sess
);
3356 * Add session to list for teardown. This is safe since at this point we
3357 * are the only one using this list.
3359 pthread_mutex_lock(&ua_sess
->lock
);
3361 if (ua_sess
->deleted
) {
3362 pthread_mutex_unlock(&ua_sess
->lock
);
3367 * Normally, this is done in the delete session process which is
3368 * executed in the call rcu below. However, upon registration we can't
3369 * afford to wait for the grace period before pushing data or else the
3370 * data pending feature can race between the unregistration and stop
3371 * command where the data pending command is sent *before* the grace
3374 * The close metadata below nullifies the metadata pointer in the
3375 * session so the delete session will NOT push/close a second time.
3377 registry
= get_session_registry(ua_sess
);
3379 /* Push metadata for application before freeing the application. */
3380 (void) push_metadata(registry
, ua_sess
->consumer
);
3383 * Don't ask to close metadata for global per UID buffers. Close
3384 * metadata only on destroy trace session in this case. Also, the
3385 * previous push metadata could have flag the metadata registry to
3386 * close so don't send a close command if closed.
3388 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3389 /* And ask to close it for this session registry. */
3390 (void) close_metadata(registry
, ua_sess
->consumer
);
3393 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3395 pthread_mutex_unlock(&ua_sess
->lock
);
3398 /* Remove application from PID hash table */
3399 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3403 * Remove application from notify hash table. The thread handling the
3404 * notify socket could have deleted the node so ignore on error because
3405 * either way it's valid. The close of that socket is handled by the other
3408 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3409 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3412 * Ignore return value since the node might have been removed before by an
3413 * add replace during app registration because the PID can be reassigned by
3416 iter
.iter
.node
= <a
->pid_n
.node
;
3417 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3419 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3424 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3431 * Fill events array with all events name of all registered apps.
3433 int ust_app_list_events(struct lttng_event
**events
)
3436 size_t nbmem
, count
= 0;
3437 struct lttng_ht_iter iter
;
3438 struct ust_app
*app
;
3439 struct lttng_event
*tmp_event
;
3441 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3442 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3443 if (tmp_event
== NULL
) {
3444 PERROR("zmalloc ust app events");
3451 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3452 struct lttng_ust_tracepoint_iter uiter
;
3454 health_code_update();
3456 if (!app
->compatible
) {
3458 * TODO: In time, we should notice the caller of this error by
3459 * telling him that this is a version error.
3463 pthread_mutex_lock(&app
->sock_lock
);
3464 handle
= ustctl_tracepoint_list(app
->sock
);
3466 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3467 ERR("UST app list events getting handle failed for app pid %d",
3470 pthread_mutex_unlock(&app
->sock_lock
);
3474 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3475 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3476 /* Handle ustctl error. */
3480 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3481 ERR("UST app tp list get failed for app %d with ret %d",
3484 DBG3("UST app tp list get failed. Application is dead");
3486 * This is normal behavior, an application can die during the
3487 * creation process. Don't report an error so the execution can
3488 * continue normally. Continue normal execution.
3493 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3494 if (release_ret
< 0 &&
3495 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3496 release_ret
!= -EPIPE
) {
3497 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3499 pthread_mutex_unlock(&app
->sock_lock
);
3503 health_code_update();
3504 if (count
>= nbmem
) {
3505 /* In case the realloc fails, we free the memory */
3506 struct lttng_event
*new_tmp_event
;
3509 new_nbmem
= nbmem
<< 1;
3510 DBG2("Reallocating event list from %zu to %zu entries",
3512 new_tmp_event
= realloc(tmp_event
,
3513 new_nbmem
* sizeof(struct lttng_event
));
3514 if (new_tmp_event
== NULL
) {
3517 PERROR("realloc ust app events");
3520 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3521 if (release_ret
< 0 &&
3522 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3523 release_ret
!= -EPIPE
) {
3524 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3526 pthread_mutex_unlock(&app
->sock_lock
);
3529 /* Zero the new memory */
3530 memset(new_tmp_event
+ nbmem
, 0,
3531 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3533 tmp_event
= new_tmp_event
;
3535 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3536 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3537 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3538 tmp_event
[count
].pid
= app
->pid
;
3539 tmp_event
[count
].enabled
= -1;
3542 ret
= ustctl_release_handle(app
->sock
, handle
);
3543 pthread_mutex_unlock(&app
->sock_lock
);
3544 if (ret
< 0 && ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3545 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3550 *events
= tmp_event
;
3552 DBG2("UST app list events done (%zu events)", count
);
3557 health_code_update();
3562 * Fill events array with all events name of all registered apps.
3564 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3567 size_t nbmem
, count
= 0;
3568 struct lttng_ht_iter iter
;
3569 struct ust_app
*app
;
3570 struct lttng_event_field
*tmp_event
;
3572 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3573 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3574 if (tmp_event
== NULL
) {
3575 PERROR("zmalloc ust app event fields");
3582 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3583 struct lttng_ust_field_iter uiter
;
3585 health_code_update();
3587 if (!app
->compatible
) {
3589 * TODO: In time, we should notice the caller of this error by
3590 * telling him that this is a version error.
3594 pthread_mutex_lock(&app
->sock_lock
);
3595 handle
= ustctl_tracepoint_field_list(app
->sock
);
3597 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3598 ERR("UST app list field getting handle failed for app pid %d",
3601 pthread_mutex_unlock(&app
->sock_lock
);
3605 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3606 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3607 /* Handle ustctl error. */
3611 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3612 ERR("UST app tp list field failed for app %d with ret %d",
3615 DBG3("UST app tp list field failed. Application is dead");
3617 * This is normal behavior, an application can die during the
3618 * creation process. Don't report an error so the execution can
3619 * continue normally. Reset list and count for next app.
3624 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3625 pthread_mutex_unlock(&app
->sock_lock
);
3626 if (release_ret
< 0 &&
3627 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3628 release_ret
!= -EPIPE
) {
3629 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3634 health_code_update();
3635 if (count
>= nbmem
) {
3636 /* In case the realloc fails, we free the memory */
3637 struct lttng_event_field
*new_tmp_event
;
3640 new_nbmem
= nbmem
<< 1;
3641 DBG2("Reallocating event field list from %zu to %zu entries",
3643 new_tmp_event
= realloc(tmp_event
,
3644 new_nbmem
* sizeof(struct lttng_event_field
));
3645 if (new_tmp_event
== NULL
) {
3648 PERROR("realloc ust app event fields");
3651 release_ret
= ustctl_release_handle(app
->sock
, handle
);
3652 pthread_mutex_unlock(&app
->sock_lock
);
3654 release_ret
!= -LTTNG_UST_ERR_EXITING
&&
3655 release_ret
!= -EPIPE
) {
3656 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, release_ret
);
3660 /* Zero the new memory */
3661 memset(new_tmp_event
+ nbmem
, 0,
3662 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3664 tmp_event
= new_tmp_event
;
3667 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3668 /* Mapping between these enums matches 1 to 1. */
3669 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3670 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3672 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3673 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3674 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3675 tmp_event
[count
].event
.pid
= app
->pid
;
3676 tmp_event
[count
].event
.enabled
= -1;
3679 ret
= ustctl_release_handle(app
->sock
, handle
);
3680 pthread_mutex_unlock(&app
->sock_lock
);
3682 ret
!= -LTTNG_UST_ERR_EXITING
&&
3684 ERR("Error releasing app handle for app %d with ret %d", app
->sock
, ret
);
3689 *fields
= tmp_event
;
3691 DBG2("UST app list event fields done (%zu events)", count
);
3696 health_code_update();
3701 * Free and clean all traceable apps of the global list.
3703 * Should _NOT_ be called with RCU read-side lock held.
3705 void ust_app_clean_list(void)
3708 struct ust_app
*app
;
3709 struct lttng_ht_iter iter
;
3711 DBG2("UST app cleaning registered apps hash table");
3716 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3717 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3719 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3723 /* Cleanup socket hash table */
3724 if (ust_app_ht_by_sock
) {
3725 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3727 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3732 /* Cleanup notify socket hash table */
3733 if (ust_app_ht_by_notify_sock
) {
3734 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3735 notify_sock_n
.node
) {
3736 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3742 /* Destroy is done only when the ht is empty */
3744 ht_cleanup_push(ust_app_ht
);
3746 if (ust_app_ht_by_sock
) {
3747 ht_cleanup_push(ust_app_ht_by_sock
);
3749 if (ust_app_ht_by_notify_sock
) {
3750 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3755 * Init UST app hash table.
3757 int ust_app_ht_alloc(void)
3759 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3763 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3764 if (!ust_app_ht_by_sock
) {
3767 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3768 if (!ust_app_ht_by_notify_sock
) {
3775 * For a specific UST session, disable the channel for all registered apps.
3777 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3778 struct ltt_ust_channel
*uchan
)
3781 struct lttng_ht_iter iter
;
3782 struct lttng_ht_node_str
*ua_chan_node
;
3783 struct ust_app
*app
;
3784 struct ust_app_session
*ua_sess
;
3785 struct ust_app_channel
*ua_chan
;
3787 if (usess
== NULL
|| uchan
== NULL
) {
3788 ERR("Disabling UST global channel with NULL values");
3793 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3794 uchan
->name
, usess
->id
);
3798 /* For every registered applications */
3799 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3800 struct lttng_ht_iter uiter
;
3801 if (!app
->compatible
) {
3803 * TODO: In time, we should notice the caller of this error by
3804 * telling him that this is a version error.
3808 ua_sess
= lookup_session_by_app(usess
, app
);
3809 if (ua_sess
== NULL
) {
3814 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3815 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3816 /* If the session if found for the app, the channel must be there */
3817 assert(ua_chan_node
);
3819 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3820 /* The channel must not be already disabled */
3821 assert(ua_chan
->enabled
== 1);
3823 /* Disable channel onto application */
3824 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3826 /* XXX: We might want to report this error at some point... */
3838 * For a specific UST session, enable the channel for all registered apps.
3840 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3841 struct ltt_ust_channel
*uchan
)
3844 struct lttng_ht_iter iter
;
3845 struct ust_app
*app
;
3846 struct ust_app_session
*ua_sess
;
3848 if (usess
== NULL
|| uchan
== NULL
) {
3849 ERR("Adding UST global channel to NULL values");
3854 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3855 uchan
->name
, usess
->id
);
3859 /* For every registered applications */
3860 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3861 if (!app
->compatible
) {
3863 * TODO: In time, we should notice the caller of this error by
3864 * telling him that this is a version error.
3868 ua_sess
= lookup_session_by_app(usess
, app
);
3869 if (ua_sess
== NULL
) {
3873 /* Enable channel onto application */
3874 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3876 /* XXX: We might want to report this error at some point... */
3888 * Disable an event in a channel and for a specific session.
3890 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3891 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3894 struct lttng_ht_iter iter
, uiter
;
3895 struct lttng_ht_node_str
*ua_chan_node
;
3896 struct ust_app
*app
;
3897 struct ust_app_session
*ua_sess
;
3898 struct ust_app_channel
*ua_chan
;
3899 struct ust_app_event
*ua_event
;
3901 DBG("UST app disabling event %s for all apps in channel "
3902 "%s for session id %" PRIu64
,
3903 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3907 /* For all registered applications */
3908 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3909 if (!app
->compatible
) {
3911 * TODO: In time, we should notice the caller of this error by
3912 * telling him that this is a version error.
3916 ua_sess
= lookup_session_by_app(usess
, app
);
3917 if (ua_sess
== NULL
) {
3922 /* Lookup channel in the ust app session */
3923 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3924 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3925 if (ua_chan_node
== NULL
) {
3926 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3927 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3930 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3932 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3933 uevent
->filter
, uevent
->attr
.loglevel
,
3935 if (ua_event
== NULL
) {
3936 DBG2("Event %s not found in channel %s for app pid %d."
3937 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3941 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3943 /* XXX: Report error someday... */
3954 * For a specific UST session, create the channel for all registered apps.
3956 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3957 struct ltt_ust_channel
*uchan
)
3959 int ret
= 0, created
;
3960 struct lttng_ht_iter iter
;
3961 struct ust_app
*app
;
3962 struct ust_app_session
*ua_sess
= NULL
;
3964 /* Very wrong code flow */
3968 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3969 uchan
->name
, usess
->id
);
3973 /* For every registered applications */
3974 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3975 if (!app
->compatible
) {
3977 * TODO: In time, we should notice the caller of this error by
3978 * telling him that this is a version error.
3982 if (!trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
3988 * Create session on the tracer side and add it to app session HT. Note
3989 * that if session exist, it will simply return a pointer to the ust
3992 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3997 * The application's socket is not valid. Either a bad socket
3998 * or a timeout on it. We can't inform the caller that for a
3999 * specific app, the session failed so lets continue here.
4001 ret
= 0; /* Not an error. */
4005 goto error_rcu_unlock
;
4010 pthread_mutex_lock(&ua_sess
->lock
);
4012 if (ua_sess
->deleted
) {
4013 pthread_mutex_unlock(&ua_sess
->lock
);
4017 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
4018 sizeof(uchan
->name
))) {
4019 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
4022 /* Create channel onto application. We don't need the chan ref. */
4023 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
4024 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
4026 pthread_mutex_unlock(&ua_sess
->lock
);
4028 /* Cleanup the created session if it's the case. */
4030 destroy_app_session(app
, ua_sess
);
4035 * The application's socket is not valid. Either a bad socket
4036 * or a timeout on it. We can't inform the caller that for a
4037 * specific app, the session failed so lets continue here.
4039 ret
= 0; /* Not an error. */
4043 goto error_rcu_unlock
;
4054 * Enable event for a specific session and channel on the tracer.
4056 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
4057 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4060 struct lttng_ht_iter iter
, uiter
;
4061 struct lttng_ht_node_str
*ua_chan_node
;
4062 struct ust_app
*app
;
4063 struct ust_app_session
*ua_sess
;
4064 struct ust_app_channel
*ua_chan
;
4065 struct ust_app_event
*ua_event
;
4067 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
4068 uevent
->attr
.name
, usess
->id
);
4071 * NOTE: At this point, this function is called only if the session and
4072 * channel passed are already created for all apps. and enabled on the
4078 /* For all registered applications */
4079 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4080 if (!app
->compatible
) {
4082 * TODO: In time, we should notice the caller of this error by
4083 * telling him that this is a version error.
4087 ua_sess
= lookup_session_by_app(usess
, app
);
4089 /* The application has problem or is probably dead. */
4093 pthread_mutex_lock(&ua_sess
->lock
);
4095 if (ua_sess
->deleted
) {
4096 pthread_mutex_unlock(&ua_sess
->lock
);
4100 /* Lookup channel in the ust app session */
4101 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4102 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4104 * It is possible that the channel cannot be found is
4105 * the channel/event creation occurs concurrently with
4106 * an application exit.
4108 if (!ua_chan_node
) {
4109 pthread_mutex_unlock(&ua_sess
->lock
);
4113 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4115 /* Get event node */
4116 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4117 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4118 if (ua_event
== NULL
) {
4119 DBG3("UST app enable event %s not found for app PID %d."
4120 "Skipping app", uevent
->attr
.name
, app
->pid
);
4124 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4126 pthread_mutex_unlock(&ua_sess
->lock
);
4130 pthread_mutex_unlock(&ua_sess
->lock
);
4139 * For a specific existing UST session and UST channel, creates the event for
4140 * all registered apps.
4142 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
4143 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
4146 struct lttng_ht_iter iter
, uiter
;
4147 struct lttng_ht_node_str
*ua_chan_node
;
4148 struct ust_app
*app
;
4149 struct ust_app_session
*ua_sess
;
4150 struct ust_app_channel
*ua_chan
;
4152 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
4153 uevent
->attr
.name
, usess
->id
);
4157 /* For all registered applications */
4158 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4159 if (!app
->compatible
) {
4161 * TODO: In time, we should notice the caller of this error by
4162 * telling him that this is a version error.
4166 ua_sess
= lookup_session_by_app(usess
, app
);
4168 /* The application has problem or is probably dead. */
4172 pthread_mutex_lock(&ua_sess
->lock
);
4174 if (ua_sess
->deleted
) {
4175 pthread_mutex_unlock(&ua_sess
->lock
);
4179 /* Lookup channel in the ust app session */
4180 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4181 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4182 /* If the channel is not found, there is a code flow error */
4183 assert(ua_chan_node
);
4185 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4187 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4188 pthread_mutex_unlock(&ua_sess
->lock
);
4190 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
4191 /* Possible value at this point: -ENOMEM. If so, we stop! */
4194 DBG2("UST app event %s already exist on app PID %d",
4195 uevent
->attr
.name
, app
->pid
);
4206 * Start tracing for a specific UST session and app.
4209 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4212 struct ust_app_session
*ua_sess
;
4214 DBG("Starting tracing for ust app pid %d", app
->pid
);
4218 if (!app
->compatible
) {
4222 ua_sess
= lookup_session_by_app(usess
, app
);
4223 if (ua_sess
== NULL
) {
4224 /* The session is in teardown process. Ignore and continue. */
4228 pthread_mutex_lock(&ua_sess
->lock
);
4230 if (ua_sess
->deleted
) {
4231 pthread_mutex_unlock(&ua_sess
->lock
);
4235 /* Upon restart, we skip the setup, already done */
4236 if (ua_sess
->started
) {
4240 /* Create directories if consumer is LOCAL and has a path defined. */
4241 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
4242 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
4243 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
4244 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
4246 if (errno
!= EEXIST
) {
4247 ERR("Trace directory creation error");
4254 * Create the metadata for the application. This returns gracefully if a
4255 * metadata was already set for the session.
4257 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
4262 health_code_update();
4265 /* This start the UST tracing */
4266 pthread_mutex_lock(&app
->sock_lock
);
4267 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
4268 pthread_mutex_unlock(&app
->sock_lock
);
4270 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4271 ERR("Error starting tracing for app pid: %d (ret: %d)",
4274 DBG("UST app start session failed. Application is dead.");
4276 * This is normal behavior, an application can die during the
4277 * creation process. Don't report an error so the execution can
4278 * continue normally.
4280 pthread_mutex_unlock(&ua_sess
->lock
);
4286 /* Indicate that the session has been started once */
4287 ua_sess
->started
= 1;
4289 pthread_mutex_unlock(&ua_sess
->lock
);
4291 health_code_update();
4293 /* Quiescent wait after starting trace */
4294 pthread_mutex_lock(&app
->sock_lock
);
4295 ret
= ustctl_wait_quiescent(app
->sock
);
4296 pthread_mutex_unlock(&app
->sock_lock
);
4297 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4298 ERR("UST app wait quiescent failed for app pid %d ret %d",
4304 health_code_update();
4308 pthread_mutex_unlock(&ua_sess
->lock
);
4310 health_code_update();
4315 * Stop tracing for a specific UST session and app.
4318 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4321 struct ust_app_session
*ua_sess
;
4322 struct ust_registry_session
*registry
;
4324 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4328 if (!app
->compatible
) {
4329 goto end_no_session
;
4332 ua_sess
= lookup_session_by_app(usess
, app
);
4333 if (ua_sess
== NULL
) {
4334 goto end_no_session
;
4337 pthread_mutex_lock(&ua_sess
->lock
);
4339 if (ua_sess
->deleted
) {
4340 pthread_mutex_unlock(&ua_sess
->lock
);
4341 goto end_no_session
;
4345 * If started = 0, it means that stop trace has been called for a session
4346 * that was never started. It's possible since we can have a fail start
4347 * from either the application manager thread or the command thread. Simply
4348 * indicate that this is a stop error.
4350 if (!ua_sess
->started
) {
4351 goto error_rcu_unlock
;
4354 health_code_update();
4356 /* This inhibits UST tracing */
4357 pthread_mutex_lock(&app
->sock_lock
);
4358 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4359 pthread_mutex_unlock(&app
->sock_lock
);
4361 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4362 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4365 DBG("UST app stop session failed. Application is dead.");
4367 * This is normal behavior, an application can die during the
4368 * creation process. Don't report an error so the execution can
4369 * continue normally.
4373 goto error_rcu_unlock
;
4376 health_code_update();
4378 /* Quiescent wait after stopping trace */
4379 pthread_mutex_lock(&app
->sock_lock
);
4380 ret
= ustctl_wait_quiescent(app
->sock
);
4381 pthread_mutex_unlock(&app
->sock_lock
);
4382 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4383 ERR("UST app wait quiescent failed for app pid %d ret %d",
4387 health_code_update();
4389 registry
= get_session_registry(ua_sess
);
4392 /* Push metadata for application before freeing the application. */
4393 (void) push_metadata(registry
, ua_sess
->consumer
);
4396 pthread_mutex_unlock(&ua_sess
->lock
);
4399 health_code_update();
4403 pthread_mutex_unlock(&ua_sess
->lock
);
4405 health_code_update();
4410 int ust_app_flush_app_session(struct ust_app
*app
,
4411 struct ust_app_session
*ua_sess
)
4413 int ret
, retval
= 0;
4414 struct lttng_ht_iter iter
;
4415 struct ust_app_channel
*ua_chan
;
4416 struct consumer_socket
*socket
;
4418 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4422 if (!app
->compatible
) {
4423 goto end_not_compatible
;
4426 pthread_mutex_lock(&ua_sess
->lock
);
4428 if (ua_sess
->deleted
) {
4432 health_code_update();
4434 /* Flushing buffers */
4435 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4438 /* Flush buffers and push metadata. */
4439 switch (ua_sess
->buffer_type
) {
4440 case LTTNG_BUFFER_PER_PID
:
4441 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4443 health_code_update();
4444 assert(ua_chan
->is_sent
);
4445 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4447 ERR("Error flushing consumer channel");
4453 case LTTNG_BUFFER_PER_UID
:
4459 health_code_update();
4462 pthread_mutex_unlock(&ua_sess
->lock
);
4466 health_code_update();
4471 * Flush buffers for all applications for a specific UST session.
4472 * Called with UST session lock held.
4475 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4480 DBG("Flushing session buffers for all ust apps");
4484 /* Flush buffers and push metadata. */
4485 switch (usess
->buffer_type
) {
4486 case LTTNG_BUFFER_PER_UID
:
4488 struct buffer_reg_uid
*reg
;
4489 struct lttng_ht_iter iter
;
4491 /* Flush all per UID buffers associated to that session. */
4492 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4493 struct ust_registry_session
*ust_session_reg
;
4494 struct buffer_reg_channel
*reg_chan
;
4495 struct consumer_socket
*socket
;
4497 /* Get consumer socket to use to push the metadata.*/
4498 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4501 /* Ignore request if no consumer is found for the session. */
4505 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4506 reg_chan
, node
.node
) {
4508 * The following call will print error values so the return
4509 * code is of little importance because whatever happens, we
4510 * have to try them all.
4512 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4515 ust_session_reg
= reg
->registry
->reg
.ust
;
4516 /* Push metadata. */
4517 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4521 case LTTNG_BUFFER_PER_PID
:
4523 struct ust_app_session
*ua_sess
;
4524 struct lttng_ht_iter iter
;
4525 struct ust_app
*app
;
4527 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4528 ua_sess
= lookup_session_by_app(usess
, app
);
4529 if (ua_sess
== NULL
) {
4532 (void) ust_app_flush_app_session(app
, ua_sess
);
4543 health_code_update();
4548 * Destroy a specific UST session in apps.
4550 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4553 struct ust_app_session
*ua_sess
;
4554 struct lttng_ht_iter iter
;
4555 struct lttng_ht_node_u64
*node
;
4557 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4561 if (!app
->compatible
) {
4565 __lookup_session_by_app(usess
, app
, &iter
);
4566 node
= lttng_ht_iter_get_node_u64(&iter
);
4568 /* Session is being or is deleted. */
4571 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4573 health_code_update();
4574 destroy_app_session(app
, ua_sess
);
4576 health_code_update();
4578 /* Quiescent wait after stopping trace */
4579 pthread_mutex_lock(&app
->sock_lock
);
4580 ret
= ustctl_wait_quiescent(app
->sock
);
4581 pthread_mutex_unlock(&app
->sock_lock
);
4582 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4583 ERR("UST app wait quiescent failed for app pid %d ret %d",
4588 health_code_update();
4593 * Start tracing for the UST session.
4595 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4598 struct lttng_ht_iter iter
;
4599 struct ust_app
*app
;
4601 DBG("Starting all UST traces");
4605 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4606 ret
= ust_app_start_trace(usess
, app
);
4608 /* Continue to next apps even on error */
4619 * Start tracing for the UST session.
4620 * Called with UST session lock held.
4622 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4625 struct lttng_ht_iter iter
;
4626 struct ust_app
*app
;
4628 DBG("Stopping all UST traces");
4632 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4633 ret
= ust_app_stop_trace(usess
, app
);
4635 /* Continue to next apps even on error */
4640 (void) ust_app_flush_session(usess
);
4648 * Destroy app UST session.
4650 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4653 struct lttng_ht_iter iter
;
4654 struct ust_app
*app
;
4656 DBG("Destroy all UST traces");
4660 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4661 ret
= destroy_trace(usess
, app
);
4663 /* Continue to next apps even on error */
4674 void ust_app_global_create(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4677 struct lttng_ht_iter iter
, uiter
;
4678 struct ust_app_session
*ua_sess
= NULL
;
4679 struct ust_app_channel
*ua_chan
;
4680 struct ust_app_event
*ua_event
;
4681 struct ust_app_ctx
*ua_ctx
;
4684 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &is_created
);
4686 /* Tracer is probably gone or ENOMEM. */
4690 /* App session already created. */
4695 pthread_mutex_lock(&ua_sess
->lock
);
4697 if (ua_sess
->deleted
) {
4698 pthread_mutex_unlock(&ua_sess
->lock
);
4703 * We can iterate safely here over all UST app session since the create ust
4704 * app session above made a shadow copy of the UST global domain from the
4707 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4709 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4710 if (ret
< 0 && ret
!= -ENOTCONN
) {
4712 * Stop everything. On error, the application
4713 * failed, no more file descriptor are available
4714 * or ENOMEM so stopping here is the only thing
4715 * we can do for now. The only exception is
4716 * -ENOTCONN, which indicates that the application
4723 * Add context using the list so they are enabled in the same order the
4726 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4727 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4734 /* For each events */
4735 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4737 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4744 pthread_mutex_unlock(&ua_sess
->lock
);
4746 if (usess
->active
) {
4747 ret
= ust_app_start_trace(usess
, app
);
4752 DBG2("UST trace started for app pid %d", app
->pid
);
4755 /* Everything went well at this point. */
4759 pthread_mutex_unlock(&ua_sess
->lock
);
4762 destroy_app_session(app
, ua_sess
);
4768 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4770 struct ust_app_session
*ua_sess
;
4772 ua_sess
= lookup_session_by_app(usess
, app
);
4773 if (ua_sess
== NULL
) {
4776 destroy_app_session(app
, ua_sess
);
4780 * Add channels/events from UST global domain to registered apps at sock.
4782 * Called with session lock held.
4783 * Called with RCU read-side lock held.
4785 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4789 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
4790 app
->sock
, usess
->id
);
4792 if (!app
->compatible
) {
4796 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4797 ust_app_global_create(usess
, app
);
4799 ust_app_global_destroy(usess
, app
);
4804 * Called with session lock held.
4806 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
4808 struct lttng_ht_iter iter
;
4809 struct ust_app
*app
;
4812 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4813 ust_app_global_update(usess
, app
);
4819 * Add context to a specific channel for global UST domain.
4821 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4822 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4825 struct lttng_ht_node_str
*ua_chan_node
;
4826 struct lttng_ht_iter iter
, uiter
;
4827 struct ust_app_channel
*ua_chan
= NULL
;
4828 struct ust_app_session
*ua_sess
;
4829 struct ust_app
*app
;
4833 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4834 if (!app
->compatible
) {
4836 * TODO: In time, we should notice the caller of this error by
4837 * telling him that this is a version error.
4841 ua_sess
= lookup_session_by_app(usess
, app
);
4842 if (ua_sess
== NULL
) {
4846 pthread_mutex_lock(&ua_sess
->lock
);
4848 if (ua_sess
->deleted
) {
4849 pthread_mutex_unlock(&ua_sess
->lock
);
4853 /* Lookup channel in the ust app session */
4854 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4855 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4856 if (ua_chan_node
== NULL
) {
4859 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4861 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4866 pthread_mutex_unlock(&ua_sess
->lock
);
4874 * Enable event for a channel from a UST session for a specific PID.
4876 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4877 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4880 struct lttng_ht_iter iter
;
4881 struct lttng_ht_node_str
*ua_chan_node
;
4882 struct ust_app
*app
;
4883 struct ust_app_session
*ua_sess
;
4884 struct ust_app_channel
*ua_chan
;
4885 struct ust_app_event
*ua_event
;
4887 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4891 app
= ust_app_find_by_pid(pid
);
4893 ERR("UST app enable event per PID %d not found", pid
);
4898 if (!app
->compatible
) {
4903 ua_sess
= lookup_session_by_app(usess
, app
);
4905 /* The application has problem or is probably dead. */
4910 pthread_mutex_lock(&ua_sess
->lock
);
4912 if (ua_sess
->deleted
) {
4917 /* Lookup channel in the ust app session */
4918 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4919 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4920 /* If the channel is not found, there is a code flow error */
4921 assert(ua_chan_node
);
4923 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4925 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4926 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4927 if (ua_event
== NULL
) {
4928 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4933 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4940 pthread_mutex_unlock(&ua_sess
->lock
);
4947 * Calibrate registered applications.
4949 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4952 struct lttng_ht_iter iter
;
4953 struct ust_app
*app
;
4957 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4958 if (!app
->compatible
) {
4960 * TODO: In time, we should notice the caller of this error by
4961 * telling him that this is a version error.
4966 health_code_update();
4968 pthread_mutex_lock(&app
->sock_lock
);
4969 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4970 pthread_mutex_unlock(&app
->sock_lock
);
4974 /* Means that it's not implemented on the tracer side. */
4978 DBG2("Calibrate app PID %d returned with error %d",
4985 DBG("UST app global domain calibration finished");
4989 health_code_update();
4995 * Receive registration and populate the given msg structure.
4997 * On success return 0 else a negative value returned by the ustctl call.
4999 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
5002 uint32_t pid
, ppid
, uid
, gid
;
5006 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
5007 &pid
, &ppid
, &uid
, &gid
,
5008 &msg
->bits_per_long
,
5009 &msg
->uint8_t_alignment
,
5010 &msg
->uint16_t_alignment
,
5011 &msg
->uint32_t_alignment
,
5012 &msg
->uint64_t_alignment
,
5013 &msg
->long_alignment
,
5020 case LTTNG_UST_ERR_EXITING
:
5021 DBG3("UST app recv reg message failed. Application died");
5023 case LTTNG_UST_ERR_UNSUP_MAJOR
:
5024 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
5025 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
5026 LTTNG_UST_ABI_MINOR_VERSION
);
5029 ERR("UST app recv reg message failed with ret %d", ret
);
5034 msg
->pid
= (pid_t
) pid
;
5035 msg
->ppid
= (pid_t
) ppid
;
5036 msg
->uid
= (uid_t
) uid
;
5037 msg
->gid
= (gid_t
) gid
;
5044 * Return a ust app session object using the application object and the
5045 * session object descriptor has a key. If not found, NULL is returned.
5046 * A RCU read side lock MUST be acquired when calling this function.
5048 static struct ust_app_session
*find_session_by_objd(struct ust_app
*app
,
5051 struct lttng_ht_node_ulong
*node
;
5052 struct lttng_ht_iter iter
;
5053 struct ust_app_session
*ua_sess
= NULL
;
5057 lttng_ht_lookup(app
->ust_sessions_objd
, (void *)((unsigned long) objd
), &iter
);
5058 node
= lttng_ht_iter_get_node_ulong(&iter
);
5060 DBG2("UST app session find by objd %d not found", objd
);
5064 ua_sess
= caa_container_of(node
, struct ust_app_session
, ust_objd_node
);
5071 * Return a ust app channel object using the application object and the channel
5072 * object descriptor has a key. If not found, NULL is returned. A RCU read side
5073 * lock MUST be acquired before calling this function.
5075 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
5078 struct lttng_ht_node_ulong
*node
;
5079 struct lttng_ht_iter iter
;
5080 struct ust_app_channel
*ua_chan
= NULL
;
5084 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
5085 node
= lttng_ht_iter_get_node_ulong(&iter
);
5087 DBG2("UST app channel find by objd %d not found", objd
);
5091 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
5098 * Reply to a register channel notification from an application on the notify
5099 * socket. The channel metadata is also created.
5101 * The session UST registry lock is acquired in this function.
5103 * On success 0 is returned else a negative value.
5105 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
5106 size_t nr_fields
, struct ustctl_field
*fields
)
5108 int ret
, ret_code
= 0;
5109 uint32_t chan_id
, reg_count
;
5110 uint64_t chan_reg_key
;
5111 enum ustctl_channel_header type
;
5112 struct ust_app
*app
;
5113 struct ust_app_channel
*ua_chan
;
5114 struct ust_app_session
*ua_sess
;
5115 struct ust_registry_session
*registry
;
5116 struct ust_registry_channel
*chan_reg
;
5120 /* Lookup application. If not found, there is a code flow error. */
5121 app
= find_app_by_notify_sock(sock
);
5123 DBG("Application socket %d is being teardown. Abort event notify",
5127 goto error_rcu_unlock
;
5130 /* Lookup channel by UST object descriptor. */
5131 ua_chan
= find_channel_by_objd(app
, cobjd
);
5133 DBG("Application channel is being teardown. Abort event notify");
5136 goto error_rcu_unlock
;
5139 assert(ua_chan
->session
);
5140 ua_sess
= ua_chan
->session
;
5142 /* Get right session registry depending on the session buffer type. */
5143 registry
= get_session_registry(ua_sess
);
5146 /* Depending on the buffer type, a different channel key is used. */
5147 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5148 chan_reg_key
= ua_chan
->tracing_channel_id
;
5150 chan_reg_key
= ua_chan
->key
;
5153 pthread_mutex_lock(®istry
->lock
);
5155 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
5158 if (!chan_reg
->register_done
) {
5159 reg_count
= ust_registry_get_event_count(chan_reg
);
5160 if (reg_count
< 31) {
5161 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
5163 type
= USTCTL_CHANNEL_HEADER_LARGE
;
5166 chan_reg
->nr_ctx_fields
= nr_fields
;
5167 chan_reg
->ctx_fields
= fields
;
5168 chan_reg
->header_type
= type
;
5170 /* Get current already assigned values. */
5171 type
= chan_reg
->header_type
;
5173 /* Set to NULL so the error path does not do a double free. */
5176 /* Channel id is set during the object creation. */
5177 chan_id
= chan_reg
->chan_id
;
5179 /* Append to metadata */
5180 if (!chan_reg
->metadata_dumped
) {
5181 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
5183 ERR("Error appending channel metadata (errno = %d)", ret_code
);
5189 DBG3("UST app replying to register channel key %" PRIu64
5190 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
5193 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
5195 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5196 ERR("UST app reply channel failed with ret %d", ret
);
5198 DBG3("UST app reply channel failed. Application died");
5203 /* This channel registry registration is completed. */
5204 chan_reg
->register_done
= 1;
5207 pthread_mutex_unlock(®istry
->lock
);
5217 * Add event to the UST channel registry. When the event is added to the
5218 * registry, the metadata is also created. Once done, this replies to the
5219 * application with the appropriate error code.
5221 * The session UST registry lock is acquired in the function.
5223 * On success 0 is returned else a negative value.
5225 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
5226 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
,
5227 int loglevel_value
, char *model_emf_uri
)
5230 uint32_t event_id
= 0;
5231 uint64_t chan_reg_key
;
5232 struct ust_app
*app
;
5233 struct ust_app_channel
*ua_chan
;
5234 struct ust_app_session
*ua_sess
;
5235 struct ust_registry_session
*registry
;
5239 /* Lookup application. If not found, there is a code flow error. */
5240 app
= find_app_by_notify_sock(sock
);
5242 DBG("Application socket %d is being teardown. Abort event notify",
5247 free(model_emf_uri
);
5248 goto error_rcu_unlock
;
5251 /* Lookup channel by UST object descriptor. */
5252 ua_chan
= find_channel_by_objd(app
, cobjd
);
5254 DBG("Application channel is being teardown. Abort event notify");
5258 free(model_emf_uri
);
5259 goto error_rcu_unlock
;
5262 assert(ua_chan
->session
);
5263 ua_sess
= ua_chan
->session
;
5265 registry
= get_session_registry(ua_sess
);
5268 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
5269 chan_reg_key
= ua_chan
->tracing_channel_id
;
5271 chan_reg_key
= ua_chan
->key
;
5274 pthread_mutex_lock(®istry
->lock
);
5277 * From this point on, this call acquires the ownership of the sig, fields
5278 * and model_emf_uri meaning any free are done inside it if needed. These
5279 * three variables MUST NOT be read/write after this.
5281 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
5282 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
,
5283 loglevel_value
, model_emf_uri
, ua_sess
->buffer_type
,
5287 * The return value is returned to ustctl so in case of an error, the
5288 * application can be notified. In case of an error, it's important not to
5289 * return a negative error or else the application will get closed.
5291 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
5293 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5294 ERR("UST app reply event failed with ret %d", ret
);
5296 DBG3("UST app reply event failed. Application died");
5299 * No need to wipe the create event since the application socket will
5300 * get close on error hence cleaning up everything by itself.
5305 DBG3("UST registry event %s with id %" PRId32
" added successfully",
5309 pthread_mutex_unlock(®istry
->lock
);
5316 * Add enum to the UST session registry. Once done, this replies to the
5317 * application with the appropriate error code.
5319 * The session UST registry lock is acquired within this function.
5321 * On success 0 is returned else a negative value.
5323 static int add_enum_ust_registry(int sock
, int sobjd
, char *name
,
5324 struct ustctl_enum_entry
*entries
, size_t nr_entries
)
5326 int ret
= 0, ret_code
;
5327 struct ust_app
*app
;
5328 struct ust_app_session
*ua_sess
;
5329 struct ust_registry_session
*registry
;
5330 uint64_t enum_id
= -1ULL;
5334 /* Lookup application. If not found, there is a code flow error. */
5335 app
= find_app_by_notify_sock(sock
);
5337 /* Return an error since this is not an error */
5338 DBG("Application socket %d is being torn down. Aborting enum registration",
5341 goto error_rcu_unlock
;
5344 /* Lookup session by UST object descriptor. */
5345 ua_sess
= find_session_by_objd(app
, sobjd
);
5347 /* Return an error since this is not an error */
5348 DBG("Application session is being torn down. Aborting enum registration.");
5350 goto error_rcu_unlock
;
5353 registry
= get_session_registry(ua_sess
);
5356 pthread_mutex_lock(®istry
->lock
);
5359 * From this point on, the callee acquires the ownership of
5360 * entries. The variable entries MUST NOT be read/written after
5363 ret_code
= ust_registry_create_or_find_enum(registry
, sobjd
, name
,
5364 entries
, nr_entries
, &enum_id
);
5368 * The return value is returned to ustctl so in case of an error, the
5369 * application can be notified. In case of an error, it's important not to
5370 * return a negative error or else the application will get closed.
5372 ret
= ustctl_reply_register_enum(sock
, enum_id
, ret_code
);
5374 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5375 ERR("UST app reply enum failed with ret %d", ret
);
5377 DBG3("UST app reply enum failed. Application died");
5380 * No need to wipe the create enum since the application socket will
5381 * get close on error hence cleaning up everything by itself.
5386 DBG3("UST registry enum %s added successfully or already found", name
);
5389 pthread_mutex_unlock(®istry
->lock
);
5396 * Handle application notification through the given notify socket.
5398 * Return 0 on success or else a negative value.
5400 int ust_app_recv_notify(int sock
)
5403 enum ustctl_notify_cmd cmd
;
5405 DBG3("UST app receiving notify from sock %d", sock
);
5407 ret
= ustctl_recv_notify(sock
, &cmd
);
5409 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5410 ERR("UST app recv notify failed with ret %d", ret
);
5412 DBG3("UST app recv notify failed. Application died");
5418 case USTCTL_NOTIFY_CMD_EVENT
:
5420 int sobjd
, cobjd
, loglevel_value
;
5421 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
5423 struct ustctl_field
*fields
;
5425 DBG2("UST app ustctl register event received");
5427 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
,
5428 &loglevel_value
, &sig
, &nr_fields
, &fields
,
5431 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5432 ERR("UST app recv event failed with ret %d", ret
);
5434 DBG3("UST app recv event failed. Application died");
5440 * Add event to the UST registry coming from the notify socket. This
5441 * call will free if needed the sig, fields and model_emf_uri. This
5442 * code path loses the ownsership of these variables and transfer them
5443 * to the this function.
5445 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5446 fields
, loglevel_value
, model_emf_uri
);
5453 case USTCTL_NOTIFY_CMD_CHANNEL
:
5457 struct ustctl_field
*fields
;
5459 DBG2("UST app ustctl register channel received");
5461 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5464 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5465 ERR("UST app recv channel failed with ret %d", ret
);
5467 DBG3("UST app recv channel failed. Application died");
5473 * The fields ownership are transfered to this function call meaning
5474 * that if needed it will be freed. After this, it's invalid to access
5475 * fields or clean it up.
5477 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
5485 case USTCTL_NOTIFY_CMD_ENUM
:
5488 char name
[LTTNG_UST_SYM_NAME_LEN
];
5490 struct ustctl_enum_entry
*entries
;
5492 DBG2("UST app ustctl register enum received");
5494 ret
= ustctl_recv_register_enum(sock
, &sobjd
, name
,
5495 &entries
, &nr_entries
);
5497 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5498 ERR("UST app recv enum failed with ret %d", ret
);
5500 DBG3("UST app recv enum failed. Application died");
5505 /* Callee assumes ownership of entries */
5506 ret
= add_enum_ust_registry(sock
, sobjd
, name
,
5507 entries
, nr_entries
);
5515 /* Should NEVER happen. */
5524 * Once the notify socket hangs up, this is called. First, it tries to find the
5525 * corresponding application. On failure, the call_rcu to close the socket is
5526 * executed. If an application is found, it tries to delete it from the notify
5527 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5529 * Note that an object needs to be allocated here so on ENOMEM failure, the
5530 * call RCU is not done but the rest of the cleanup is.
5532 void ust_app_notify_sock_unregister(int sock
)
5535 struct lttng_ht_iter iter
;
5536 struct ust_app
*app
;
5537 struct ust_app_notify_sock_obj
*obj
;
5543 obj
= zmalloc(sizeof(*obj
));
5546 * An ENOMEM is kind of uncool. If this strikes we continue the
5547 * procedure but the call_rcu will not be called. In this case, we
5548 * accept the fd leak rather than possibly creating an unsynchronized
5549 * state between threads.
5551 * TODO: The notify object should be created once the notify socket is
5552 * registered and stored independantely from the ust app object. The
5553 * tricky part is to synchronize the teardown of the application and
5554 * this notify object. Let's keep that in mind so we can avoid this
5555 * kind of shenanigans with ENOMEM in the teardown path.
5562 DBG("UST app notify socket unregister %d", sock
);
5565 * Lookup application by notify socket. If this fails, this means that the
5566 * hash table delete has already been done by the application
5567 * unregistration process so we can safely close the notify socket in a
5570 app
= find_app_by_notify_sock(sock
);
5575 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5578 * Whatever happens here either we fail or succeed, in both cases we have
5579 * to close the socket after a grace period to continue to the call RCU
5580 * here. If the deletion is successful, the application is not visible
5581 * anymore by other threads and is it fails it means that it was already
5582 * deleted from the hash table so either way we just have to close the
5585 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5591 * Close socket after a grace period to avoid for the socket to be reused
5592 * before the application object is freed creating potential race between
5593 * threads trying to add unique in the global hash table.
5596 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5601 * Destroy a ust app data structure and free its memory.
5603 void ust_app_destroy(struct ust_app
*app
)
5609 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5613 * Take a snapshot for a given UST session. The snapshot is sent to the given
5616 * Return 0 on success or else a negative value.
5618 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5619 struct snapshot_output
*output
, int wait
,
5620 uint64_t nb_packets_per_stream
)
5623 unsigned int snapshot_done
= 0;
5624 struct lttng_ht_iter iter
;
5625 struct ust_app
*app
;
5626 char pathname
[PATH_MAX
];
5633 switch (usess
->buffer_type
) {
5634 case LTTNG_BUFFER_PER_UID
:
5636 struct buffer_reg_uid
*reg
;
5638 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5639 struct buffer_reg_channel
*reg_chan
;
5640 struct consumer_socket
*socket
;
5642 /* Get consumer socket to use to push the metadata.*/
5643 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5650 memset(pathname
, 0, sizeof(pathname
));
5651 ret
= snprintf(pathname
, sizeof(pathname
),
5652 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5653 reg
->uid
, reg
->bits_per_long
);
5655 PERROR("snprintf snapshot path");
5659 /* Add the UST default trace dir to path. */
5660 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5661 reg_chan
, node
.node
) {
5662 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5663 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5664 nb_packets_per_stream
);
5669 ret
= consumer_snapshot_channel(socket
,
5670 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5671 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5679 case LTTNG_BUFFER_PER_PID
:
5681 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5682 struct consumer_socket
*socket
;
5683 struct lttng_ht_iter chan_iter
;
5684 struct ust_app_channel
*ua_chan
;
5685 struct ust_app_session
*ua_sess
;
5686 struct ust_registry_session
*registry
;
5688 ua_sess
= lookup_session_by_app(usess
, app
);
5690 /* Session not associated with this app. */
5694 /* Get the right consumer socket for the application. */
5695 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5702 /* Add the UST default trace dir to path. */
5703 memset(pathname
, 0, sizeof(pathname
));
5704 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5707 PERROR("snprintf snapshot path");
5711 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5712 ua_chan
, node
.node
) {
5713 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5714 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5715 nb_packets_per_stream
);
5721 registry
= get_session_registry(ua_sess
);
5723 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5724 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5737 if (!snapshot_done
) {
5739 * If no snapshot was made and we are not in the error path, this means
5740 * that there are no buffers thus no (prior) application to snapshot
5741 * data from so we have simply NO data.
5752 * Return the size taken by one more packet per stream.
5754 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5755 uint64_t cur_nr_packets
)
5757 uint64_t tot_size
= 0;
5758 struct ust_app
*app
;
5759 struct lttng_ht_iter iter
;
5763 switch (usess
->buffer_type
) {
5764 case LTTNG_BUFFER_PER_UID
:
5766 struct buffer_reg_uid
*reg
;
5768 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5769 struct buffer_reg_channel
*reg_chan
;
5772 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5773 reg_chan
, node
.node
) {
5774 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5776 * Don't take channel into account if we
5777 * already grab all its packets.
5781 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5787 case LTTNG_BUFFER_PER_PID
:
5790 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5791 struct ust_app_channel
*ua_chan
;
5792 struct ust_app_session
*ua_sess
;
5793 struct lttng_ht_iter chan_iter
;
5795 ua_sess
= lookup_session_by_app(usess
, app
);
5797 /* Session not associated with this app. */
5801 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5802 ua_chan
, node
.node
) {
5803 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5805 * Don't take channel into account if we
5806 * already grab all its packets.
5810 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;