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.
27 #include <sys/types.h>
29 #include <urcu/compiler.h>
30 #include <lttng/ust-error.h>
33 #include <common/common.h>
34 #include <common/sessiond-comm/sessiond-comm.h>
36 #include "buffer-registry.h"
38 #include "health-sessiond.h"
40 #include "ust-consumer.h"
45 int ust_app_flush_app_session(struct ust_app
*app
, struct ust_app_session
*ua_sess
);
47 /* Next available channel key. Access under next_channel_key_lock. */
48 static uint64_t _next_channel_key
;
49 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
51 /* Next available session ID. Access under next_session_id_lock. */
52 static uint64_t _next_session_id
;
53 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
56 * Return the incremented value of next_channel_key.
58 static uint64_t get_next_channel_key(void)
62 pthread_mutex_lock(&next_channel_key_lock
);
63 ret
= ++_next_channel_key
;
64 pthread_mutex_unlock(&next_channel_key_lock
);
69 * Return the atomically incremented value of next_session_id.
71 static uint64_t get_next_session_id(void)
75 pthread_mutex_lock(&next_session_id_lock
);
76 ret
= ++_next_session_id
;
77 pthread_mutex_unlock(&next_session_id_lock
);
81 static void copy_channel_attr_to_ustctl(
82 struct ustctl_consumer_channel_attr
*attr
,
83 struct lttng_ust_channel_attr
*uattr
)
85 /* Copy event attributes since the layout is different. */
86 attr
->subbuf_size
= uattr
->subbuf_size
;
87 attr
->num_subbuf
= uattr
->num_subbuf
;
88 attr
->overwrite
= uattr
->overwrite
;
89 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
90 attr
->read_timer_interval
= uattr
->read_timer_interval
;
91 attr
->output
= uattr
->output
;
95 * Match function for the hash table lookup.
97 * It matches an ust app event based on three attributes which are the event
98 * name, the filter bytecode and the loglevel.
100 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
102 struct ust_app_event
*event
;
103 const struct ust_app_ht_key
*key
;
108 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
111 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
114 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
118 /* Event loglevel. */
119 if (event
->attr
.loglevel
!= key
->loglevel
) {
120 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
121 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
123 * Match is accepted. This is because on event creation, the
124 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
125 * -1 are accepted for this loglevel type since 0 is the one set by
126 * the API when receiving an enable event.
133 /* One of the filters is NULL, fail. */
134 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
138 if (key
->filter
&& event
->filter
) {
139 /* Both filters exists, check length followed by the bytecode. */
140 if (event
->filter
->len
!= key
->filter
->len
||
141 memcmp(event
->filter
->data
, key
->filter
->data
,
142 event
->filter
->len
) != 0) {
147 /* One of the exclusions is NULL, fail. */
148 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
152 if (key
->exclusion
&& event
->exclusion
) {
153 /* Both exclusions exists, check count followed by the names. */
154 if (event
->exclusion
->count
!= key
->exclusion
->count
||
155 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
156 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
170 * Unique add of an ust app event in the given ht. This uses the custom
171 * ht_match_ust_app_event match function and the event name as hash.
173 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
174 struct ust_app_event
*event
)
176 struct cds_lfht_node
*node_ptr
;
177 struct ust_app_ht_key key
;
181 assert(ua_chan
->events
);
184 ht
= ua_chan
->events
;
185 key
.name
= event
->attr
.name
;
186 key
.filter
= event
->filter
;
187 key
.loglevel
= event
->attr
.loglevel
;
188 key
.exclusion
= event
->exclusion
;
190 node_ptr
= cds_lfht_add_unique(ht
->ht
,
191 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
192 ht_match_ust_app_event
, &key
, &event
->node
.node
);
193 assert(node_ptr
== &event
->node
.node
);
197 * Close the notify socket from the given RCU head object. This MUST be called
198 * through a call_rcu().
200 static void close_notify_sock_rcu(struct rcu_head
*head
)
203 struct ust_app_notify_sock_obj
*obj
=
204 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
206 /* Must have a valid fd here. */
207 assert(obj
->fd
>= 0);
209 ret
= close(obj
->fd
);
211 ERR("close notify sock %d RCU", obj
->fd
);
213 lttng_fd_put(LTTNG_FD_APPS
, 1);
219 * Return the session registry according to the buffer type of the given
222 * A registry per UID object MUST exists before calling this function or else
223 * it assert() if not found. RCU read side lock must be acquired.
225 static struct ust_registry_session
*get_session_registry(
226 struct ust_app_session
*ua_sess
)
228 struct ust_registry_session
*registry
= NULL
;
232 switch (ua_sess
->buffer_type
) {
233 case LTTNG_BUFFER_PER_PID
:
235 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
239 registry
= reg_pid
->registry
->reg
.ust
;
242 case LTTNG_BUFFER_PER_UID
:
244 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
245 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
249 registry
= reg_uid
->registry
->reg
.ust
;
261 * Delete ust context safely. RCU read lock must be held before calling
265 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
272 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
273 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
274 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
275 sock
, ua_ctx
->obj
->handle
, ret
);
283 * Delete ust app event safely. RCU read lock must be held before calling
287 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
293 free(ua_event
->filter
);
294 if (ua_event
->exclusion
!= NULL
)
295 free(ua_event
->exclusion
);
296 if (ua_event
->obj
!= NULL
) {
297 ret
= ustctl_release_object(sock
, ua_event
->obj
);
298 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
299 ERR("UST app sock %d release event obj failed with ret %d",
308 * Release ust data object of the given stream.
310 * Return 0 on success or else a negative value.
312 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
319 ret
= ustctl_release_object(sock
, stream
->obj
);
320 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
321 ERR("UST app sock %d release stream obj failed with ret %d",
324 lttng_fd_put(LTTNG_FD_APPS
, 2);
332 * Delete ust app stream safely. RCU read lock must be held before calling
336 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
340 (void) release_ust_app_stream(sock
, stream
);
345 * We need to execute ht_destroy outside of RCU read-side critical
346 * section and outside of call_rcu thread, so we postpone its execution
347 * using ht_cleanup_push. It is simpler than to change the semantic of
348 * the many callers of delete_ust_app_session().
351 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
353 struct ust_app_channel
*ua_chan
=
354 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
356 ht_cleanup_push(ua_chan
->ctx
);
357 ht_cleanup_push(ua_chan
->events
);
362 * Delete ust app channel safely. RCU read lock must be held before calling
366 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
370 struct lttng_ht_iter iter
;
371 struct ust_app_event
*ua_event
;
372 struct ust_app_ctx
*ua_ctx
;
373 struct ust_app_stream
*stream
, *stmp
;
374 struct ust_registry_session
*registry
;
378 DBG3("UST app deleting channel %s", ua_chan
->name
);
381 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
382 cds_list_del(&stream
->list
);
383 delete_ust_app_stream(sock
, stream
);
387 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
388 cds_list_del(&ua_ctx
->list
);
389 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
391 delete_ust_app_ctx(sock
, ua_ctx
);
395 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
397 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
399 delete_ust_app_event(sock
, ua_event
);
402 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
403 /* Wipe and free registry from session registry. */
404 registry
= get_session_registry(ua_chan
->session
);
406 ust_registry_channel_del_free(registry
, ua_chan
->key
);
410 if (ua_chan
->obj
!= NULL
) {
411 /* Remove channel from application UST object descriptor. */
412 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
413 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
415 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
416 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
417 ERR("UST app sock %d release channel obj failed with ret %d",
420 lttng_fd_put(LTTNG_FD_APPS
, 1);
423 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
427 * Push metadata to consumer socket.
429 * RCU read-side lock must be held to guarantee existance of socket.
430 * Must be called with the ust app session lock held.
431 * Must be called with the registry lock held.
433 * On success, return the len of metadata pushed or else a negative value.
434 * Returning a -EPIPE return value means we could not send the metadata,
435 * but it can be caused by recoverable errors (e.g. the application has
436 * terminated concurrently).
438 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
439 struct consumer_socket
*socket
, int send_zero_data
)
442 char *metadata_str
= NULL
;
450 * Means that no metadata was assigned to the session. This can
451 * happens if no start has been done previously.
453 if (!registry
->metadata_key
) {
458 * On a push metadata error either the consumer is dead or the
459 * metadata channel has been destroyed because its endpoint
460 * might have died (e.g: relayd), or because the application has
461 * exited. If so, the metadata closed flag is set to 1 so we
462 * deny pushing metadata again which is not valid anymore on the
465 if (registry
->metadata_closed
) {
469 offset
= registry
->metadata_len_sent
;
470 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
472 DBG3("No metadata to push for metadata key %" PRIu64
,
473 registry
->metadata_key
);
475 if (send_zero_data
) {
476 DBG("No metadata to push");
482 /* Allocate only what we have to send. */
483 metadata_str
= zmalloc(len
);
485 PERROR("zmalloc ust app metadata string");
489 /* Copy what we haven't send out. */
490 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
491 registry
->metadata_len_sent
+= len
;
494 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
495 metadata_str
, len
, offset
);
498 * There is an acceptable race here between the registry
499 * metadata key assignment and the creation on the
500 * consumer. The session daemon can concurrently push
501 * metadata for this registry while being created on the
502 * consumer since the metadata key of the registry is
503 * assigned *before* it is setup to avoid the consumer
504 * to ask for metadata that could possibly be not found
505 * in the session daemon.
507 * The metadata will get pushed either by the session
508 * being stopped or the consumer requesting metadata if
509 * that race is triggered.
511 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
516 * Update back the actual metadata len sent since it
519 registry
->metadata_len_sent
-= len
;
531 * On error, flag the registry that the metadata is
532 * closed. We were unable to push anything and this
533 * means that either the consumer is not responding or
534 * the metadata cache has been destroyed on the
537 registry
->metadata_closed
= 1;
545 * For a given application and session, push metadata to consumer.
546 * Either sock or consumer is required : if sock is NULL, the default
547 * socket to send the metadata is retrieved from consumer, if sock
548 * is not NULL we use it to send the metadata.
549 * RCU read-side lock must be held while calling this function,
550 * therefore ensuring existance of registry. It also ensures existance
551 * of socket throughout this function.
553 * Return 0 on success else a negative error.
554 * Returning a -EPIPE return value means we could not send the metadata,
555 * but it can be caused by recoverable errors (e.g. the application has
556 * terminated concurrently).
558 static int push_metadata(struct ust_registry_session
*registry
,
559 struct consumer_output
*consumer
)
563 struct consumer_socket
*socket
;
568 pthread_mutex_lock(®istry
->lock
);
569 if (registry
->metadata_closed
) {
574 /* Get consumer socket to use to push the metadata.*/
575 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
582 ret
= ust_app_push_metadata(registry
, socket
, 0);
587 pthread_mutex_unlock(®istry
->lock
);
591 pthread_mutex_unlock(®istry
->lock
);
596 * Send to the consumer a close metadata command for the given session. Once
597 * done, the metadata channel is deleted and the session metadata pointer is
598 * nullified. The session lock MUST be held unless the application is
599 * in the destroy path.
601 * Return 0 on success else a negative value.
603 static int close_metadata(struct ust_registry_session
*registry
,
604 struct consumer_output
*consumer
)
607 struct consumer_socket
*socket
;
614 pthread_mutex_lock(®istry
->lock
);
616 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
621 /* Get consumer socket to use to push the metadata.*/
622 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
629 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
636 * Metadata closed. Even on error this means that the consumer is not
637 * responding or not found so either way a second close should NOT be emit
640 registry
->metadata_closed
= 1;
642 pthread_mutex_unlock(®istry
->lock
);
648 * We need to execute ht_destroy outside of RCU read-side critical
649 * section and outside of call_rcu thread, so we postpone its execution
650 * using ht_cleanup_push. It is simpler than to change the semantic of
651 * the many callers of delete_ust_app_session().
654 void delete_ust_app_session_rcu(struct rcu_head
*head
)
656 struct ust_app_session
*ua_sess
=
657 caa_container_of(head
, struct ust_app_session
, rcu_head
);
659 ht_cleanup_push(ua_sess
->channels
);
664 * Delete ust app session safely. RCU read lock must be held before calling
668 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
672 struct lttng_ht_iter iter
;
673 struct ust_app_channel
*ua_chan
;
674 struct ust_registry_session
*registry
;
678 pthread_mutex_lock(&ua_sess
->lock
);
680 registry
= get_session_registry(ua_sess
);
682 /* Push metadata for application before freeing the application. */
683 (void) push_metadata(registry
, ua_sess
->consumer
);
686 * Don't ask to close metadata for global per UID buffers. Close
687 * metadata only on destroy trace session in this case. Also, the
688 * previous push metadata could have flag the metadata registry to
689 * close so don't send a close command if closed.
691 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
692 /* And ask to close it for this session registry. */
693 (void) close_metadata(registry
, ua_sess
->consumer
);
697 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
699 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
701 delete_ust_app_channel(sock
, ua_chan
, app
);
704 /* In case of per PID, the registry is kept in the session. */
705 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
706 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
708 buffer_reg_pid_remove(reg_pid
);
709 buffer_reg_pid_destroy(reg_pid
);
713 if (ua_sess
->handle
!= -1) {
714 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
715 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
716 ERR("UST app sock %d release session handle failed with ret %d",
720 pthread_mutex_unlock(&ua_sess
->lock
);
722 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
726 * Delete a traceable application structure from the global list. Never call
727 * this function outside of a call_rcu call.
729 * RCU read side lock should _NOT_ be held when calling this function.
732 void delete_ust_app(struct ust_app
*app
)
735 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
737 /* Delete ust app sessions info */
742 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
744 /* Free every object in the session and the session. */
746 delete_ust_app_session(sock
, ua_sess
, app
);
750 ht_cleanup_push(app
->sessions
);
751 ht_cleanup_push(app
->ust_objd
);
754 * Wait until we have deleted the application from the sock hash table
755 * before closing this socket, otherwise an application could re-use the
756 * socket ID and race with the teardown, using the same hash table entry.
758 * It's OK to leave the close in call_rcu. We want it to stay unique for
759 * all RCU readers that could run concurrently with unregister app,
760 * therefore we _need_ to only close that socket after a grace period. So
761 * it should stay in this RCU callback.
763 * This close() is a very important step of the synchronization model so
764 * every modification to this function must be carefully reviewed.
770 lttng_fd_put(LTTNG_FD_APPS
, 1);
772 DBG2("UST app pid %d deleted", app
->pid
);
777 * URCU intermediate call to delete an UST app.
780 void delete_ust_app_rcu(struct rcu_head
*head
)
782 struct lttng_ht_node_ulong
*node
=
783 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
784 struct ust_app
*app
=
785 caa_container_of(node
, struct ust_app
, pid_n
);
787 DBG3("Call RCU deleting app PID %d", app
->pid
);
792 * Delete the session from the application ht and delete the data structure by
793 * freeing every object inside and releasing them.
795 static void destroy_app_session(struct ust_app
*app
,
796 struct ust_app_session
*ua_sess
)
799 struct lttng_ht_iter iter
;
804 iter
.iter
.node
= &ua_sess
->node
.node
;
805 ret
= lttng_ht_del(app
->sessions
, &iter
);
807 /* Already scheduled for teardown. */
811 /* Once deleted, free the data structure. */
812 delete_ust_app_session(app
->sock
, ua_sess
, app
);
819 * Alloc new UST app session.
822 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
824 struct ust_app_session
*ua_sess
;
826 /* Init most of the default value by allocating and zeroing */
827 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
828 if (ua_sess
== NULL
) {
833 ua_sess
->handle
= -1;
834 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
835 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
836 pthread_mutex_init(&ua_sess
->lock
, NULL
);
845 * Alloc new UST app channel.
848 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
849 struct ust_app_session
*ua_sess
,
850 struct lttng_ust_channel_attr
*attr
)
852 struct ust_app_channel
*ua_chan
;
854 /* Init most of the default value by allocating and zeroing */
855 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
856 if (ua_chan
== NULL
) {
861 /* Setup channel name */
862 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
863 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
865 ua_chan
->enabled
= 1;
866 ua_chan
->handle
= -1;
867 ua_chan
->session
= ua_sess
;
868 ua_chan
->key
= get_next_channel_key();
869 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
870 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
871 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
873 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
874 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
876 /* Copy attributes */
878 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
879 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
880 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
881 ua_chan
->attr
.overwrite
= attr
->overwrite
;
882 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
883 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
884 ua_chan
->attr
.output
= attr
->output
;
886 /* By default, the channel is a per cpu channel. */
887 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
889 DBG3("UST app channel %s allocated", ua_chan
->name
);
898 * Allocate and initialize a UST app stream.
900 * Return newly allocated stream pointer or NULL on error.
902 struct ust_app_stream
*ust_app_alloc_stream(void)
904 struct ust_app_stream
*stream
= NULL
;
906 stream
= zmalloc(sizeof(*stream
));
907 if (stream
== NULL
) {
908 PERROR("zmalloc ust app stream");
912 /* Zero could be a valid value for a handle so flag it to -1. */
920 * Alloc new UST app event.
923 struct ust_app_event
*alloc_ust_app_event(char *name
,
924 struct lttng_ust_event
*attr
)
926 struct ust_app_event
*ua_event
;
928 /* Init most of the default value by allocating and zeroing */
929 ua_event
= zmalloc(sizeof(struct ust_app_event
));
930 if (ua_event
== NULL
) {
935 ua_event
->enabled
= 1;
936 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
937 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
938 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
940 /* Copy attributes */
942 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
945 DBG3("UST app event %s allocated", ua_event
->name
);
954 * Alloc new UST app context.
957 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
959 struct ust_app_ctx
*ua_ctx
;
961 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
962 if (ua_ctx
== NULL
) {
966 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
969 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
972 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
979 * Allocate a filter and copy the given original filter.
981 * Return allocated filter or NULL on error.
983 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
984 struct lttng_ust_filter_bytecode
*orig_f
)
986 struct lttng_ust_filter_bytecode
*filter
= NULL
;
988 /* Copy filter bytecode */
989 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
991 PERROR("zmalloc alloc ust app filter");
995 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1002 * Find an ust_app using the sock and return it. RCU read side lock must be
1003 * held before calling this helper function.
1005 struct ust_app
*ust_app_find_by_sock(int sock
)
1007 struct lttng_ht_node_ulong
*node
;
1008 struct lttng_ht_iter iter
;
1010 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1011 node
= lttng_ht_iter_get_node_ulong(&iter
);
1013 DBG2("UST app find by sock %d not found", sock
);
1017 return caa_container_of(node
, struct ust_app
, sock_n
);
1024 * Find an ust_app using the notify sock and return it. RCU read side lock must
1025 * be held before calling this helper function.
1027 static struct ust_app
*find_app_by_notify_sock(int sock
)
1029 struct lttng_ht_node_ulong
*node
;
1030 struct lttng_ht_iter iter
;
1032 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1034 node
= lttng_ht_iter_get_node_ulong(&iter
);
1036 DBG2("UST app find by notify sock %d not found", sock
);
1040 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1047 * Lookup for an ust app event based on event name, filter bytecode and the
1050 * Return an ust_app_event object or NULL on error.
1052 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1053 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1054 const struct lttng_event_exclusion
*exclusion
)
1056 struct lttng_ht_iter iter
;
1057 struct lttng_ht_node_str
*node
;
1058 struct ust_app_event
*event
= NULL
;
1059 struct ust_app_ht_key key
;
1064 /* Setup key for event lookup. */
1066 key
.filter
= filter
;
1067 key
.loglevel
= loglevel
;
1068 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1069 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1071 /* Lookup using the event name as hash and a custom match fct. */
1072 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1073 ht_match_ust_app_event
, &key
, &iter
.iter
);
1074 node
= lttng_ht_iter_get_node_str(&iter
);
1079 event
= caa_container_of(node
, struct ust_app_event
, node
);
1086 * Create the channel context on the tracer.
1088 * Called with UST app session lock held.
1091 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1092 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1096 health_code_update();
1098 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1099 ua_chan
->obj
, &ua_ctx
->obj
);
1101 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1102 ERR("UST app create channel context failed for app (pid: %d) "
1103 "with ret %d", app
->pid
, ret
);
1106 * This is normal behavior, an application can die during the
1107 * creation process. Don't report an error so the execution can
1108 * continue normally.
1111 DBG3("UST app disable event failed. Application is dead.");
1116 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1118 DBG2("UST app context handle %d created successfully for channel %s",
1119 ua_ctx
->handle
, ua_chan
->name
);
1122 health_code_update();
1127 * Set the filter on the tracer.
1130 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1131 struct ust_app
*app
)
1135 health_code_update();
1137 if (!ua_event
->filter
) {
1142 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1145 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1146 ERR("UST app event %s filter failed for app (pid: %d) "
1147 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1150 * This is normal behavior, an application can die during the
1151 * creation process. Don't report an error so the execution can
1152 * continue normally.
1155 DBG3("UST app filter event failed. Application is dead.");
1160 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1163 health_code_update();
1168 * Set event exclusions on the tracer.
1171 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1172 struct ust_app
*app
)
1176 health_code_update();
1178 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1183 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1186 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1187 ERR("UST app event %s exclusions failed for app (pid: %d) "
1188 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1191 * This is normal behavior, an application can die during the
1192 * creation process. Don't report an error so the execution can
1193 * continue normally.
1196 DBG3("UST app event exclusion failed. Application is dead.");
1201 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1204 health_code_update();
1209 * Disable the specified event on to UST tracer for the UST session.
1211 static int disable_ust_event(struct ust_app
*app
,
1212 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1216 health_code_update();
1218 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1220 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1221 ERR("UST app event %s disable failed for app (pid: %d) "
1222 "and session handle %d with ret %d",
1223 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1226 * This is normal behavior, an application can die during the
1227 * creation process. Don't report an error so the execution can
1228 * continue normally.
1231 DBG3("UST app disable event failed. Application is dead.");
1236 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1237 ua_event
->attr
.name
, app
->pid
);
1240 health_code_update();
1245 * Disable the specified channel on to UST tracer for the UST session.
1247 static int disable_ust_channel(struct ust_app
*app
,
1248 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1252 health_code_update();
1254 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1256 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1257 ERR("UST app channel %s disable failed for app (pid: %d) "
1258 "and session handle %d with ret %d",
1259 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1262 * This is normal behavior, an application can die during the
1263 * creation process. Don't report an error so the execution can
1264 * continue normally.
1267 DBG3("UST app disable channel failed. Application is dead.");
1272 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1273 ua_chan
->name
, app
->pid
);
1276 health_code_update();
1281 * Enable the specified channel on to UST tracer for the UST session.
1283 static int enable_ust_channel(struct ust_app
*app
,
1284 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1288 health_code_update();
1290 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1292 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1293 ERR("UST app channel %s enable failed for app (pid: %d) "
1294 "and session handle %d with ret %d",
1295 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1298 * This is normal behavior, an application can die during the
1299 * creation process. Don't report an error so the execution can
1300 * continue normally.
1303 DBG3("UST app enable channel failed. Application is dead.");
1308 ua_chan
->enabled
= 1;
1310 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1311 ua_chan
->name
, app
->pid
);
1314 health_code_update();
1319 * Enable the specified event on to UST tracer for the UST session.
1321 static int enable_ust_event(struct ust_app
*app
,
1322 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1326 health_code_update();
1328 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1330 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1331 ERR("UST app event %s enable failed for app (pid: %d) "
1332 "and session handle %d with ret %d",
1333 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1336 * This is normal behavior, an application can die during the
1337 * creation process. Don't report an error so the execution can
1338 * continue normally.
1341 DBG3("UST app enable event failed. Application is dead.");
1346 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1347 ua_event
->attr
.name
, app
->pid
);
1350 health_code_update();
1355 * Send channel and stream buffer to application.
1357 * Return 0 on success. On error, a negative value is returned.
1359 static int send_channel_pid_to_ust(struct ust_app
*app
,
1360 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1363 struct ust_app_stream
*stream
, *stmp
;
1369 health_code_update();
1371 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1374 /* Send channel to the application. */
1375 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1380 health_code_update();
1382 /* Send all streams to application. */
1383 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1384 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1388 /* We don't need the stream anymore once sent to the tracer. */
1389 cds_list_del(&stream
->list
);
1390 delete_ust_app_stream(-1, stream
);
1392 /* Flag the channel that it is sent to the application. */
1393 ua_chan
->is_sent
= 1;
1396 health_code_update();
1401 * Create the specified event onto the UST tracer for a UST session.
1403 * Should be called with session mutex held.
1406 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1407 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1411 health_code_update();
1413 /* Create UST event on tracer */
1414 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1417 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1418 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1419 ua_event
->attr
.name
, app
->pid
, ret
);
1422 * This is normal behavior, an application can die during the
1423 * creation process. Don't report an error so the execution can
1424 * continue normally.
1427 DBG3("UST app create event failed. Application is dead.");
1432 ua_event
->handle
= ua_event
->obj
->handle
;
1434 DBG2("UST app event %s created successfully for pid:%d",
1435 ua_event
->attr
.name
, app
->pid
);
1437 health_code_update();
1439 /* Set filter if one is present. */
1440 if (ua_event
->filter
) {
1441 ret
= set_ust_event_filter(ua_event
, app
);
1447 /* Set exclusions for the event */
1448 if (ua_event
->exclusion
) {
1449 ret
= set_ust_event_exclusion(ua_event
, app
);
1455 /* If event not enabled, disable it on the tracer */
1456 if (ua_event
->enabled
) {
1458 * We now need to explicitly enable the event, since it
1459 * is now disabled at creation.
1461 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1464 * If we hit an EPERM, something is wrong with our enable call. If
1465 * we get an EEXIST, there is a problem on the tracer side since we
1469 case -LTTNG_UST_ERR_PERM
:
1470 /* Code flow problem */
1472 case -LTTNG_UST_ERR_EXIST
:
1473 /* It's OK for our use case. */
1484 health_code_update();
1489 * Copy data between an UST app event and a LTT event.
1491 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1492 struct ltt_ust_event
*uevent
)
1494 size_t exclusion_alloc_size
;
1496 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1497 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1499 ua_event
->enabled
= uevent
->enabled
;
1501 /* Copy event attributes */
1502 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1504 /* Copy filter bytecode */
1505 if (uevent
->filter
) {
1506 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1507 /* Filter might be NULL here in case of ENONEM. */
1510 /* Copy exclusion data */
1511 if (uevent
->exclusion
) {
1512 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1513 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1514 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1515 if (ua_event
->exclusion
== NULL
) {
1518 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1519 exclusion_alloc_size
);
1525 * Copy data between an UST app channel and a LTT channel.
1527 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1528 struct ltt_ust_channel
*uchan
)
1530 struct lttng_ht_iter iter
;
1531 struct ltt_ust_event
*uevent
;
1532 struct ltt_ust_context
*uctx
;
1533 struct ust_app_event
*ua_event
;
1534 struct ust_app_ctx
*ua_ctx
;
1536 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1538 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1539 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1541 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1542 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1544 /* Copy event attributes since the layout is different. */
1545 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1546 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1547 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1548 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1549 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1550 ua_chan
->attr
.output
= uchan
->attr
.output
;
1552 * Note that the attribute channel type is not set since the channel on the
1553 * tracing registry side does not have this information.
1556 ua_chan
->enabled
= uchan
->enabled
;
1557 ua_chan
->tracing_channel_id
= uchan
->id
;
1559 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1560 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1561 if (ua_ctx
== NULL
) {
1564 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1565 (unsigned long) ua_ctx
->ctx
.ctx
);
1566 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1567 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1570 /* Copy all events from ltt ust channel to ust app channel */
1571 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1572 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1573 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1574 if (ua_event
== NULL
) {
1575 DBG2("UST event %s not found on shadow copy channel",
1577 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1578 if (ua_event
== NULL
) {
1581 shadow_copy_event(ua_event
, uevent
);
1582 add_unique_ust_app_event(ua_chan
, ua_event
);
1586 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1590 * Copy data between a UST app session and a regular LTT session.
1592 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1593 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1595 struct lttng_ht_node_str
*ua_chan_node
;
1596 struct lttng_ht_iter iter
;
1597 struct ltt_ust_channel
*uchan
;
1598 struct ust_app_channel
*ua_chan
;
1600 struct tm
*timeinfo
;
1603 char tmp_shm_path
[PATH_MAX
];
1605 /* Get date and time for unique app path */
1607 timeinfo
= localtime(&rawtime
);
1608 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1610 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1612 ua_sess
->tracing_id
= usess
->id
;
1613 ua_sess
->id
= get_next_session_id();
1614 ua_sess
->uid
= app
->uid
;
1615 ua_sess
->gid
= app
->gid
;
1616 ua_sess
->euid
= usess
->uid
;
1617 ua_sess
->egid
= usess
->gid
;
1618 ua_sess
->buffer_type
= usess
->buffer_type
;
1619 ua_sess
->bits_per_long
= app
->bits_per_long
;
1620 /* There is only one consumer object per session possible. */
1621 ua_sess
->consumer
= usess
->consumer
;
1622 ua_sess
->output_traces
= usess
->output_traces
;
1623 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1624 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
,
1625 &usess
->metadata_attr
);
1627 switch (ua_sess
->buffer_type
) {
1628 case LTTNG_BUFFER_PER_PID
:
1629 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1630 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1633 case LTTNG_BUFFER_PER_UID
:
1634 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1635 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1642 PERROR("asprintf UST shadow copy session");
1647 strncpy(ua_sess
->root_shm_path
, usess
->root_shm_path
,
1648 sizeof(ua_sess
->root_shm_path
));
1649 ua_sess
->root_shm_path
[sizeof(ua_sess
->root_shm_path
) - 1] = '\0';
1650 strncpy(ua_sess
->shm_path
, usess
->shm_path
,
1651 sizeof(ua_sess
->shm_path
));
1652 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1653 if (ua_sess
->shm_path
[0]) {
1654 switch (ua_sess
->buffer_type
) {
1655 case LTTNG_BUFFER_PER_PID
:
1656 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1657 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s",
1658 app
->name
, app
->pid
, datetime
);
1660 case LTTNG_BUFFER_PER_UID
:
1661 ret
= snprintf(tmp_shm_path
, sizeof(tmp_shm_path
),
1662 DEFAULT_UST_TRACE_UID_PATH
,
1663 app
->uid
, app
->bits_per_long
);
1670 PERROR("sprintf UST shadow copy session");
1674 strncat(ua_sess
->shm_path
, tmp_shm_path
,
1675 sizeof(ua_sess
->shm_path
) - strlen(ua_sess
->shm_path
) - 1);
1676 ua_sess
->shm_path
[sizeof(ua_sess
->shm_path
) - 1] = '\0';
1679 /* Iterate over all channels in global domain. */
1680 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1682 struct lttng_ht_iter uiter
;
1684 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1685 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1686 if (ua_chan_node
!= NULL
) {
1687 /* Session exist. Contiuing. */
1691 DBG2("Channel %s not found on shadow session copy, creating it",
1693 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1694 if (ua_chan
== NULL
) {
1695 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1698 shadow_copy_channel(ua_chan
, uchan
);
1700 * The concept of metadata channel does not exist on the tracing
1701 * registry side of the session daemon so this can only be a per CPU
1702 * channel and not metadata.
1704 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1706 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1714 * Lookup sesison wrapper.
1717 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1718 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1720 /* Get right UST app session from app */
1721 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1725 * Return ust app session from the app session hashtable using the UST session
1728 static struct ust_app_session
*lookup_session_by_app(
1729 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1731 struct lttng_ht_iter iter
;
1732 struct lttng_ht_node_u64
*node
;
1734 __lookup_session_by_app(usess
, app
, &iter
);
1735 node
= lttng_ht_iter_get_node_u64(&iter
);
1740 return caa_container_of(node
, struct ust_app_session
, node
);
1747 * Setup buffer registry per PID for the given session and application. If none
1748 * is found, a new one is created, added to the global registry and
1749 * initialized. If regp is valid, it's set with the newly created object.
1751 * Return 0 on success or else a negative value.
1753 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1754 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1757 struct buffer_reg_pid
*reg_pid
;
1764 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1767 * This is the create channel path meaning that if there is NO
1768 * registry available, we have to create one for this session.
1770 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
,
1771 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1779 /* Initialize registry. */
1780 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1781 app
->bits_per_long
, app
->uint8_t_alignment
,
1782 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1783 app
->uint64_t_alignment
, app
->long_alignment
,
1784 app
->byte_order
, app
->version
.major
,
1785 app
->version
.minor
, reg_pid
->root_shm_path
,
1787 ua_sess
->euid
, ua_sess
->egid
);
1790 * reg_pid->registry->reg.ust is NULL upon error, so we need to
1791 * destroy the buffer registry, because it is always expected
1792 * that if the buffer registry can be found, its ust registry is
1795 buffer_reg_pid_destroy(reg_pid
);
1799 buffer_reg_pid_add(reg_pid
);
1801 DBG3("UST app buffer registry per PID created successfully");
1813 * Setup buffer registry per UID for the given session and application. If none
1814 * is found, a new one is created, added to the global registry and
1815 * initialized. If regp is valid, it's set with the newly created object.
1817 * Return 0 on success or else a negative value.
1819 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1820 struct ust_app_session
*ua_sess
,
1821 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1824 struct buffer_reg_uid
*reg_uid
;
1831 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1834 * This is the create channel path meaning that if there is NO
1835 * registry available, we have to create one for this session.
1837 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1838 LTTNG_DOMAIN_UST
, ®_uid
,
1839 ua_sess
->root_shm_path
, ua_sess
->shm_path
);
1847 /* Initialize registry. */
1848 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1849 app
->bits_per_long
, app
->uint8_t_alignment
,
1850 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1851 app
->uint64_t_alignment
, app
->long_alignment
,
1852 app
->byte_order
, app
->version
.major
,
1853 app
->version
.minor
, reg_uid
->root_shm_path
,
1854 reg_uid
->shm_path
, usess
->uid
, usess
->gid
);
1857 * reg_uid->registry->reg.ust is NULL upon error, so we need to
1858 * destroy the buffer registry, because it is always expected
1859 * that if the buffer registry can be found, its ust registry is
1862 buffer_reg_uid_destroy(reg_uid
, NULL
);
1865 /* Add node to teardown list of the session. */
1866 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1868 buffer_reg_uid_add(reg_uid
);
1870 DBG3("UST app buffer registry per UID created successfully");
1881 * Create a session on the tracer side for the given app.
1883 * On success, ua_sess_ptr is populated with the session pointer or else left
1884 * untouched. If the session was created, is_created is set to 1. On error,
1885 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1888 * Returns 0 on success or else a negative code which is either -ENOMEM or
1889 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1891 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1892 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1895 int ret
, created
= 0;
1896 struct ust_app_session
*ua_sess
;
1900 assert(ua_sess_ptr
);
1902 health_code_update();
1904 ua_sess
= lookup_session_by_app(usess
, app
);
1905 if (ua_sess
== NULL
) {
1906 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1907 app
->pid
, usess
->id
);
1908 ua_sess
= alloc_ust_app_session(app
);
1909 if (ua_sess
== NULL
) {
1910 /* Only malloc can failed so something is really wrong */
1914 shadow_copy_session(ua_sess
, usess
, app
);
1918 switch (usess
->buffer_type
) {
1919 case LTTNG_BUFFER_PER_PID
:
1920 /* Init local registry. */
1921 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1923 delete_ust_app_session(-1, ua_sess
, app
);
1927 case LTTNG_BUFFER_PER_UID
:
1928 /* Look for a global registry. If none exists, create one. */
1929 ret
= setup_buffer_reg_uid(usess
, ua_sess
, app
, NULL
);
1931 delete_ust_app_session(-1, ua_sess
, app
);
1941 health_code_update();
1943 if (ua_sess
->handle
== -1) {
1944 ret
= ustctl_create_session(app
->sock
);
1946 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1947 ERR("Creating session for app pid %d with ret %d",
1950 DBG("UST app creating session failed. Application is dead");
1952 * This is normal behavior, an application can die during the
1953 * creation process. Don't report an error so the execution can
1954 * continue normally. This will get flagged ENOTCONN and the
1955 * caller will handle it.
1959 delete_ust_app_session(-1, ua_sess
, app
);
1960 if (ret
!= -ENOMEM
) {
1962 * Tracer is probably gone or got an internal error so let's
1963 * behave like it will soon unregister or not usable.
1970 ua_sess
->handle
= ret
;
1972 /* Add ust app session to app's HT */
1973 lttng_ht_node_init_u64(&ua_sess
->node
,
1974 ua_sess
->tracing_id
);
1975 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1977 DBG2("UST app session created successfully with handle %d", ret
);
1980 *ua_sess_ptr
= ua_sess
;
1982 *is_created
= created
;
1985 /* Everything went well. */
1989 health_code_update();
1994 * Match function for a hash table lookup of ust_app_ctx.
1996 * It matches an ust app context based on the context type and, in the case
1997 * of perf counters, their name.
1999 static int ht_match_ust_app_ctx(struct cds_lfht_node
*node
, const void *_key
)
2001 struct ust_app_ctx
*ctx
;
2002 const struct lttng_ust_context
*key
;
2007 ctx
= caa_container_of(node
, struct ust_app_ctx
, node
.node
);
2011 if (ctx
->ctx
.ctx
!= key
->ctx
) {
2015 /* Check the name in the case of perf thread counters. */
2016 if (key
->ctx
== LTTNG_UST_CONTEXT_PERF_THREAD_COUNTER
) {
2017 if (strncmp(key
->u
.perf_counter
.name
,
2018 ctx
->ctx
.u
.perf_counter
.name
,
2019 sizeof(key
->u
.perf_counter
.name
))) {
2032 * Lookup for an ust app context from an lttng_ust_context.
2034 * Must be called while holding RCU read side lock.
2035 * Return an ust_app_ctx object or NULL on error.
2038 struct ust_app_ctx
*find_ust_app_context(struct lttng_ht
*ht
,
2039 struct lttng_ust_context
*uctx
)
2041 struct lttng_ht_iter iter
;
2042 struct lttng_ht_node_ulong
*node
;
2043 struct ust_app_ctx
*app_ctx
= NULL
;
2048 /* Lookup using the lttng_ust_context_type and a custom match fct. */
2049 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) uctx
->ctx
, lttng_ht_seed
),
2050 ht_match_ust_app_ctx
, uctx
, &iter
.iter
);
2051 node
= lttng_ht_iter_get_node_ulong(&iter
);
2056 app_ctx
= caa_container_of(node
, struct ust_app_ctx
, node
);
2063 * Create a context for the channel on the tracer.
2065 * Called with UST app session lock held and a RCU read side lock.
2068 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
2069 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
2070 struct ust_app
*app
)
2073 struct ust_app_ctx
*ua_ctx
;
2075 DBG2("UST app adding context to channel %s", ua_chan
->name
);
2077 ua_ctx
= find_ust_app_context(ua_chan
->ctx
, uctx
);
2083 ua_ctx
= alloc_ust_app_ctx(uctx
);
2084 if (ua_ctx
== NULL
) {
2090 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
2091 lttng_ht_add_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
2092 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
2094 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
2104 * Enable on the tracer side a ust app event for the session and channel.
2106 * Called with UST app session lock held.
2109 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
2110 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2114 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
2119 ua_event
->enabled
= 1;
2126 * Disable on the tracer side a ust app event for the session and channel.
2128 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2129 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2133 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2138 ua_event
->enabled
= 0;
2145 * Lookup ust app channel for session and disable it on the tracer side.
2148 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2149 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2153 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2158 ua_chan
->enabled
= 0;
2165 * Lookup ust app channel for session and enable it on the tracer side. This
2166 * MUST be called with a RCU read side lock acquired.
2168 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2169 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2172 struct lttng_ht_iter iter
;
2173 struct lttng_ht_node_str
*ua_chan_node
;
2174 struct ust_app_channel
*ua_chan
;
2176 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2177 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2178 if (ua_chan_node
== NULL
) {
2179 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2180 uchan
->name
, ua_sess
->tracing_id
);
2184 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2186 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2196 * Ask the consumer to create a channel and get it if successful.
2198 * Return 0 on success or else a negative value.
2200 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2201 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2202 int bitness
, struct ust_registry_session
*registry
)
2205 unsigned int nb_fd
= 0;
2206 struct consumer_socket
*socket
;
2214 health_code_update();
2216 /* Get the right consumer socket for the application. */
2217 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2223 health_code_update();
2225 /* Need one fd for the channel. */
2226 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2228 ERR("Exhausted number of available FD upon create channel");
2233 * Ask consumer to create channel. The consumer will return the number of
2234 * stream we have to expect.
2236 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2243 * Compute the number of fd needed before receiving them. It must be 2 per
2244 * stream (2 being the default value here).
2246 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2248 /* Reserve the amount of file descriptor we need. */
2249 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2251 ERR("Exhausted number of available FD upon create channel");
2252 goto error_fd_get_stream
;
2255 health_code_update();
2258 * Now get the channel from the consumer. This call wil populate the stream
2259 * list of that channel and set the ust objects.
2261 if (usess
->consumer
->enabled
) {
2262 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2272 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2273 error_fd_get_stream
:
2275 * Initiate a destroy channel on the consumer since we had an error
2276 * handling it on our side. The return value is of no importance since we
2277 * already have a ret value set by the previous error that we need to
2280 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2282 lttng_fd_put(LTTNG_FD_APPS
, 1);
2284 health_code_update();
2290 * Duplicate the ust data object of the ust app stream and save it in the
2291 * buffer registry stream.
2293 * Return 0 on success or else a negative value.
2295 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2296 struct ust_app_stream
*stream
)
2303 /* Reserve the amount of file descriptor we need. */
2304 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2306 ERR("Exhausted number of available FD upon duplicate stream");
2310 /* Duplicate object for stream once the original is in the registry. */
2311 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2312 reg_stream
->obj
.ust
);
2314 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2315 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2316 lttng_fd_put(LTTNG_FD_APPS
, 2);
2319 stream
->handle
= stream
->obj
->handle
;
2326 * Duplicate the ust data object of the ust app. channel and save it in the
2327 * buffer registry channel.
2329 * Return 0 on success or else a negative value.
2331 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2332 struct ust_app_channel
*ua_chan
)
2339 /* Need two fds for the channel. */
2340 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2342 ERR("Exhausted number of available FD upon duplicate channel");
2346 /* Duplicate object for stream once the original is in the registry. */
2347 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2349 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2350 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2353 ua_chan
->handle
= ua_chan
->obj
->handle
;
2358 lttng_fd_put(LTTNG_FD_APPS
, 1);
2364 * For a given channel buffer registry, setup all streams of the given ust
2365 * application channel.
2367 * Return 0 on success or else a negative value.
2369 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2370 struct ust_app_channel
*ua_chan
)
2373 struct ust_app_stream
*stream
, *stmp
;
2378 DBG2("UST app setup buffer registry stream");
2380 /* Send all streams to application. */
2381 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2382 struct buffer_reg_stream
*reg_stream
;
2384 ret
= buffer_reg_stream_create(®_stream
);
2390 * Keep original pointer and nullify it in the stream so the delete
2391 * stream call does not release the object.
2393 reg_stream
->obj
.ust
= stream
->obj
;
2395 buffer_reg_stream_add(reg_stream
, reg_chan
);
2397 /* We don't need the streams anymore. */
2398 cds_list_del(&stream
->list
);
2399 delete_ust_app_stream(-1, stream
);
2407 * Create a buffer registry channel for the given session registry and
2408 * application channel object. If regp pointer is valid, it's set with the
2409 * created object. Important, the created object is NOT added to the session
2410 * registry hash table.
2412 * Return 0 on success else a negative value.
2414 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2415 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2418 struct buffer_reg_channel
*reg_chan
= NULL
;
2423 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2425 /* Create buffer registry channel. */
2426 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2431 reg_chan
->consumer_key
= ua_chan
->key
;
2432 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2433 reg_chan
->num_subbuf
= ua_chan
->attr
.num_subbuf
;
2435 /* Create and add a channel registry to session. */
2436 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2437 ua_chan
->tracing_channel_id
);
2441 buffer_reg_channel_add(reg_sess
, reg_chan
);
2450 /* Safe because the registry channel object was not added to any HT. */
2451 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2457 * Setup buffer registry channel for the given session registry and application
2458 * channel object. If regp pointer is valid, it's set with the created object.
2460 * Return 0 on success else a negative value.
2462 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2463 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2470 assert(ua_chan
->obj
);
2472 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2474 /* Setup all streams for the registry. */
2475 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2480 reg_chan
->obj
.ust
= ua_chan
->obj
;
2481 ua_chan
->obj
= NULL
;
2486 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2487 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2492 * Send buffer registry channel to the application.
2494 * Return 0 on success else a negative value.
2496 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2497 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2498 struct ust_app_channel
*ua_chan
)
2501 struct buffer_reg_stream
*reg_stream
;
2508 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2510 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2515 /* Send channel to the application. */
2516 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2521 health_code_update();
2523 /* Send all streams to application. */
2524 pthread_mutex_lock(®_chan
->stream_list_lock
);
2525 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2526 struct ust_app_stream stream
;
2528 ret
= duplicate_stream_object(reg_stream
, &stream
);
2530 goto error_stream_unlock
;
2533 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2535 (void) release_ust_app_stream(-1, &stream
);
2536 goto error_stream_unlock
;
2540 * The return value is not important here. This function will output an
2543 (void) release_ust_app_stream(-1, &stream
);
2545 ua_chan
->is_sent
= 1;
2547 error_stream_unlock
:
2548 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2554 * Create and send to the application the created buffers with per UID buffers.
2556 * Return 0 on success else a negative value.
2558 static int create_channel_per_uid(struct ust_app
*app
,
2559 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2560 struct ust_app_channel
*ua_chan
)
2563 struct buffer_reg_uid
*reg_uid
;
2564 struct buffer_reg_channel
*reg_chan
;
2571 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2573 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2575 * The session creation handles the creation of this global registry
2576 * object. If none can be find, there is a code flow problem or a
2581 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2584 /* Create the buffer registry channel object. */
2585 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2587 ERR("Error creating the UST channel \"%s\" registry instance",
2594 * Create the buffers on the consumer side. This call populates the
2595 * ust app channel object with all streams and data object.
2597 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2598 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2600 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2604 * Let's remove the previously created buffer registry channel so
2605 * it's not visible anymore in the session registry.
2607 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2608 ua_chan
->tracing_channel_id
);
2609 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2610 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2615 * Setup the streams and add it to the session registry.
2617 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2619 ERR("Error setting up UST channel \"%s\"",
2626 /* Send buffers to the application. */
2627 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2630 * Don't report error to the console, since it may be
2631 * caused by application concurrently exiting.
2641 * Create and send to the application the created buffers with per PID buffers.
2643 * Return 0 on success else a negative value.
2645 static int create_channel_per_pid(struct ust_app
*app
,
2646 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2647 struct ust_app_channel
*ua_chan
)
2650 struct ust_registry_session
*registry
;
2657 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2661 registry
= get_session_registry(ua_sess
);
2664 /* Create and add a new channel registry to session. */
2665 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2667 ERR("Error creating the UST channel \"%s\" registry instance",
2672 /* Create and get channel on the consumer side. */
2673 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2674 app
->bits_per_long
, registry
);
2676 ERR("Error creating UST channel \"%s\" on the consumer daemon",
2681 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2684 * Don't report error to the console, since it may be
2685 * caused by application concurrently exiting.
2696 * From an already allocated ust app channel, create the channel buffers if
2697 * need and send it to the application. This MUST be called with a RCU read
2698 * side lock acquired.
2700 * Return 0 on success or else a negative value.
2702 static int do_create_channel(struct ust_app
*app
,
2703 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2704 struct ust_app_channel
*ua_chan
)
2713 /* Handle buffer type before sending the channel to the application. */
2714 switch (usess
->buffer_type
) {
2715 case LTTNG_BUFFER_PER_UID
:
2717 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2723 case LTTNG_BUFFER_PER_PID
:
2725 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2737 /* Initialize ust objd object using the received handle and add it. */
2738 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2739 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2741 /* If channel is not enabled, disable it on the tracer */
2742 if (!ua_chan
->enabled
) {
2743 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2754 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2755 * newly created channel if not NULL.
2757 * Called with UST app session lock and RCU read-side lock held.
2759 * Return 0 on success or else a negative value.
2761 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2762 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2763 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2764 struct ust_app_channel
**ua_chanp
)
2767 struct lttng_ht_iter iter
;
2768 struct lttng_ht_node_str
*ua_chan_node
;
2769 struct ust_app_channel
*ua_chan
;
2771 /* Lookup channel in the ust app session */
2772 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2773 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2774 if (ua_chan_node
!= NULL
) {
2775 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2779 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2780 if (ua_chan
== NULL
) {
2781 /* Only malloc can fail here */
2785 shadow_copy_channel(ua_chan
, uchan
);
2787 /* Set channel type. */
2788 ua_chan
->attr
.type
= type
;
2790 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2795 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2798 /* Only add the channel if successful on the tracer side. */
2799 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2803 *ua_chanp
= ua_chan
;
2806 /* Everything went well. */
2810 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2816 * Create UST app event and create it on the tracer side.
2818 * Called with ust app session mutex held.
2821 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2822 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2823 struct ust_app
*app
)
2826 struct ust_app_event
*ua_event
;
2828 /* Get event node */
2829 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2830 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2831 if (ua_event
!= NULL
) {
2836 /* Does not exist so create one */
2837 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2838 if (ua_event
== NULL
) {
2839 /* Only malloc can failed so something is really wrong */
2843 shadow_copy_event(ua_event
, uevent
);
2845 /* Create it on the tracer side */
2846 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2848 /* Not found previously means that it does not exist on the tracer */
2849 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2853 add_unique_ust_app_event(ua_chan
, ua_event
);
2855 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2862 /* Valid. Calling here is already in a read side lock */
2863 delete_ust_app_event(-1, ua_event
);
2868 * Create UST metadata and open it on the tracer side.
2870 * Called with UST app session lock held and RCU read side lock.
2872 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2873 struct ust_app
*app
, struct consumer_output
*consumer
)
2876 struct ust_app_channel
*metadata
;
2877 struct consumer_socket
*socket
;
2878 struct ust_registry_session
*registry
;
2884 registry
= get_session_registry(ua_sess
);
2887 pthread_mutex_lock(®istry
->lock
);
2889 /* Metadata already exists for this registry or it was closed previously */
2890 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2895 /* Allocate UST metadata */
2896 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2898 /* malloc() failed */
2903 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2905 /* Need one fd for the channel. */
2906 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2908 ERR("Exhausted number of available FD upon create metadata");
2912 /* Get the right consumer socket for the application. */
2913 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2916 goto error_consumer
;
2920 * Keep metadata key so we can identify it on the consumer side. Assign it
2921 * to the registry *before* we ask the consumer so we avoid the race of the
2922 * consumer requesting the metadata and the ask_channel call on our side
2923 * did not returned yet.
2925 registry
->metadata_key
= metadata
->key
;
2928 * Ask the metadata channel creation to the consumer. The metadata object
2929 * will be created by the consumer and kept their. However, the stream is
2930 * never added or monitored until we do a first push metadata to the
2933 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2936 /* Nullify the metadata key so we don't try to close it later on. */
2937 registry
->metadata_key
= 0;
2938 goto error_consumer
;
2942 * The setup command will make the metadata stream be sent to the relayd,
2943 * if applicable, and the thread managing the metadatas. This is important
2944 * because after this point, if an error occurs, the only way the stream
2945 * can be deleted is to be monitored in the consumer.
2947 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2949 /* Nullify the metadata key so we don't try to close it later on. */
2950 registry
->metadata_key
= 0;
2951 goto error_consumer
;
2954 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2955 metadata
->key
, app
->pid
);
2958 lttng_fd_put(LTTNG_FD_APPS
, 1);
2959 delete_ust_app_channel(-1, metadata
, app
);
2961 pthread_mutex_unlock(®istry
->lock
);
2966 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2967 * acquired before calling this function.
2969 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2971 struct ust_app
*app
= NULL
;
2972 struct lttng_ht_node_ulong
*node
;
2973 struct lttng_ht_iter iter
;
2975 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2976 node
= lttng_ht_iter_get_node_ulong(&iter
);
2978 DBG2("UST app no found with pid %d", pid
);
2982 DBG2("Found UST app by pid %d", pid
);
2984 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2991 * Allocate and init an UST app object using the registration information and
2992 * the command socket. This is called when the command socket connects to the
2995 * The object is returned on success or else NULL.
2997 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2999 struct ust_app
*lta
= NULL
;
3004 DBG3("UST app creating application for socket %d", sock
);
3006 if ((msg
->bits_per_long
== 64 &&
3007 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
3008 || (msg
->bits_per_long
== 32 &&
3009 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
3010 ERR("Registration failed: application \"%s\" (pid: %d) has "
3011 "%d-bit long, but no consumerd for this size is available.\n",
3012 msg
->name
, msg
->pid
, msg
->bits_per_long
);
3016 lta
= zmalloc(sizeof(struct ust_app
));
3022 lta
->ppid
= msg
->ppid
;
3023 lta
->uid
= msg
->uid
;
3024 lta
->gid
= msg
->gid
;
3026 lta
->bits_per_long
= msg
->bits_per_long
;
3027 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
3028 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
3029 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
3030 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
3031 lta
->long_alignment
= msg
->long_alignment
;
3032 lta
->byte_order
= msg
->byte_order
;
3034 lta
->v_major
= msg
->major
;
3035 lta
->v_minor
= msg
->minor
;
3036 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3037 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3038 lta
->notify_sock
= -1;
3040 /* Copy name and make sure it's NULL terminated. */
3041 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
3042 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
3045 * Before this can be called, when receiving the registration information,
3046 * the application compatibility is checked. So, at this point, the
3047 * application can work with this session daemon.
3049 lta
->compatible
= 1;
3051 lta
->pid
= msg
->pid
;
3052 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
3054 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
3056 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
3063 * For a given application object, add it to every hash table.
3065 void ust_app_add(struct ust_app
*app
)
3068 assert(app
->notify_sock
>= 0);
3073 * On a re-registration, we want to kick out the previous registration of
3076 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
3079 * The socket _should_ be unique until _we_ call close. So, a add_unique
3080 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
3081 * already in the table.
3083 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
3085 /* Add application to the notify socket hash table. */
3086 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
3087 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
3089 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
3090 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
3091 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
3098 * Set the application version into the object.
3100 * Return 0 on success else a negative value either an errno code or a
3101 * LTTng-UST error code.
3103 int ust_app_version(struct ust_app
*app
)
3109 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
3111 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3112 ERR("UST app %d version failed with ret %d", app
->sock
, ret
);
3114 DBG3("UST app %d version failed. Application is dead", app
->sock
);
3122 * Unregister app by removing it from the global traceable app list and freeing
3125 * The socket is already closed at this point so no close to sock.
3127 void ust_app_unregister(int sock
)
3129 struct ust_app
*lta
;
3130 struct lttng_ht_node_ulong
*node
;
3131 struct lttng_ht_iter ust_app_sock_iter
;
3132 struct lttng_ht_iter iter
;
3133 struct ust_app_session
*ua_sess
;
3138 /* Get the node reference for a call_rcu */
3139 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &ust_app_sock_iter
);
3140 node
= lttng_ht_iter_get_node_ulong(&ust_app_sock_iter
);
3143 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
3144 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
3147 * For per-PID buffers, perform "push metadata" and flush all
3148 * application streams before removing app from hash tables,
3149 * ensuring proper behavior of data_pending check.
3150 * Remove sessions so they are not visible during deletion.
3152 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3154 struct ust_registry_session
*registry
;
3156 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3158 /* The session was already removed so scheduled for teardown. */
3162 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
3163 (void) ust_app_flush_app_session(lta
, ua_sess
);
3167 * Add session to list for teardown. This is safe since at this point we
3168 * are the only one using this list.
3170 pthread_mutex_lock(&ua_sess
->lock
);
3173 * Normally, this is done in the delete session process which is
3174 * executed in the call rcu below. However, upon registration we can't
3175 * afford to wait for the grace period before pushing data or else the
3176 * data pending feature can race between the unregistration and stop
3177 * command where the data pending command is sent *before* the grace
3180 * The close metadata below nullifies the metadata pointer in the
3181 * session so the delete session will NOT push/close a second time.
3183 registry
= get_session_registry(ua_sess
);
3185 /* Push metadata for application before freeing the application. */
3186 (void) push_metadata(registry
, ua_sess
->consumer
);
3189 * Don't ask to close metadata for global per UID buffers. Close
3190 * metadata only on destroy trace session in this case. Also, the
3191 * previous push metadata could have flag the metadata registry to
3192 * close so don't send a close command if closed.
3194 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
3195 /* And ask to close it for this session registry. */
3196 (void) close_metadata(registry
, ua_sess
->consumer
);
3199 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3201 pthread_mutex_unlock(&ua_sess
->lock
);
3204 /* Remove application from PID hash table */
3205 ret
= lttng_ht_del(ust_app_ht_by_sock
, &ust_app_sock_iter
);
3209 * Remove application from notify hash table. The thread handling the
3210 * notify socket could have deleted the node so ignore on error because
3211 * either way it's valid. The close of that socket is handled by the other
3214 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3215 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3218 * Ignore return value since the node might have been removed before by an
3219 * add replace during app registration because the PID can be reassigned by
3222 iter
.iter
.node
= <a
->pid_n
.node
;
3223 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3225 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3230 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3237 * Fill events array with all events name of all registered apps.
3239 int ust_app_list_events(struct lttng_event
**events
)
3242 size_t nbmem
, count
= 0;
3243 struct lttng_ht_iter iter
;
3244 struct ust_app
*app
;
3245 struct lttng_event
*tmp_event
;
3247 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3248 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3249 if (tmp_event
== NULL
) {
3250 PERROR("zmalloc ust app events");
3257 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3258 struct lttng_ust_tracepoint_iter uiter
;
3260 health_code_update();
3262 if (!app
->compatible
) {
3264 * TODO: In time, we should notice the caller of this error by
3265 * telling him that this is a version error.
3269 handle
= ustctl_tracepoint_list(app
->sock
);
3271 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3272 ERR("UST app list events getting handle failed for app pid %d",
3278 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3279 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3280 /* Handle ustctl error. */
3282 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3283 ERR("UST app tp list get failed for app %d with ret %d",
3286 DBG3("UST app tp list get failed. Application is dead");
3288 * This is normal behavior, an application can die during the
3289 * creation process. Don't report an error so the execution can
3290 * continue normally. Continue normal execution.
3298 health_code_update();
3299 if (count
>= nbmem
) {
3300 /* In case the realloc fails, we free the memory */
3301 struct lttng_event
*new_tmp_event
;
3304 new_nbmem
= nbmem
<< 1;
3305 DBG2("Reallocating event list from %zu to %zu entries",
3307 new_tmp_event
= realloc(tmp_event
,
3308 new_nbmem
* sizeof(struct lttng_event
));
3309 if (new_tmp_event
== NULL
) {
3310 PERROR("realloc ust app events");
3315 /* Zero the new memory */
3316 memset(new_tmp_event
+ nbmem
, 0,
3317 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3319 tmp_event
= new_tmp_event
;
3321 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3322 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3323 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3324 tmp_event
[count
].pid
= app
->pid
;
3325 tmp_event
[count
].enabled
= -1;
3331 *events
= tmp_event
;
3333 DBG2("UST app list events done (%zu events)", count
);
3338 health_code_update();
3343 * Fill events array with all events name of all registered apps.
3345 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3348 size_t nbmem
, count
= 0;
3349 struct lttng_ht_iter iter
;
3350 struct ust_app
*app
;
3351 struct lttng_event_field
*tmp_event
;
3353 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3354 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3355 if (tmp_event
== NULL
) {
3356 PERROR("zmalloc ust app event fields");
3363 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3364 struct lttng_ust_field_iter uiter
;
3366 health_code_update();
3368 if (!app
->compatible
) {
3370 * TODO: In time, we should notice the caller of this error by
3371 * telling him that this is a version error.
3375 handle
= ustctl_tracepoint_field_list(app
->sock
);
3377 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3378 ERR("UST app list field getting handle failed for app pid %d",
3384 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3385 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3386 /* Handle ustctl error. */
3388 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3389 ERR("UST app tp list field failed for app %d with ret %d",
3392 DBG3("UST app tp list field failed. Application is dead");
3394 * This is normal behavior, an application can die during the
3395 * creation process. Don't report an error so the execution can
3396 * continue normally. Reset list and count for next app.
3404 health_code_update();
3405 if (count
>= nbmem
) {
3406 /* In case the realloc fails, we free the memory */
3407 struct lttng_event_field
*new_tmp_event
;
3410 new_nbmem
= nbmem
<< 1;
3411 DBG2("Reallocating event field list from %zu to %zu entries",
3413 new_tmp_event
= realloc(tmp_event
,
3414 new_nbmem
* sizeof(struct lttng_event_field
));
3415 if (new_tmp_event
== NULL
) {
3416 PERROR("realloc ust app event fields");
3421 /* Zero the new memory */
3422 memset(new_tmp_event
+ nbmem
, 0,
3423 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3425 tmp_event
= new_tmp_event
;
3428 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3429 /* Mapping between these enums matches 1 to 1. */
3430 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3431 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3433 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3434 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3435 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3436 tmp_event
[count
].event
.pid
= app
->pid
;
3437 tmp_event
[count
].event
.enabled
= -1;
3443 *fields
= tmp_event
;
3445 DBG2("UST app list event fields done (%zu events)", count
);
3450 health_code_update();
3455 * Free and clean all traceable apps of the global list.
3457 * Should _NOT_ be called with RCU read-side lock held.
3459 void ust_app_clean_list(void)
3462 struct ust_app
*app
;
3463 struct lttng_ht_iter iter
;
3465 DBG2("UST app cleaning registered apps hash table");
3470 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3471 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3473 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3477 /* Cleanup socket hash table */
3478 if (ust_app_ht_by_sock
) {
3479 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3481 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3486 /* Cleanup notify socket hash table */
3487 if (ust_app_ht_by_notify_sock
) {
3488 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3489 notify_sock_n
.node
) {
3490 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3496 /* Destroy is done only when the ht is empty */
3498 ht_cleanup_push(ust_app_ht
);
3500 if (ust_app_ht_by_sock
) {
3501 ht_cleanup_push(ust_app_ht_by_sock
);
3503 if (ust_app_ht_by_notify_sock
) {
3504 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3509 * Init UST app hash table.
3511 int ust_app_ht_alloc(void)
3513 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3517 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3518 if (!ust_app_ht_by_sock
) {
3521 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3522 if (!ust_app_ht_by_notify_sock
) {
3529 * For a specific UST session, disable the channel for all registered apps.
3531 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3532 struct ltt_ust_channel
*uchan
)
3535 struct lttng_ht_iter iter
;
3536 struct lttng_ht_node_str
*ua_chan_node
;
3537 struct ust_app
*app
;
3538 struct ust_app_session
*ua_sess
;
3539 struct ust_app_channel
*ua_chan
;
3541 if (usess
== NULL
|| uchan
== NULL
) {
3542 ERR("Disabling UST global channel with NULL values");
3547 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3548 uchan
->name
, usess
->id
);
3552 /* For every registered applications */
3553 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3554 struct lttng_ht_iter uiter
;
3555 if (!app
->compatible
) {
3557 * TODO: In time, we should notice the caller of this error by
3558 * telling him that this is a version error.
3562 ua_sess
= lookup_session_by_app(usess
, app
);
3563 if (ua_sess
== NULL
) {
3568 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3569 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3570 /* If the session if found for the app, the channel must be there */
3571 assert(ua_chan_node
);
3573 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3574 /* The channel must not be already disabled */
3575 assert(ua_chan
->enabled
== 1);
3577 /* Disable channel onto application */
3578 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3580 /* XXX: We might want to report this error at some point... */
3592 * For a specific UST session, enable the channel for all registered apps.
3594 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3595 struct ltt_ust_channel
*uchan
)
3598 struct lttng_ht_iter iter
;
3599 struct ust_app
*app
;
3600 struct ust_app_session
*ua_sess
;
3602 if (usess
== NULL
|| uchan
== NULL
) {
3603 ERR("Adding UST global channel to NULL values");
3608 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3609 uchan
->name
, usess
->id
);
3613 /* For every registered applications */
3614 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3615 if (!app
->compatible
) {
3617 * TODO: In time, we should notice the caller of this error by
3618 * telling him that this is a version error.
3622 ua_sess
= lookup_session_by_app(usess
, app
);
3623 if (ua_sess
== NULL
) {
3627 /* Enable channel onto application */
3628 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3630 /* XXX: We might want to report this error at some point... */
3642 * Disable an event in a channel and for a specific session.
3644 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3645 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3648 struct lttng_ht_iter iter
, uiter
;
3649 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3650 struct ust_app
*app
;
3651 struct ust_app_session
*ua_sess
;
3652 struct ust_app_channel
*ua_chan
;
3653 struct ust_app_event
*ua_event
;
3655 DBG("UST app disabling event %s for all apps in channel "
3656 "%s for session id %" PRIu64
,
3657 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3661 /* For all registered applications */
3662 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3663 if (!app
->compatible
) {
3665 * TODO: In time, we should notice the caller of this error by
3666 * telling him that this is a version error.
3670 ua_sess
= lookup_session_by_app(usess
, app
);
3671 if (ua_sess
== NULL
) {
3676 /* Lookup channel in the ust app session */
3677 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3678 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3679 if (ua_chan_node
== NULL
) {
3680 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3681 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3684 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3686 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3687 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3688 if (ua_event_node
== NULL
) {
3689 DBG2("Event %s not found in channel %s for app pid %d."
3690 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3693 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3695 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3697 /* XXX: Report error someday... */
3708 * For a specific UST session, create the channel for all registered apps.
3710 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3711 struct ltt_ust_channel
*uchan
)
3713 int ret
= 0, created
;
3714 struct lttng_ht_iter iter
;
3715 struct ust_app
*app
;
3716 struct ust_app_session
*ua_sess
= NULL
;
3718 /* Very wrong code flow */
3722 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3723 uchan
->name
, usess
->id
);
3727 /* For every registered applications */
3728 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3729 if (!app
->compatible
) {
3731 * TODO: In time, we should notice the caller of this error by
3732 * telling him that this is a version error.
3736 if (!trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
3742 * Create session on the tracer side and add it to app session HT. Note
3743 * that if session exist, it will simply return a pointer to the ust
3746 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3751 * The application's socket is not valid. Either a bad socket
3752 * or a timeout on it. We can't inform the caller that for a
3753 * specific app, the session failed so lets continue here.
3758 goto error_rcu_unlock
;
3763 pthread_mutex_lock(&ua_sess
->lock
);
3764 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3765 sizeof(uchan
->name
))) {
3766 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3769 /* Create channel onto application. We don't need the chan ref. */
3770 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3771 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3773 pthread_mutex_unlock(&ua_sess
->lock
);
3775 if (ret
== -ENOMEM
) {
3776 /* No more memory is a fatal error. Stop right now. */
3777 goto error_rcu_unlock
;
3779 /* Cleanup the created session if it's the case. */
3781 destroy_app_session(app
, ua_sess
);
3792 * Enable event for a specific session and channel on the tracer.
3794 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3795 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3798 struct lttng_ht_iter iter
, uiter
;
3799 struct lttng_ht_node_str
*ua_chan_node
;
3800 struct ust_app
*app
;
3801 struct ust_app_session
*ua_sess
;
3802 struct ust_app_channel
*ua_chan
;
3803 struct ust_app_event
*ua_event
;
3805 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3806 uevent
->attr
.name
, usess
->id
);
3809 * NOTE: At this point, this function is called only if the session and
3810 * channel passed are already created for all apps. and enabled on the
3816 /* For all registered applications */
3817 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3818 if (!app
->compatible
) {
3820 * TODO: In time, we should notice the caller of this error by
3821 * telling him that this is a version error.
3825 ua_sess
= lookup_session_by_app(usess
, app
);
3827 /* The application has problem or is probably dead. */
3831 pthread_mutex_lock(&ua_sess
->lock
);
3833 /* Lookup channel in the ust app session */
3834 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3835 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3836 /* If the channel is not found, there is a code flow error */
3837 assert(ua_chan_node
);
3839 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3841 /* Get event node */
3842 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3843 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3844 if (ua_event
== NULL
) {
3845 DBG3("UST app enable event %s not found for app PID %d."
3846 "Skipping app", uevent
->attr
.name
, app
->pid
);
3850 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3852 pthread_mutex_unlock(&ua_sess
->lock
);
3856 pthread_mutex_unlock(&ua_sess
->lock
);
3865 * For a specific existing UST session and UST channel, creates the event for
3866 * all registered apps.
3868 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3869 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3872 struct lttng_ht_iter iter
, uiter
;
3873 struct lttng_ht_node_str
*ua_chan_node
;
3874 struct ust_app
*app
;
3875 struct ust_app_session
*ua_sess
;
3876 struct ust_app_channel
*ua_chan
;
3878 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3879 uevent
->attr
.name
, usess
->id
);
3883 /* For all registered applications */
3884 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3885 if (!app
->compatible
) {
3887 * TODO: In time, we should notice the caller of this error by
3888 * telling him that this is a version error.
3892 ua_sess
= lookup_session_by_app(usess
, app
);
3894 /* The application has problem or is probably dead. */
3898 pthread_mutex_lock(&ua_sess
->lock
);
3899 /* Lookup channel in the ust app session */
3900 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3901 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3902 /* If the channel is not found, there is a code flow error */
3903 assert(ua_chan_node
);
3905 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3907 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3908 pthread_mutex_unlock(&ua_sess
->lock
);
3910 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3911 /* Possible value at this point: -ENOMEM. If so, we stop! */
3914 DBG2("UST app event %s already exist on app PID %d",
3915 uevent
->attr
.name
, app
->pid
);
3926 * Start tracing for a specific UST session and app.
3929 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3932 struct ust_app_session
*ua_sess
;
3934 DBG("Starting tracing for ust app pid %d", app
->pid
);
3938 if (!app
->compatible
) {
3942 ua_sess
= lookup_session_by_app(usess
, app
);
3943 if (ua_sess
== NULL
) {
3944 /* The session is in teardown process. Ignore and continue. */
3948 pthread_mutex_lock(&ua_sess
->lock
);
3950 /* Upon restart, we skip the setup, already done */
3951 if (ua_sess
->started
) {
3955 /* Create directories if consumer is LOCAL and has a path defined. */
3956 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3957 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3958 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3959 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3961 if (ret
!= -EEXIST
) {
3962 ERR("Trace directory creation error");
3969 * Create the metadata for the application. This returns gracefully if a
3970 * metadata was already set for the session.
3972 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3977 health_code_update();
3980 /* This start the UST tracing */
3981 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3983 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3984 ERR("Error starting tracing for app pid: %d (ret: %d)",
3987 DBG("UST app start session failed. Application is dead.");
3989 * This is normal behavior, an application can die during the
3990 * creation process. Don't report an error so the execution can
3991 * continue normally.
3993 pthread_mutex_unlock(&ua_sess
->lock
);
3999 /* Indicate that the session has been started once */
4000 ua_sess
->started
= 1;
4002 pthread_mutex_unlock(&ua_sess
->lock
);
4004 health_code_update();
4006 /* Quiescent wait after starting trace */
4007 ret
= ustctl_wait_quiescent(app
->sock
);
4008 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4009 ERR("UST app wait quiescent failed for app pid %d ret %d",
4015 health_code_update();
4019 pthread_mutex_unlock(&ua_sess
->lock
);
4021 health_code_update();
4026 * Stop tracing for a specific UST session and app.
4029 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4032 struct ust_app_session
*ua_sess
;
4033 struct ust_registry_session
*registry
;
4035 DBG("Stopping tracing for ust app pid %d", app
->pid
);
4039 if (!app
->compatible
) {
4040 goto end_no_session
;
4043 ua_sess
= lookup_session_by_app(usess
, app
);
4044 if (ua_sess
== NULL
) {
4045 goto end_no_session
;
4048 pthread_mutex_lock(&ua_sess
->lock
);
4051 * If started = 0, it means that stop trace has been called for a session
4052 * that was never started. It's possible since we can have a fail start
4053 * from either the application manager thread or the command thread. Simply
4054 * indicate that this is a stop error.
4056 if (!ua_sess
->started
) {
4057 goto error_rcu_unlock
;
4060 health_code_update();
4062 /* This inhibits UST tracing */
4063 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
4065 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4066 ERR("Error stopping tracing for app pid: %d (ret: %d)",
4069 DBG("UST app stop session failed. Application is dead.");
4071 * This is normal behavior, an application can die during the
4072 * creation process. Don't report an error so the execution can
4073 * continue normally.
4077 goto error_rcu_unlock
;
4080 health_code_update();
4082 /* Quiescent wait after stopping trace */
4083 ret
= ustctl_wait_quiescent(app
->sock
);
4084 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4085 ERR("UST app wait quiescent failed for app pid %d ret %d",
4089 health_code_update();
4091 registry
= get_session_registry(ua_sess
);
4094 /* Push metadata for application before freeing the application. */
4095 (void) push_metadata(registry
, ua_sess
->consumer
);
4098 pthread_mutex_unlock(&ua_sess
->lock
);
4101 health_code_update();
4105 pthread_mutex_unlock(&ua_sess
->lock
);
4107 health_code_update();
4112 int ust_app_flush_app_session(struct ust_app
*app
,
4113 struct ust_app_session
*ua_sess
)
4115 int ret
, retval
= 0;
4116 struct lttng_ht_iter iter
;
4117 struct ust_app_channel
*ua_chan
;
4118 struct consumer_socket
*socket
;
4120 DBG("Flushing app session buffers for ust app pid %d", app
->pid
);
4124 if (!app
->compatible
) {
4125 goto end_not_compatible
;
4128 pthread_mutex_lock(&ua_sess
->lock
);
4130 health_code_update();
4132 /* Flushing buffers */
4133 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
4136 /* Flush buffers and push metadata. */
4137 switch (ua_sess
->buffer_type
) {
4138 case LTTNG_BUFFER_PER_PID
:
4139 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4141 health_code_update();
4142 assert(ua_chan
->is_sent
);
4143 ret
= consumer_flush_channel(socket
, ua_chan
->key
);
4145 ERR("Error flushing consumer channel");
4151 case LTTNG_BUFFER_PER_UID
:
4157 health_code_update();
4159 pthread_mutex_unlock(&ua_sess
->lock
);
4163 health_code_update();
4168 * Flush buffers for all applications for a specific UST session.
4169 * Called with UST session lock held.
4172 int ust_app_flush_session(struct ltt_ust_session
*usess
)
4177 DBG("Flushing session buffers for all ust apps");
4181 /* Flush buffers and push metadata. */
4182 switch (usess
->buffer_type
) {
4183 case LTTNG_BUFFER_PER_UID
:
4185 struct buffer_reg_uid
*reg
;
4186 struct lttng_ht_iter iter
;
4188 /* Flush all per UID buffers associated to that session. */
4189 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4190 struct ust_registry_session
*ust_session_reg
;
4191 struct buffer_reg_channel
*reg_chan
;
4192 struct consumer_socket
*socket
;
4194 /* Get consumer socket to use to push the metadata.*/
4195 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4198 /* Ignore request if no consumer is found for the session. */
4202 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4203 reg_chan
, node
.node
) {
4205 * The following call will print error values so the return
4206 * code is of little importance because whatever happens, we
4207 * have to try them all.
4209 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4212 ust_session_reg
= reg
->registry
->reg
.ust
;
4213 /* Push metadata. */
4214 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4218 case LTTNG_BUFFER_PER_PID
:
4220 struct ust_app_session
*ua_sess
;
4221 struct lttng_ht_iter iter
;
4222 struct ust_app
*app
;
4224 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4225 ua_sess
= lookup_session_by_app(usess
, app
);
4226 if (ua_sess
== NULL
) {
4229 (void) ust_app_flush_app_session(app
, ua_sess
);
4240 health_code_update();
4245 * Destroy a specific UST session in apps.
4247 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4250 struct ust_app_session
*ua_sess
;
4251 struct lttng_ht_iter iter
;
4252 struct lttng_ht_node_u64
*node
;
4254 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4258 if (!app
->compatible
) {
4262 __lookup_session_by_app(usess
, app
, &iter
);
4263 node
= lttng_ht_iter_get_node_u64(&iter
);
4265 /* Session is being or is deleted. */
4268 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4270 health_code_update();
4271 destroy_app_session(app
, ua_sess
);
4273 health_code_update();
4275 /* Quiescent wait after stopping trace */
4276 ret
= ustctl_wait_quiescent(app
->sock
);
4277 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4278 ERR("UST app wait quiescent failed for app pid %d ret %d",
4283 health_code_update();
4288 * Start tracing for the UST session.
4290 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4293 struct lttng_ht_iter iter
;
4294 struct ust_app
*app
;
4296 DBG("Starting all UST traces");
4300 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4301 ret
= ust_app_start_trace(usess
, app
);
4303 /* Continue to next apps even on error */
4314 * Start tracing for the UST session.
4315 * Called with UST session lock held.
4317 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4320 struct lttng_ht_iter iter
;
4321 struct ust_app
*app
;
4323 DBG("Stopping all UST traces");
4327 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4328 ret
= ust_app_stop_trace(usess
, app
);
4330 /* Continue to next apps even on error */
4335 (void) ust_app_flush_session(usess
);
4343 * Destroy app UST session.
4345 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4348 struct lttng_ht_iter iter
;
4349 struct ust_app
*app
;
4351 DBG("Destroy all UST traces");
4355 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4356 ret
= destroy_trace(usess
, app
);
4358 /* Continue to next apps even on error */
4369 void ust_app_global_create(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4372 struct lttng_ht_iter iter
, uiter
;
4373 struct ust_app_session
*ua_sess
= NULL
;
4374 struct ust_app_channel
*ua_chan
;
4375 struct ust_app_event
*ua_event
;
4376 struct ust_app_ctx
*ua_ctx
;
4379 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &is_created
);
4381 /* Tracer is probably gone or ENOMEM. */
4385 /* App session already created. */
4390 pthread_mutex_lock(&ua_sess
->lock
);
4393 * We can iterate safely here over all UST app session since the create ust
4394 * app session above made a shadow copy of the UST global domain from the
4397 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4399 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4402 * Stop everything. On error, the application failed, no more
4403 * file descriptor are available or ENOMEM so stopping here is
4404 * the only thing we can do for now.
4410 * Add context using the list so they are enabled in the same order the
4413 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4414 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4421 /* For each events */
4422 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4424 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4431 pthread_mutex_unlock(&ua_sess
->lock
);
4433 if (usess
->active
) {
4434 ret
= ust_app_start_trace(usess
, app
);
4439 DBG2("UST trace started for app pid %d", app
->pid
);
4442 /* Everything went well at this point. */
4446 pthread_mutex_unlock(&ua_sess
->lock
);
4449 destroy_app_session(app
, ua_sess
);
4455 void ust_app_global_destroy(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4457 struct ust_app_session
*ua_sess
;
4459 ua_sess
= lookup_session_by_app(usess
, app
);
4460 if (ua_sess
== NULL
) {
4463 destroy_app_session(app
, ua_sess
);
4467 * Add channels/events from UST global domain to registered apps at sock.
4469 * Called with session lock held.
4470 * Called with RCU read-side lock held.
4472 void ust_app_global_update(struct ltt_ust_session
*usess
, struct ust_app
*app
)
4476 DBG2("UST app global update for app sock %d for session id %" PRIu64
,
4477 app
->sock
, usess
->id
);
4479 if (!app
->compatible
) {
4483 if (trace_ust_pid_tracker_lookup(usess
, app
->pid
)) {
4484 ust_app_global_create(usess
, app
);
4486 ust_app_global_destroy(usess
, app
);
4491 * Called with session lock held.
4493 void ust_app_global_update_all(struct ltt_ust_session
*usess
)
4495 struct lttng_ht_iter iter
;
4496 struct ust_app
*app
;
4499 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4500 ust_app_global_update(usess
, app
);
4506 * Add context to a specific channel for global UST domain.
4508 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4509 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4512 struct lttng_ht_node_str
*ua_chan_node
;
4513 struct lttng_ht_iter iter
, uiter
;
4514 struct ust_app_channel
*ua_chan
= NULL
;
4515 struct ust_app_session
*ua_sess
;
4516 struct ust_app
*app
;
4520 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4521 if (!app
->compatible
) {
4523 * TODO: In time, we should notice the caller of this error by
4524 * telling him that this is a version error.
4528 ua_sess
= lookup_session_by_app(usess
, app
);
4529 if (ua_sess
== NULL
) {
4533 pthread_mutex_lock(&ua_sess
->lock
);
4534 /* Lookup channel in the ust app session */
4535 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4536 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4537 if (ua_chan_node
== NULL
) {
4540 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4542 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4547 pthread_mutex_unlock(&ua_sess
->lock
);
4555 * Enable event for a channel from a UST session for a specific PID.
4557 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4558 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4561 struct lttng_ht_iter iter
;
4562 struct lttng_ht_node_str
*ua_chan_node
;
4563 struct ust_app
*app
;
4564 struct ust_app_session
*ua_sess
;
4565 struct ust_app_channel
*ua_chan
;
4566 struct ust_app_event
*ua_event
;
4568 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4572 app
= ust_app_find_by_pid(pid
);
4574 ERR("UST app enable event per PID %d not found", pid
);
4579 if (!app
->compatible
) {
4584 ua_sess
= lookup_session_by_app(usess
, app
);
4586 /* The application has problem or is probably dead. */
4591 pthread_mutex_lock(&ua_sess
->lock
);
4592 /* Lookup channel in the ust app session */
4593 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4594 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4595 /* If the channel is not found, there is a code flow error */
4596 assert(ua_chan_node
);
4598 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4600 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4601 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4602 if (ua_event
== NULL
) {
4603 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4608 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4615 pthread_mutex_unlock(&ua_sess
->lock
);
4622 * Calibrate registered applications.
4624 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4627 struct lttng_ht_iter iter
;
4628 struct ust_app
*app
;
4632 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4633 if (!app
->compatible
) {
4635 * TODO: In time, we should notice the caller of this error by
4636 * telling him that this is a version error.
4641 health_code_update();
4643 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4647 /* Means that it's not implemented on the tracer side. */
4651 DBG2("Calibrate app PID %d returned with error %d",
4658 DBG("UST app global domain calibration finished");
4662 health_code_update();
4668 * Receive registration and populate the given msg structure.
4670 * On success return 0 else a negative value returned by the ustctl call.
4672 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4675 uint32_t pid
, ppid
, uid
, gid
;
4679 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4680 &pid
, &ppid
, &uid
, &gid
,
4681 &msg
->bits_per_long
,
4682 &msg
->uint8_t_alignment
,
4683 &msg
->uint16_t_alignment
,
4684 &msg
->uint32_t_alignment
,
4685 &msg
->uint64_t_alignment
,
4686 &msg
->long_alignment
,
4693 case LTTNG_UST_ERR_EXITING
:
4694 DBG3("UST app recv reg message failed. Application died");
4696 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4697 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4698 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4699 LTTNG_UST_ABI_MINOR_VERSION
);
4702 ERR("UST app recv reg message failed with ret %d", ret
);
4707 msg
->pid
= (pid_t
) pid
;
4708 msg
->ppid
= (pid_t
) ppid
;
4709 msg
->uid
= (uid_t
) uid
;
4710 msg
->gid
= (gid_t
) gid
;
4717 * Return a ust app channel object using the application object and the channel
4718 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4719 * lock MUST be acquired before calling this function.
4721 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4724 struct lttng_ht_node_ulong
*node
;
4725 struct lttng_ht_iter iter
;
4726 struct ust_app_channel
*ua_chan
= NULL
;
4730 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4731 node
= lttng_ht_iter_get_node_ulong(&iter
);
4733 DBG2("UST app channel find by objd %d not found", objd
);
4737 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4744 * Reply to a register channel notification from an application on the notify
4745 * socket. The channel metadata is also created.
4747 * The session UST registry lock is acquired in this function.
4749 * On success 0 is returned else a negative value.
4751 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4752 size_t nr_fields
, struct ustctl_field
*fields
)
4754 int ret
, ret_code
= 0;
4755 uint32_t chan_id
, reg_count
;
4756 uint64_t chan_reg_key
;
4757 enum ustctl_channel_header type
;
4758 struct ust_app
*app
;
4759 struct ust_app_channel
*ua_chan
;
4760 struct ust_app_session
*ua_sess
;
4761 struct ust_registry_session
*registry
;
4762 struct ust_registry_channel
*chan_reg
;
4766 /* Lookup application. If not found, there is a code flow error. */
4767 app
= find_app_by_notify_sock(sock
);
4769 DBG("Application socket %d is being teardown. Abort event notify",
4773 goto error_rcu_unlock
;
4776 /* Lookup channel by UST object descriptor. */
4777 ua_chan
= find_channel_by_objd(app
, cobjd
);
4779 DBG("Application channel is being teardown. Abort event notify");
4782 goto error_rcu_unlock
;
4785 assert(ua_chan
->session
);
4786 ua_sess
= ua_chan
->session
;
4788 /* Get right session registry depending on the session buffer type. */
4789 registry
= get_session_registry(ua_sess
);
4792 /* Depending on the buffer type, a different channel key is used. */
4793 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4794 chan_reg_key
= ua_chan
->tracing_channel_id
;
4796 chan_reg_key
= ua_chan
->key
;
4799 pthread_mutex_lock(®istry
->lock
);
4801 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4804 if (!chan_reg
->register_done
) {
4805 reg_count
= ust_registry_get_event_count(chan_reg
);
4806 if (reg_count
< 31) {
4807 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4809 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4812 chan_reg
->nr_ctx_fields
= nr_fields
;
4813 chan_reg
->ctx_fields
= fields
;
4814 chan_reg
->header_type
= type
;
4816 /* Get current already assigned values. */
4817 type
= chan_reg
->header_type
;
4819 /* Set to NULL so the error path does not do a double free. */
4822 /* Channel id is set during the object creation. */
4823 chan_id
= chan_reg
->chan_id
;
4825 /* Append to metadata */
4826 if (!chan_reg
->metadata_dumped
) {
4827 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4829 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4835 DBG3("UST app replying to register channel key %" PRIu64
4836 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4839 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4841 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4842 ERR("UST app reply channel failed with ret %d", ret
);
4844 DBG3("UST app reply channel failed. Application died");
4849 /* This channel registry registration is completed. */
4850 chan_reg
->register_done
= 1;
4853 pthread_mutex_unlock(®istry
->lock
);
4863 * Add event to the UST channel registry. When the event is added to the
4864 * registry, the metadata is also created. Once done, this replies to the
4865 * application with the appropriate error code.
4867 * The session UST registry lock is acquired in the function.
4869 * On success 0 is returned else a negative value.
4871 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4872 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4873 char *model_emf_uri
)
4876 uint32_t event_id
= 0;
4877 uint64_t chan_reg_key
;
4878 struct ust_app
*app
;
4879 struct ust_app_channel
*ua_chan
;
4880 struct ust_app_session
*ua_sess
;
4881 struct ust_registry_session
*registry
;
4885 /* Lookup application. If not found, there is a code flow error. */
4886 app
= find_app_by_notify_sock(sock
);
4888 DBG("Application socket %d is being teardown. Abort event notify",
4893 free(model_emf_uri
);
4894 goto error_rcu_unlock
;
4897 /* Lookup channel by UST object descriptor. */
4898 ua_chan
= find_channel_by_objd(app
, cobjd
);
4900 DBG("Application channel is being teardown. Abort event notify");
4904 free(model_emf_uri
);
4905 goto error_rcu_unlock
;
4908 assert(ua_chan
->session
);
4909 ua_sess
= ua_chan
->session
;
4911 registry
= get_session_registry(ua_sess
);
4914 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4915 chan_reg_key
= ua_chan
->tracing_channel_id
;
4917 chan_reg_key
= ua_chan
->key
;
4920 pthread_mutex_lock(®istry
->lock
);
4923 * From this point on, this call acquires the ownership of the sig, fields
4924 * and model_emf_uri meaning any free are done inside it if needed. These
4925 * three variables MUST NOT be read/write after this.
4927 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4928 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4929 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4933 * The return value is returned to ustctl so in case of an error, the
4934 * application can be notified. In case of an error, it's important not to
4935 * return a negative error or else the application will get closed.
4937 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4939 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4940 ERR("UST app reply event failed with ret %d", ret
);
4942 DBG3("UST app reply event failed. Application died");
4945 * No need to wipe the create event since the application socket will
4946 * get close on error hence cleaning up everything by itself.
4951 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4955 pthread_mutex_unlock(®istry
->lock
);
4962 * Handle application notification through the given notify socket.
4964 * Return 0 on success or else a negative value.
4966 int ust_app_recv_notify(int sock
)
4969 enum ustctl_notify_cmd cmd
;
4971 DBG3("UST app receiving notify from sock %d", sock
);
4973 ret
= ustctl_recv_notify(sock
, &cmd
);
4975 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4976 ERR("UST app recv notify failed with ret %d", ret
);
4978 DBG3("UST app recv notify failed. Application died");
4984 case USTCTL_NOTIFY_CMD_EVENT
:
4986 int sobjd
, cobjd
, loglevel
;
4987 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4989 struct ustctl_field
*fields
;
4991 DBG2("UST app ustctl register event received");
4993 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4994 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4996 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4997 ERR("UST app recv event failed with ret %d", ret
);
4999 DBG3("UST app recv event failed. Application died");
5005 * Add event to the UST registry coming from the notify socket. This
5006 * call will free if needed the sig, fields and model_emf_uri. This
5007 * code path loses the ownsership of these variables and transfer them
5008 * to the this function.
5010 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
5011 fields
, loglevel
, model_emf_uri
);
5018 case USTCTL_NOTIFY_CMD_CHANNEL
:
5022 struct ustctl_field
*fields
;
5024 DBG2("UST app ustctl register channel received");
5026 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
5029 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
5030 ERR("UST app recv channel failed with ret %d", ret
);
5032 DBG3("UST app recv channel failed. Application died");
5038 * The fields ownership are transfered to this function call meaning
5039 * that if needed it will be freed. After this, it's invalid to access
5040 * fields or clean it up.
5042 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
5051 /* Should NEVER happen. */
5060 * Once the notify socket hangs up, this is called. First, it tries to find the
5061 * corresponding application. On failure, the call_rcu to close the socket is
5062 * executed. If an application is found, it tries to delete it from the notify
5063 * socket hash table. Whathever the result, it proceeds to the call_rcu.
5065 * Note that an object needs to be allocated here so on ENOMEM failure, the
5066 * call RCU is not done but the rest of the cleanup is.
5068 void ust_app_notify_sock_unregister(int sock
)
5071 struct lttng_ht_iter iter
;
5072 struct ust_app
*app
;
5073 struct ust_app_notify_sock_obj
*obj
;
5079 obj
= zmalloc(sizeof(*obj
));
5082 * An ENOMEM is kind of uncool. If this strikes we continue the
5083 * procedure but the call_rcu will not be called. In this case, we
5084 * accept the fd leak rather than possibly creating an unsynchronized
5085 * state between threads.
5087 * TODO: The notify object should be created once the notify socket is
5088 * registered and stored independantely from the ust app object. The
5089 * tricky part is to synchronize the teardown of the application and
5090 * this notify object. Let's keep that in mind so we can avoid this
5091 * kind of shenanigans with ENOMEM in the teardown path.
5098 DBG("UST app notify socket unregister %d", sock
);
5101 * Lookup application by notify socket. If this fails, this means that the
5102 * hash table delete has already been done by the application
5103 * unregistration process so we can safely close the notify socket in a
5106 app
= find_app_by_notify_sock(sock
);
5111 iter
.iter
.node
= &app
->notify_sock_n
.node
;
5114 * Whatever happens here either we fail or succeed, in both cases we have
5115 * to close the socket after a grace period to continue to the call RCU
5116 * here. If the deletion is successful, the application is not visible
5117 * anymore by other threads and is it fails it means that it was already
5118 * deleted from the hash table so either way we just have to close the
5121 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
5127 * Close socket after a grace period to avoid for the socket to be reused
5128 * before the application object is freed creating potential race between
5129 * threads trying to add unique in the global hash table.
5132 call_rcu(&obj
->head
, close_notify_sock_rcu
);
5137 * Destroy a ust app data structure and free its memory.
5139 void ust_app_destroy(struct ust_app
*app
)
5145 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
5149 * Take a snapshot for a given UST session. The snapshot is sent to the given
5152 * Return 0 on success or else a negative value.
5154 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
5155 struct snapshot_output
*output
, int wait
,
5156 uint64_t nb_packets_per_stream
)
5159 unsigned int snapshot_done
= 0;
5160 struct lttng_ht_iter iter
;
5161 struct ust_app
*app
;
5162 char pathname
[PATH_MAX
];
5169 switch (usess
->buffer_type
) {
5170 case LTTNG_BUFFER_PER_UID
:
5172 struct buffer_reg_uid
*reg
;
5174 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5175 struct buffer_reg_channel
*reg_chan
;
5176 struct consumer_socket
*socket
;
5178 /* Get consumer socket to use to push the metadata.*/
5179 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
5186 memset(pathname
, 0, sizeof(pathname
));
5187 ret
= snprintf(pathname
, sizeof(pathname
),
5188 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
5189 reg
->uid
, reg
->bits_per_long
);
5191 PERROR("snprintf snapshot path");
5195 /* Add the UST default trace dir to path. */
5196 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5197 reg_chan
, node
.node
) {
5198 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
,
5199 output
, 0, usess
->uid
, usess
->gid
, pathname
, wait
,
5200 nb_packets_per_stream
);
5205 ret
= consumer_snapshot_channel(socket
,
5206 reg
->registry
->reg
.ust
->metadata_key
, output
, 1,
5207 usess
->uid
, usess
->gid
, pathname
, wait
, 0);
5215 case LTTNG_BUFFER_PER_PID
:
5217 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5218 struct consumer_socket
*socket
;
5219 struct lttng_ht_iter chan_iter
;
5220 struct ust_app_channel
*ua_chan
;
5221 struct ust_app_session
*ua_sess
;
5222 struct ust_registry_session
*registry
;
5224 ua_sess
= lookup_session_by_app(usess
, app
);
5226 /* Session not associated with this app. */
5230 /* Get the right consumer socket for the application. */
5231 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5238 /* Add the UST default trace dir to path. */
5239 memset(pathname
, 0, sizeof(pathname
));
5240 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5243 PERROR("snprintf snapshot path");
5247 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5248 ua_chan
, node
.node
) {
5249 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
,
5250 0, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5251 nb_packets_per_stream
);
5257 registry
= get_session_registry(ua_sess
);
5259 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5260 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
, 0);
5273 if (!snapshot_done
) {
5275 * If no snapshot was made and we are not in the error path, this means
5276 * that there are no buffers thus no (prior) application to snapshot
5277 * data from so we have simply NO data.
5288 * Return the size taken by one more packet per stream.
5290 uint64_t ust_app_get_size_one_more_packet_per_stream(struct ltt_ust_session
*usess
,
5291 uint64_t cur_nr_packets
)
5293 uint64_t tot_size
= 0;
5294 struct ust_app
*app
;
5295 struct lttng_ht_iter iter
;
5299 switch (usess
->buffer_type
) {
5300 case LTTNG_BUFFER_PER_UID
:
5302 struct buffer_reg_uid
*reg
;
5304 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5305 struct buffer_reg_channel
*reg_chan
;
5308 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5309 reg_chan
, node
.node
) {
5310 if (cur_nr_packets
>= reg_chan
->num_subbuf
) {
5312 * Don't take channel into account if we
5313 * already grab all its packets.
5317 tot_size
+= reg_chan
->subbuf_size
* reg_chan
->stream_count
;
5323 case LTTNG_BUFFER_PER_PID
:
5326 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5327 struct ust_app_channel
*ua_chan
;
5328 struct ust_app_session
*ua_sess
;
5329 struct lttng_ht_iter chan_iter
;
5331 ua_sess
= lookup_session_by_app(usess
, app
);
5333 /* Session not associated with this app. */
5337 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5338 ua_chan
, node
.node
) {
5339 if (cur_nr_packets
>= ua_chan
->attr
.num_subbuf
) {
5341 * Don't take channel into account if we
5342 * already grab all its packets.
5346 tot_size
+= ua_chan
->attr
.subbuf_size
* ua_chan
->streams
.count
;