2 * Copyright (C) 2011 - David Goulet <david.goulet@polymtl.ca>
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License, version 2 only,
6 * as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License along
14 * with this program; if not, write to the Free Software Foundation, Inc.,
15 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <sys/types.h>
28 #include <urcu/compiler.h>
29 #include <lttng/ust-error.h>
32 #include <common/common.h>
33 #include <common/sessiond-comm/sessiond-comm.h>
35 #include "buffer-registry.h"
37 #include "health-sessiond.h"
39 #include "ust-consumer.h"
43 /* Next available channel key. Access under next_channel_key_lock. */
44 static uint64_t _next_channel_key
;
45 static pthread_mutex_t next_channel_key_lock
= PTHREAD_MUTEX_INITIALIZER
;
47 /* Next available session ID. Access under next_session_id_lock. */
48 static uint64_t _next_session_id
;
49 static pthread_mutex_t next_session_id_lock
= PTHREAD_MUTEX_INITIALIZER
;
52 * Return the incremented value of next_channel_key.
54 static uint64_t get_next_channel_key(void)
58 pthread_mutex_lock(&next_channel_key_lock
);
59 ret
= ++_next_channel_key
;
60 pthread_mutex_unlock(&next_channel_key_lock
);
65 * Return the atomically incremented value of next_session_id.
67 static uint64_t get_next_session_id(void)
71 pthread_mutex_lock(&next_session_id_lock
);
72 ret
= ++_next_session_id
;
73 pthread_mutex_unlock(&next_session_id_lock
);
77 static void copy_channel_attr_to_ustctl(
78 struct ustctl_consumer_channel_attr
*attr
,
79 struct lttng_ust_channel_attr
*uattr
)
81 /* Copy event attributes since the layout is different. */
82 attr
->subbuf_size
= uattr
->subbuf_size
;
83 attr
->num_subbuf
= uattr
->num_subbuf
;
84 attr
->overwrite
= uattr
->overwrite
;
85 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
86 attr
->read_timer_interval
= uattr
->read_timer_interval
;
87 attr
->output
= uattr
->output
;
91 * Match function for the hash table lookup.
93 * It matches an ust app event based on three attributes which are the event
94 * name, the filter bytecode and the loglevel.
96 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
98 struct ust_app_event
*event
;
99 const struct ust_app_ht_key
*key
;
104 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
107 /* Match the 4 elements of the key: name, filter, loglevel, exclusions */
110 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
114 /* Event loglevel. */
115 if (event
->attr
.loglevel
!= key
->loglevel
) {
116 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
117 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
119 * Match is accepted. This is because on event creation, the
120 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
121 * -1 are accepted for this loglevel type since 0 is the one set by
122 * the API when receiving an enable event.
129 /* One of the filters is NULL, fail. */
130 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
134 if (key
->filter
&& event
->filter
) {
135 /* Both filters exists, check length followed by the bytecode. */
136 if (event
->filter
->len
!= key
->filter
->len
||
137 memcmp(event
->filter
->data
, key
->filter
->data
,
138 event
->filter
->len
) != 0) {
143 /* One of the exclusions is NULL, fail. */
144 if ((key
->exclusion
&& !event
->exclusion
) || (!key
->exclusion
&& event
->exclusion
)) {
148 if (key
->exclusion
&& event
->exclusion
) {
149 /* Both exclusions exists, check count followed by the names. */
150 if (event
->exclusion
->count
!= key
->exclusion
->count
||
151 memcmp(event
->exclusion
->names
, key
->exclusion
->names
,
152 event
->exclusion
->count
* LTTNG_UST_SYM_NAME_LEN
) != 0) {
166 * Unique add of an ust app event in the given ht. This uses the custom
167 * ht_match_ust_app_event match function and the event name as hash.
169 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
170 struct ust_app_event
*event
)
172 struct cds_lfht_node
*node_ptr
;
173 struct ust_app_ht_key key
;
177 assert(ua_chan
->events
);
180 ht
= ua_chan
->events
;
181 key
.name
= event
->attr
.name
;
182 key
.filter
= event
->filter
;
183 key
.loglevel
= event
->attr
.loglevel
;
184 key
.exclusion
= event
->exclusion
;
186 node_ptr
= cds_lfht_add_unique(ht
->ht
,
187 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
188 ht_match_ust_app_event
, &key
, &event
->node
.node
);
189 assert(node_ptr
== &event
->node
.node
);
193 * Close the notify socket from the given RCU head object. This MUST be called
194 * through a call_rcu().
196 static void close_notify_sock_rcu(struct rcu_head
*head
)
199 struct ust_app_notify_sock_obj
*obj
=
200 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
202 /* Must have a valid fd here. */
203 assert(obj
->fd
>= 0);
205 ret
= close(obj
->fd
);
207 ERR("close notify sock %d RCU", obj
->fd
);
209 lttng_fd_put(LTTNG_FD_APPS
, 1);
215 * Return the session registry according to the buffer type of the given
218 * A registry per UID object MUST exists before calling this function or else
219 * it assert() if not found. RCU read side lock must be acquired.
221 static struct ust_registry_session
*get_session_registry(
222 struct ust_app_session
*ua_sess
)
224 struct ust_registry_session
*registry
= NULL
;
228 switch (ua_sess
->buffer_type
) {
229 case LTTNG_BUFFER_PER_PID
:
231 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
235 registry
= reg_pid
->registry
->reg
.ust
;
238 case LTTNG_BUFFER_PER_UID
:
240 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
241 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
245 registry
= reg_uid
->registry
->reg
.ust
;
257 * Delete ust context safely. RCU read lock must be held before calling
261 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
268 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
269 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
270 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
271 sock
, ua_ctx
->obj
->handle
, ret
);
279 * Delete ust app event safely. RCU read lock must be held before calling
283 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
289 free(ua_event
->filter
);
290 if (ua_event
->exclusion
!= NULL
)
291 free(ua_event
->exclusion
);
292 if (ua_event
->obj
!= NULL
) {
293 ret
= ustctl_release_object(sock
, ua_event
->obj
);
294 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
295 ERR("UST app sock %d release event obj failed with ret %d",
304 * Release ust data object of the given stream.
306 * Return 0 on success or else a negative value.
308 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
315 ret
= ustctl_release_object(sock
, stream
->obj
);
316 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
317 ERR("UST app sock %d release stream obj failed with ret %d",
320 lttng_fd_put(LTTNG_FD_APPS
, 2);
328 * Delete ust app stream safely. RCU read lock must be held before calling
332 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
336 (void) release_ust_app_stream(sock
, stream
);
341 * We need to execute ht_destroy outside of RCU read-side critical
342 * section and outside of call_rcu thread, so we postpone its execution
343 * using ht_cleanup_push. It is simpler than to change the semantic of
344 * the many callers of delete_ust_app_session().
347 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
349 struct ust_app_channel
*ua_chan
=
350 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
352 ht_cleanup_push(ua_chan
->ctx
);
353 ht_cleanup_push(ua_chan
->events
);
358 * Delete ust app channel safely. RCU read lock must be held before calling
362 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
366 struct lttng_ht_iter iter
;
367 struct ust_app_event
*ua_event
;
368 struct ust_app_ctx
*ua_ctx
;
369 struct ust_app_stream
*stream
, *stmp
;
370 struct ust_registry_session
*registry
;
374 DBG3("UST app deleting channel %s", ua_chan
->name
);
377 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
378 cds_list_del(&stream
->list
);
379 delete_ust_app_stream(sock
, stream
);
383 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
384 cds_list_del(&ua_ctx
->list
);
385 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
387 delete_ust_app_ctx(sock
, ua_ctx
);
391 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
393 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
395 delete_ust_app_event(sock
, ua_event
);
398 if (ua_chan
->session
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
399 /* Wipe and free registry from session registry. */
400 registry
= get_session_registry(ua_chan
->session
);
402 ust_registry_channel_del_free(registry
, ua_chan
->key
);
406 if (ua_chan
->obj
!= NULL
) {
407 /* Remove channel from application UST object descriptor. */
408 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
409 ret
= lttng_ht_del(app
->ust_objd
, &iter
);
411 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
412 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
413 ERR("UST app sock %d release channel obj failed with ret %d",
416 lttng_fd_put(LTTNG_FD_APPS
, 1);
419 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
423 * Push metadata to consumer socket.
425 * The socket lock MUST be acquired.
426 * The ust app session lock MUST be acquired.
428 * On success, return the len of metadata pushed or else a negative value.
430 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
431 struct consumer_socket
*socket
, int send_zero_data
)
434 char *metadata_str
= NULL
;
442 * On a push metadata error either the consumer is dead or the metadata
443 * channel has been destroyed because its endpoint might have died (e.g:
444 * relayd). If so, the metadata closed flag is set to 1 so we deny pushing
445 * metadata again which is not valid anymore on the consumer side.
447 * The ust app session mutex locked allows us to make this check without
450 if (registry
->metadata_closed
) {
454 pthread_mutex_lock(®istry
->lock
);
456 offset
= registry
->metadata_len_sent
;
457 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
459 DBG3("No metadata to push for metadata key %" PRIu64
,
460 registry
->metadata_key
);
462 if (send_zero_data
) {
463 DBG("No metadata to push");
469 /* Allocate only what we have to send. */
470 metadata_str
= zmalloc(len
);
472 PERROR("zmalloc ust app metadata string");
476 /* Copy what we haven't send out. */
477 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
478 registry
->metadata_len_sent
+= len
;
481 pthread_mutex_unlock(®istry
->lock
);
482 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
483 metadata_str
, len
, offset
);
486 * There is an acceptable race here between the registry metadata key
487 * assignment and the creation on the consumer. The session daemon can
488 * concurrently push metadata for this registry while being created on
489 * the consumer since the metadata key of the registry is assigned
490 * *before* it is setup to avoid the consumer to ask for metadata that
491 * could possibly be not found in the session daemon.
493 * The metadata will get pushed either by the session being stopped or
494 * the consumer requesting metadata if that race is triggered.
496 if (ret
== -LTTCOMM_CONSUMERD_CHANNEL_FAIL
) {
500 /* Update back the actual metadata len sent since it failed here. */
501 pthread_mutex_lock(®istry
->lock
);
502 registry
->metadata_len_sent
-= len
;
503 pthread_mutex_unlock(®istry
->lock
);
513 pthread_mutex_unlock(®istry
->lock
);
520 * For a given application and session, push metadata to consumer. The session
521 * lock MUST be acquired here before calling this.
522 * Either sock or consumer is required : if sock is NULL, the default
523 * socket to send the metadata is retrieved from consumer, if sock
524 * is not NULL we use it to send the metadata.
526 * Return 0 on success else a negative error.
528 static int push_metadata(struct ust_registry_session
*registry
,
529 struct consumer_output
*consumer
)
533 struct consumer_socket
*socket
;
541 * Means that no metadata was assigned to the session. This can happens if
542 * no start has been done previously.
544 if (!registry
->metadata_key
) {
549 /* Get consumer socket to use to push the metadata.*/
550 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
554 goto error_rcu_unlock
;
558 * TODO: Currently, we hold the socket lock around sampling of the next
559 * metadata segment to ensure we send metadata over the consumer socket in
560 * the correct order. This makes the registry lock nest inside the socket
563 * Please note that this is a temporary measure: we should move this lock
564 * back into ust_consumer_push_metadata() when the consumer gets the
565 * ability to reorder the metadata it receives.
567 pthread_mutex_lock(socket
->lock
);
568 ret
= ust_app_push_metadata(registry
, socket
, 0);
569 pthread_mutex_unlock(socket
->lock
);
572 goto error_rcu_unlock
;
580 * On error, flag the registry that the metadata is closed. We were unable
581 * to push anything and this means that either the consumer is not
582 * responding or the metadata cache has been destroyed on the consumer.
584 registry
->metadata_closed
= 1;
591 * Send to the consumer a close metadata command for the given session. Once
592 * done, the metadata channel is deleted and the session metadata pointer is
593 * nullified. The session lock MUST be acquired here unless the application is
594 * in the destroy path.
596 * Return 0 on success else a negative value.
598 static int close_metadata(struct ust_registry_session
*registry
,
599 struct consumer_output
*consumer
)
602 struct consumer_socket
*socket
;
609 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
614 /* Get consumer socket to use to push the metadata.*/
615 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
622 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
629 * Metadata closed. Even on error this means that the consumer is not
630 * responding or not found so either way a second close should NOT be emit
633 registry
->metadata_closed
= 1;
640 * We need to execute ht_destroy outside of RCU read-side critical
641 * section and outside of call_rcu thread, so we postpone its execution
642 * using ht_cleanup_push. It is simpler than to change the semantic of
643 * the many callers of delete_ust_app_session().
646 void delete_ust_app_session_rcu(struct rcu_head
*head
)
648 struct ust_app_session
*ua_sess
=
649 caa_container_of(head
, struct ust_app_session
, rcu_head
);
651 ht_cleanup_push(ua_sess
->channels
);
656 * Delete ust app session safely. RCU read lock must be held before calling
660 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
664 struct lttng_ht_iter iter
;
665 struct ust_app_channel
*ua_chan
;
666 struct ust_registry_session
*registry
;
670 pthread_mutex_lock(&ua_sess
->lock
);
672 registry
= get_session_registry(ua_sess
);
673 if (registry
&& !registry
->metadata_closed
) {
674 /* Push metadata for application before freeing the application. */
675 (void) push_metadata(registry
, ua_sess
->consumer
);
678 * Don't ask to close metadata for global per UID buffers. Close
679 * metadata only on destroy trace session in this case. Also, the
680 * previous push metadata could have flag the metadata registry to
681 * close so don't send a close command if closed.
683 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
684 !registry
->metadata_closed
) {
685 /* And ask to close it for this session registry. */
686 (void) close_metadata(registry
, ua_sess
->consumer
);
690 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
692 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
694 delete_ust_app_channel(sock
, ua_chan
, app
);
697 /* In case of per PID, the registry is kept in the session. */
698 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
699 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
701 buffer_reg_pid_remove(reg_pid
);
702 buffer_reg_pid_destroy(reg_pid
);
706 if (ua_sess
->handle
!= -1) {
707 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
708 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
709 ERR("UST app sock %d release session handle failed with ret %d",
713 pthread_mutex_unlock(&ua_sess
->lock
);
715 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
719 * Delete a traceable application structure from the global list. Never call
720 * this function outside of a call_rcu call.
722 * RCU read side lock should _NOT_ be held when calling this function.
725 void delete_ust_app(struct ust_app
*app
)
728 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
730 /* Delete ust app sessions info */
735 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
737 /* Free every object in the session and the session. */
739 delete_ust_app_session(sock
, ua_sess
, app
);
743 ht_cleanup_push(app
->sessions
);
744 ht_cleanup_push(app
->ust_objd
);
747 * Wait until we have deleted the application from the sock hash table
748 * before closing this socket, otherwise an application could re-use the
749 * socket ID and race with the teardown, using the same hash table entry.
751 * It's OK to leave the close in call_rcu. We want it to stay unique for
752 * all RCU readers that could run concurrently with unregister app,
753 * therefore we _need_ to only close that socket after a grace period. So
754 * it should stay in this RCU callback.
756 * This close() is a very important step of the synchronization model so
757 * every modification to this function must be carefully reviewed.
763 lttng_fd_put(LTTNG_FD_APPS
, 1);
765 DBG2("UST app pid %d deleted", app
->pid
);
770 * URCU intermediate call to delete an UST app.
773 void delete_ust_app_rcu(struct rcu_head
*head
)
775 struct lttng_ht_node_ulong
*node
=
776 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
777 struct ust_app
*app
=
778 caa_container_of(node
, struct ust_app
, pid_n
);
780 DBG3("Call RCU deleting app PID %d", app
->pid
);
785 * Delete the session from the application ht and delete the data structure by
786 * freeing every object inside and releasing them.
788 static void destroy_app_session(struct ust_app
*app
,
789 struct ust_app_session
*ua_sess
)
792 struct lttng_ht_iter iter
;
797 iter
.iter
.node
= &ua_sess
->node
.node
;
798 ret
= lttng_ht_del(app
->sessions
, &iter
);
800 /* Already scheduled for teardown. */
804 /* Once deleted, free the data structure. */
805 delete_ust_app_session(app
->sock
, ua_sess
, app
);
812 * Alloc new UST app session.
815 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
817 struct ust_app_session
*ua_sess
;
819 /* Init most of the default value by allocating and zeroing */
820 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
821 if (ua_sess
== NULL
) {
826 ua_sess
->handle
= -1;
827 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
828 pthread_mutex_init(&ua_sess
->lock
, NULL
);
830 /* Set default metadata channel attribute. */
831 ua_sess
->metadata_attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
832 ua_sess
->metadata_attr
.subbuf_size
= default_get_metadata_subbuf_size();
833 ua_sess
->metadata_attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
834 ua_sess
->metadata_attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
835 ua_sess
->metadata_attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
836 ua_sess
->metadata_attr
.output
= LTTNG_UST_MMAP
;
837 ua_sess
->metadata_attr
.type
= LTTNG_UST_CHAN_METADATA
;
846 * Alloc new UST app channel.
849 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
850 struct ust_app_session
*ua_sess
,
851 struct lttng_ust_channel_attr
*attr
)
853 struct ust_app_channel
*ua_chan
;
855 /* Init most of the default value by allocating and zeroing */
856 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
857 if (ua_chan
== NULL
) {
862 /* Setup channel name */
863 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
864 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
866 ua_chan
->enabled
= 1;
867 ua_chan
->handle
= -1;
868 ua_chan
->session
= ua_sess
;
869 ua_chan
->key
= get_next_channel_key();
870 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
871 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
872 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
874 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
875 CDS_INIT_LIST_HEAD(&ua_chan
->ctx_list
);
877 /* Copy attributes */
879 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
880 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
881 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
882 ua_chan
->attr
.overwrite
= attr
->overwrite
;
883 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
884 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
885 ua_chan
->attr
.output
= attr
->output
;
887 /* By default, the channel is a per cpu channel. */
888 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
890 DBG3("UST app channel %s allocated", ua_chan
->name
);
899 * Allocate and initialize a UST app stream.
901 * Return newly allocated stream pointer or NULL on error.
903 struct ust_app_stream
*ust_app_alloc_stream(void)
905 struct ust_app_stream
*stream
= NULL
;
907 stream
= zmalloc(sizeof(*stream
));
908 if (stream
== NULL
) {
909 PERROR("zmalloc ust app stream");
913 /* Zero could be a valid value for a handle so flag it to -1. */
921 * Alloc new UST app event.
924 struct ust_app_event
*alloc_ust_app_event(char *name
,
925 struct lttng_ust_event
*attr
)
927 struct ust_app_event
*ua_event
;
929 /* Init most of the default value by allocating and zeroing */
930 ua_event
= zmalloc(sizeof(struct ust_app_event
));
931 if (ua_event
== NULL
) {
936 ua_event
->enabled
= 1;
937 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
938 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
939 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
941 /* Copy attributes */
943 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
946 DBG3("UST app event %s allocated", ua_event
->name
);
955 * Alloc new UST app context.
958 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
960 struct ust_app_ctx
*ua_ctx
;
962 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
963 if (ua_ctx
== NULL
) {
967 CDS_INIT_LIST_HEAD(&ua_ctx
->list
);
970 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
973 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
980 * Allocate a filter and copy the given original filter.
982 * Return allocated filter or NULL on error.
984 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
985 struct lttng_ust_filter_bytecode
*orig_f
)
987 struct lttng_ust_filter_bytecode
*filter
= NULL
;
989 /* Copy filter bytecode */
990 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
992 PERROR("zmalloc alloc ust app filter");
996 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
1003 * Find an ust_app using the sock and return it. RCU read side lock must be
1004 * held before calling this helper function.
1006 struct ust_app
*ust_app_find_by_sock(int sock
)
1008 struct lttng_ht_node_ulong
*node
;
1009 struct lttng_ht_iter iter
;
1011 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
1012 node
= lttng_ht_iter_get_node_ulong(&iter
);
1014 DBG2("UST app find by sock %d not found", sock
);
1018 return caa_container_of(node
, struct ust_app
, sock_n
);
1025 * Find an ust_app using the notify sock and return it. RCU read side lock must
1026 * be held before calling this helper function.
1028 static struct ust_app
*find_app_by_notify_sock(int sock
)
1030 struct lttng_ht_node_ulong
*node
;
1031 struct lttng_ht_iter iter
;
1033 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
1035 node
= lttng_ht_iter_get_node_ulong(&iter
);
1037 DBG2("UST app find by notify sock %d not found", sock
);
1041 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
1048 * Lookup for an ust app event based on event name, filter bytecode and the
1051 * Return an ust_app_event object or NULL on error.
1053 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
1054 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
,
1055 const struct lttng_event_exclusion
*exclusion
)
1057 struct lttng_ht_iter iter
;
1058 struct lttng_ht_node_str
*node
;
1059 struct ust_app_event
*event
= NULL
;
1060 struct ust_app_ht_key key
;
1065 /* Setup key for event lookup. */
1067 key
.filter
= filter
;
1068 key
.loglevel
= loglevel
;
1069 /* lttng_event_exclusion and lttng_ust_event_exclusion structures are similar */
1070 key
.exclusion
= (struct lttng_ust_event_exclusion
*)exclusion
;
1072 /* Lookup using the event name as hash and a custom match fct. */
1073 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
1074 ht_match_ust_app_event
, &key
, &iter
.iter
);
1075 node
= lttng_ht_iter_get_node_str(&iter
);
1080 event
= caa_container_of(node
, struct ust_app_event
, node
);
1087 * Create the channel context on the tracer.
1089 * Called with UST app session lock held.
1092 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
1093 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
1097 health_code_update();
1099 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
1100 ua_chan
->obj
, &ua_ctx
->obj
);
1102 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1103 ERR("UST app create channel context failed for app (pid: %d) "
1104 "with ret %d", app
->pid
, ret
);
1107 * This is normal behavior, an application can die during the
1108 * creation process. Don't report an error so the execution can
1109 * continue normally.
1112 DBG3("UST app disable event failed. Application is dead.");
1117 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1119 DBG2("UST app context handle %d created successfully for channel %s",
1120 ua_ctx
->handle
, ua_chan
->name
);
1123 health_code_update();
1128 * Set the filter on the tracer.
1131 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1132 struct ust_app
*app
)
1136 health_code_update();
1138 if (!ua_event
->filter
) {
1143 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1146 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1147 ERR("UST app event %s filter failed for app (pid: %d) "
1148 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1151 * This is normal behavior, an application can die during the
1152 * creation process. Don't report an error so the execution can
1153 * continue normally.
1156 DBG3("UST app filter event failed. Application is dead.");
1161 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1164 health_code_update();
1169 * Set event exclusions on the tracer.
1172 int set_ust_event_exclusion(struct ust_app_event
*ua_event
,
1173 struct ust_app
*app
)
1177 health_code_update();
1179 if (!ua_event
->exclusion
|| !ua_event
->exclusion
->count
) {
1184 ret
= ustctl_set_exclusion(app
->sock
, ua_event
->exclusion
,
1187 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1188 ERR("UST app event %s exclusions failed for app (pid: %d) "
1189 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1192 * This is normal behavior, an application can die during the
1193 * creation process. Don't report an error so the execution can
1194 * continue normally.
1197 DBG3("UST app event exclusion failed. Application is dead.");
1202 DBG2("UST exclusion set successfully for event %s", ua_event
->name
);
1205 health_code_update();
1210 * Disable the specified event on to UST tracer for the UST session.
1212 static int disable_ust_event(struct ust_app
*app
,
1213 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1217 health_code_update();
1219 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1221 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1222 ERR("UST app event %s disable failed for app (pid: %d) "
1223 "and session handle %d with ret %d",
1224 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1227 * This is normal behavior, an application can die during the
1228 * creation process. Don't report an error so the execution can
1229 * continue normally.
1232 DBG3("UST app disable event failed. Application is dead.");
1237 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1238 ua_event
->attr
.name
, app
->pid
);
1241 health_code_update();
1246 * Disable the specified channel on to UST tracer for the UST session.
1248 static int disable_ust_channel(struct ust_app
*app
,
1249 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1253 health_code_update();
1255 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1257 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1258 ERR("UST app channel %s disable failed for app (pid: %d) "
1259 "and session handle %d with ret %d",
1260 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1263 * This is normal behavior, an application can die during the
1264 * creation process. Don't report an error so the execution can
1265 * continue normally.
1268 DBG3("UST app disable channel failed. Application is dead.");
1273 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1274 ua_chan
->name
, app
->pid
);
1277 health_code_update();
1282 * Enable the specified channel on to UST tracer for the UST session.
1284 static int enable_ust_channel(struct ust_app
*app
,
1285 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1289 health_code_update();
1291 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1293 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1294 ERR("UST app channel %s enable failed for app (pid: %d) "
1295 "and session handle %d with ret %d",
1296 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1299 * This is normal behavior, an application can die during the
1300 * creation process. Don't report an error so the execution can
1301 * continue normally.
1304 DBG3("UST app enable channel failed. Application is dead.");
1309 ua_chan
->enabled
= 1;
1311 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1312 ua_chan
->name
, app
->pid
);
1315 health_code_update();
1320 * Enable the specified event on to UST tracer for the UST session.
1322 static int enable_ust_event(struct ust_app
*app
,
1323 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1327 health_code_update();
1329 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1331 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1332 ERR("UST app event %s enable failed for app (pid: %d) "
1333 "and session handle %d with ret %d",
1334 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1337 * This is normal behavior, an application can die during the
1338 * creation process. Don't report an error so the execution can
1339 * continue normally.
1342 DBG3("UST app enable event failed. Application is dead.");
1347 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1348 ua_event
->attr
.name
, app
->pid
);
1351 health_code_update();
1356 * Send channel and stream buffer to application.
1358 * Return 0 on success. On error, a negative value is returned.
1360 static int send_channel_pid_to_ust(struct ust_app
*app
,
1361 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1364 struct ust_app_stream
*stream
, *stmp
;
1370 health_code_update();
1372 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1375 /* Send channel to the application. */
1376 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1381 health_code_update();
1383 /* Send all streams to application. */
1384 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1385 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1389 /* We don't need the stream anymore once sent to the tracer. */
1390 cds_list_del(&stream
->list
);
1391 delete_ust_app_stream(-1, stream
);
1393 /* Flag the channel that it is sent to the application. */
1394 ua_chan
->is_sent
= 1;
1397 health_code_update();
1402 * Create the specified event onto the UST tracer for a UST session.
1404 * Should be called with session mutex held.
1407 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1408 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1412 health_code_update();
1414 /* Create UST event on tracer */
1415 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1418 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1419 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1420 ua_event
->attr
.name
, app
->pid
, ret
);
1423 * This is normal behavior, an application can die during the
1424 * creation process. Don't report an error so the execution can
1425 * continue normally.
1428 DBG3("UST app create event failed. Application is dead.");
1433 ua_event
->handle
= ua_event
->obj
->handle
;
1435 DBG2("UST app event %s created successfully for pid:%d",
1436 ua_event
->attr
.name
, app
->pid
);
1438 health_code_update();
1440 /* Set filter if one is present. */
1441 if (ua_event
->filter
) {
1442 ret
= set_ust_event_filter(ua_event
, app
);
1448 /* Set exclusions for the event */
1449 if (ua_event
->exclusion
) {
1450 ret
= set_ust_event_exclusion(ua_event
, app
);
1456 /* If event not enabled, disable it on the tracer */
1457 if (ua_event
->enabled
== 0) {
1458 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1461 * If we hit an EPERM, something is wrong with our disable call. If
1462 * we get an EEXIST, there is a problem on the tracer side since we
1466 case -LTTNG_UST_ERR_PERM
:
1467 /* Code flow problem */
1469 case -LTTNG_UST_ERR_EXIST
:
1470 /* It's OK for our use case. */
1481 health_code_update();
1486 * Copy data between an UST app event and a LTT event.
1488 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1489 struct ltt_ust_event
*uevent
)
1491 size_t exclusion_alloc_size
;
1493 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1494 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1496 ua_event
->enabled
= uevent
->enabled
;
1498 /* Copy event attributes */
1499 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1501 /* Copy filter bytecode */
1502 if (uevent
->filter
) {
1503 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1504 /* Filter might be NULL here in case of ENONEM. */
1507 /* Copy exclusion data */
1508 if (uevent
->exclusion
) {
1509 exclusion_alloc_size
= sizeof(struct lttng_ust_event_exclusion
) +
1510 LTTNG_UST_SYM_NAME_LEN
* uevent
->exclusion
->count
;
1511 ua_event
->exclusion
= zmalloc(exclusion_alloc_size
);
1512 if (ua_event
->exclusion
== NULL
) {
1515 memcpy(ua_event
->exclusion
, uevent
->exclusion
,
1516 exclusion_alloc_size
);
1522 * Copy data between an UST app channel and a LTT channel.
1524 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1525 struct ltt_ust_channel
*uchan
)
1527 struct lttng_ht_iter iter
;
1528 struct ltt_ust_event
*uevent
;
1529 struct ltt_ust_context
*uctx
;
1530 struct ust_app_event
*ua_event
;
1531 struct ust_app_ctx
*ua_ctx
;
1533 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1535 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1536 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1538 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1539 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1541 /* Copy event attributes since the layout is different. */
1542 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1543 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1544 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1545 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1546 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1547 ua_chan
->attr
.output
= uchan
->attr
.output
;
1549 * Note that the attribute channel type is not set since the channel on the
1550 * tracing registry side does not have this information.
1553 ua_chan
->enabled
= uchan
->enabled
;
1554 ua_chan
->tracing_channel_id
= uchan
->id
;
1556 cds_list_for_each_entry(uctx
, &uchan
->ctx_list
, list
) {
1557 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1558 if (ua_ctx
== NULL
) {
1561 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1562 (unsigned long) ua_ctx
->ctx
.ctx
);
1563 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1564 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1567 /* Copy all events from ltt ust channel to ust app channel */
1568 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1569 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1570 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
1571 if (ua_event
== NULL
) {
1572 DBG2("UST event %s not found on shadow copy channel",
1574 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1575 if (ua_event
== NULL
) {
1578 shadow_copy_event(ua_event
, uevent
);
1579 add_unique_ust_app_event(ua_chan
, ua_event
);
1583 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1587 * Copy data between a UST app session and a regular LTT session.
1589 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1590 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1592 struct lttng_ht_node_str
*ua_chan_node
;
1593 struct lttng_ht_iter iter
;
1594 struct ltt_ust_channel
*uchan
;
1595 struct ust_app_channel
*ua_chan
;
1597 struct tm
*timeinfo
;
1601 /* Get date and time for unique app path */
1603 timeinfo
= localtime(&rawtime
);
1604 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1606 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1608 ua_sess
->tracing_id
= usess
->id
;
1609 ua_sess
->id
= get_next_session_id();
1610 ua_sess
->uid
= app
->uid
;
1611 ua_sess
->gid
= app
->gid
;
1612 ua_sess
->euid
= usess
->uid
;
1613 ua_sess
->egid
= usess
->gid
;
1614 ua_sess
->buffer_type
= usess
->buffer_type
;
1615 ua_sess
->bits_per_long
= app
->bits_per_long
;
1616 /* There is only one consumer object per session possible. */
1617 ua_sess
->consumer
= usess
->consumer
;
1618 ua_sess
->output_traces
= usess
->output_traces
;
1619 ua_sess
->live_timer_interval
= usess
->live_timer_interval
;
1621 switch (ua_sess
->buffer_type
) {
1622 case LTTNG_BUFFER_PER_PID
:
1623 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1624 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1627 case LTTNG_BUFFER_PER_UID
:
1628 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1629 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1636 PERROR("asprintf UST shadow copy session");
1641 /* Iterate over all channels in global domain. */
1642 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1644 struct lttng_ht_iter uiter
;
1646 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1647 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1648 if (ua_chan_node
!= NULL
) {
1649 /* Session exist. Contiuing. */
1653 DBG2("Channel %s not found on shadow session copy, creating it",
1655 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1656 if (ua_chan
== NULL
) {
1657 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1660 shadow_copy_channel(ua_chan
, uchan
);
1662 * The concept of metadata channel does not exist on the tracing
1663 * registry side of the session daemon so this can only be a per CPU
1664 * channel and not metadata.
1666 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1668 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1676 * Lookup sesison wrapper.
1679 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1680 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1682 /* Get right UST app session from app */
1683 lttng_ht_lookup(app
->sessions
, &usess
->id
, iter
);
1687 * Return ust app session from the app session hashtable using the UST session
1690 static struct ust_app_session
*lookup_session_by_app(
1691 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1693 struct lttng_ht_iter iter
;
1694 struct lttng_ht_node_u64
*node
;
1696 __lookup_session_by_app(usess
, app
, &iter
);
1697 node
= lttng_ht_iter_get_node_u64(&iter
);
1702 return caa_container_of(node
, struct ust_app_session
, node
);
1709 * Setup buffer registry per PID for the given session and application. If none
1710 * is found, a new one is created, added to the global registry and
1711 * initialized. If regp is valid, it's set with the newly created object.
1713 * Return 0 on success or else a negative value.
1715 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1716 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1719 struct buffer_reg_pid
*reg_pid
;
1726 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1729 * This is the create channel path meaning that if there is NO
1730 * registry available, we have to create one for this session.
1732 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1736 buffer_reg_pid_add(reg_pid
);
1741 /* Initialize registry. */
1742 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1743 app
->bits_per_long
, app
->uint8_t_alignment
,
1744 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1745 app
->uint64_t_alignment
, app
->long_alignment
,
1746 app
->byte_order
, app
->version
.major
,
1747 app
->version
.minor
);
1752 DBG3("UST app buffer registry per PID created successfully");
1764 * Setup buffer registry per UID for the given session and application. If none
1765 * is found, a new one is created, added to the global registry and
1766 * initialized. If regp is valid, it's set with the newly created object.
1768 * Return 0 on success or else a negative value.
1770 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1771 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1774 struct buffer_reg_uid
*reg_uid
;
1781 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1784 * This is the create channel path meaning that if there is NO
1785 * registry available, we have to create one for this session.
1787 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1788 LTTNG_DOMAIN_UST
, ®_uid
);
1792 buffer_reg_uid_add(reg_uid
);
1797 /* Initialize registry. */
1798 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1799 app
->bits_per_long
, app
->uint8_t_alignment
,
1800 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1801 app
->uint64_t_alignment
, app
->long_alignment
,
1802 app
->byte_order
, app
->version
.major
,
1803 app
->version
.minor
);
1807 /* Add node to teardown list of the session. */
1808 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1810 DBG3("UST app buffer registry per UID created successfully");
1822 * Create a session on the tracer side for the given app.
1824 * On success, ua_sess_ptr is populated with the session pointer or else left
1825 * untouched. If the session was created, is_created is set to 1. On error,
1826 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1829 * Returns 0 on success or else a negative code which is either -ENOMEM or
1830 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1832 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1833 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1836 int ret
, created
= 0;
1837 struct ust_app_session
*ua_sess
;
1841 assert(ua_sess_ptr
);
1843 health_code_update();
1845 ua_sess
= lookup_session_by_app(usess
, app
);
1846 if (ua_sess
== NULL
) {
1847 DBG2("UST app pid: %d session id %" PRIu64
" not found, creating it",
1848 app
->pid
, usess
->id
);
1849 ua_sess
= alloc_ust_app_session(app
);
1850 if (ua_sess
== NULL
) {
1851 /* Only malloc can failed so something is really wrong */
1855 shadow_copy_session(ua_sess
, usess
, app
);
1859 switch (usess
->buffer_type
) {
1860 case LTTNG_BUFFER_PER_PID
:
1861 /* Init local registry. */
1862 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1867 case LTTNG_BUFFER_PER_UID
:
1868 /* Look for a global registry. If none exists, create one. */
1869 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1880 health_code_update();
1882 if (ua_sess
->handle
== -1) {
1883 ret
= ustctl_create_session(app
->sock
);
1885 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1886 ERR("Creating session for app pid %d with ret %d",
1889 DBG("UST app creating session failed. Application is dead");
1891 * This is normal behavior, an application can die during the
1892 * creation process. Don't report an error so the execution can
1893 * continue normally. This will get flagged ENOTCONN and the
1894 * caller will handle it.
1898 delete_ust_app_session(-1, ua_sess
, app
);
1899 if (ret
!= -ENOMEM
) {
1901 * Tracer is probably gone or got an internal error so let's
1902 * behave like it will soon unregister or not usable.
1909 ua_sess
->handle
= ret
;
1911 /* Add ust app session to app's HT */
1912 lttng_ht_node_init_u64(&ua_sess
->node
,
1913 ua_sess
->tracing_id
);
1914 lttng_ht_add_unique_u64(app
->sessions
, &ua_sess
->node
);
1916 DBG2("UST app session created successfully with handle %d", ret
);
1919 *ua_sess_ptr
= ua_sess
;
1921 *is_created
= created
;
1924 /* Everything went well. */
1928 health_code_update();
1933 * Create a context for the channel on the tracer.
1935 * Called with UST app session lock held and a RCU read side lock.
1938 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1939 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1940 struct ust_app
*app
)
1943 struct lttng_ht_iter iter
;
1944 struct lttng_ht_node_ulong
*node
;
1945 struct ust_app_ctx
*ua_ctx
;
1947 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1949 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1950 node
= lttng_ht_iter_get_node_ulong(&iter
);
1956 ua_ctx
= alloc_ust_app_ctx(uctx
);
1957 if (ua_ctx
== NULL
) {
1963 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1964 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1965 cds_list_add_tail(&ua_ctx
->list
, &ua_chan
->ctx_list
);
1967 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1977 * Enable on the tracer side a ust app event for the session and channel.
1979 * Called with UST app session lock held.
1982 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1983 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1987 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1992 ua_event
->enabled
= 1;
1999 * Disable on the tracer side a ust app event for the session and channel.
2001 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
2002 struct ust_app_event
*ua_event
, struct ust_app
*app
)
2006 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
2011 ua_event
->enabled
= 0;
2018 * Lookup ust app channel for session and disable it on the tracer side.
2021 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
2022 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
2026 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2031 ua_chan
->enabled
= 0;
2038 * Lookup ust app channel for session and enable it on the tracer side. This
2039 * MUST be called with a RCU read side lock acquired.
2041 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
2042 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
2045 struct lttng_ht_iter iter
;
2046 struct lttng_ht_node_str
*ua_chan_node
;
2047 struct ust_app_channel
*ua_chan
;
2049 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2050 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2051 if (ua_chan_node
== NULL
) {
2052 DBG2("Unable to find channel %s in ust session id %" PRIu64
,
2053 uchan
->name
, ua_sess
->tracing_id
);
2057 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2059 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
2069 * Ask the consumer to create a channel and get it if successful.
2071 * Return 0 on success or else a negative value.
2073 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
2074 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
2075 int bitness
, struct ust_registry_session
*registry
)
2078 unsigned int nb_fd
= 0;
2079 struct consumer_socket
*socket
;
2087 health_code_update();
2089 /* Get the right consumer socket for the application. */
2090 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
2096 health_code_update();
2098 /* Need one fd for the channel. */
2099 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2101 ERR("Exhausted number of available FD upon create channel");
2106 * Ask consumer to create channel. The consumer will return the number of
2107 * stream we have to expect.
2109 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
2116 * Compute the number of fd needed before receiving them. It must be 2 per
2117 * stream (2 being the default value here).
2119 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
2121 /* Reserve the amount of file descriptor we need. */
2122 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
2124 ERR("Exhausted number of available FD upon create channel");
2125 goto error_fd_get_stream
;
2128 health_code_update();
2131 * Now get the channel from the consumer. This call wil populate the stream
2132 * list of that channel and set the ust objects.
2134 if (usess
->consumer
->enabled
) {
2135 ret
= ust_consumer_get_channel(socket
, ua_chan
);
2145 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
2146 error_fd_get_stream
:
2148 * Initiate a destroy channel on the consumer since we had an error
2149 * handling it on our side. The return value is of no importance since we
2150 * already have a ret value set by the previous error that we need to
2153 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
2155 lttng_fd_put(LTTNG_FD_APPS
, 1);
2157 health_code_update();
2163 * Duplicate the ust data object of the ust app stream and save it in the
2164 * buffer registry stream.
2166 * Return 0 on success or else a negative value.
2168 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
2169 struct ust_app_stream
*stream
)
2176 /* Reserve the amount of file descriptor we need. */
2177 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
2179 ERR("Exhausted number of available FD upon duplicate stream");
2183 /* Duplicate object for stream once the original is in the registry. */
2184 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
2185 reg_stream
->obj
.ust
);
2187 ERR("Duplicate stream obj from %p to %p failed with ret %d",
2188 reg_stream
->obj
.ust
, stream
->obj
, ret
);
2189 lttng_fd_put(LTTNG_FD_APPS
, 2);
2192 stream
->handle
= stream
->obj
->handle
;
2199 * Duplicate the ust data object of the ust app. channel and save it in the
2200 * buffer registry channel.
2202 * Return 0 on success or else a negative value.
2204 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
2205 struct ust_app_channel
*ua_chan
)
2212 /* Need two fds for the channel. */
2213 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2215 ERR("Exhausted number of available FD upon duplicate channel");
2219 /* Duplicate object for stream once the original is in the registry. */
2220 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2222 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2223 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2226 ua_chan
->handle
= ua_chan
->obj
->handle
;
2231 lttng_fd_put(LTTNG_FD_APPS
, 1);
2237 * For a given channel buffer registry, setup all streams of the given ust
2238 * application channel.
2240 * Return 0 on success or else a negative value.
2242 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2243 struct ust_app_channel
*ua_chan
)
2246 struct ust_app_stream
*stream
, *stmp
;
2251 DBG2("UST app setup buffer registry stream");
2253 /* Send all streams to application. */
2254 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2255 struct buffer_reg_stream
*reg_stream
;
2257 ret
= buffer_reg_stream_create(®_stream
);
2263 * Keep original pointer and nullify it in the stream so the delete
2264 * stream call does not release the object.
2266 reg_stream
->obj
.ust
= stream
->obj
;
2268 buffer_reg_stream_add(reg_stream
, reg_chan
);
2270 /* We don't need the streams anymore. */
2271 cds_list_del(&stream
->list
);
2272 delete_ust_app_stream(-1, stream
);
2280 * Create a buffer registry channel for the given session registry and
2281 * application channel object. If regp pointer is valid, it's set with the
2282 * created object. Important, the created object is NOT added to the session
2283 * registry hash table.
2285 * Return 0 on success else a negative value.
2287 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2288 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2291 struct buffer_reg_channel
*reg_chan
= NULL
;
2296 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2298 /* Create buffer registry channel. */
2299 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2304 reg_chan
->consumer_key
= ua_chan
->key
;
2305 reg_chan
->subbuf_size
= ua_chan
->attr
.subbuf_size
;
2307 /* Create and add a channel registry to session. */
2308 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2309 ua_chan
->tracing_channel_id
);
2313 buffer_reg_channel_add(reg_sess
, reg_chan
);
2322 /* Safe because the registry channel object was not added to any HT. */
2323 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2329 * Setup buffer registry channel for the given session registry and application
2330 * channel object. If regp pointer is valid, it's set with the created object.
2332 * Return 0 on success else a negative value.
2334 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2335 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2342 assert(ua_chan
->obj
);
2344 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2346 /* Setup all streams for the registry. */
2347 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2352 reg_chan
->obj
.ust
= ua_chan
->obj
;
2353 ua_chan
->obj
= NULL
;
2358 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2359 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2364 * Send buffer registry channel to the application.
2366 * Return 0 on success else a negative value.
2368 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2369 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2370 struct ust_app_channel
*ua_chan
)
2373 struct buffer_reg_stream
*reg_stream
;
2380 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2382 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2387 /* Send channel to the application. */
2388 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2393 health_code_update();
2395 /* Send all streams to application. */
2396 pthread_mutex_lock(®_chan
->stream_list_lock
);
2397 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2398 struct ust_app_stream stream
;
2400 ret
= duplicate_stream_object(reg_stream
, &stream
);
2402 goto error_stream_unlock
;
2405 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2407 (void) release_ust_app_stream(-1, &stream
);
2408 goto error_stream_unlock
;
2412 * The return value is not important here. This function will output an
2415 (void) release_ust_app_stream(-1, &stream
);
2417 ua_chan
->is_sent
= 1;
2419 error_stream_unlock
:
2420 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2426 * Create and send to the application the created buffers with per UID buffers.
2428 * Return 0 on success else a negative value.
2430 static int create_channel_per_uid(struct ust_app
*app
,
2431 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2432 struct ust_app_channel
*ua_chan
)
2435 struct buffer_reg_uid
*reg_uid
;
2436 struct buffer_reg_channel
*reg_chan
;
2443 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2445 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2447 * The session creation handles the creation of this global registry
2448 * object. If none can be find, there is a code flow problem or a
2453 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2456 /* Create the buffer registry channel object. */
2457 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2464 * Create the buffers on the consumer side. This call populates the
2465 * ust app channel object with all streams and data object.
2467 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2468 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2471 * Let's remove the previously created buffer registry channel so
2472 * it's not visible anymore in the session registry.
2474 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2475 ua_chan
->tracing_channel_id
);
2476 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2477 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2482 * Setup the streams and add it to the session registry.
2484 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2491 /* Send buffers to the application. */
2492 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2502 * Create and send to the application the created buffers with per PID buffers.
2504 * Return 0 on success else a negative value.
2506 static int create_channel_per_pid(struct ust_app
*app
,
2507 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2508 struct ust_app_channel
*ua_chan
)
2511 struct ust_registry_session
*registry
;
2518 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2522 registry
= get_session_registry(ua_sess
);
2525 /* Create and add a new channel registry to session. */
2526 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2531 /* Create and get channel on the consumer side. */
2532 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2533 app
->bits_per_long
, registry
);
2538 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2549 * From an already allocated ust app channel, create the channel buffers if
2550 * need and send it to the application. This MUST be called with a RCU read
2551 * side lock acquired.
2553 * Return 0 on success or else a negative value.
2555 static int do_create_channel(struct ust_app
*app
,
2556 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2557 struct ust_app_channel
*ua_chan
)
2566 /* Handle buffer type before sending the channel to the application. */
2567 switch (usess
->buffer_type
) {
2568 case LTTNG_BUFFER_PER_UID
:
2570 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2576 case LTTNG_BUFFER_PER_PID
:
2578 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2590 /* Initialize ust objd object using the received handle and add it. */
2591 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2592 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2594 /* If channel is not enabled, disable it on the tracer */
2595 if (!ua_chan
->enabled
) {
2596 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2607 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2608 * newly created channel if not NULL.
2610 * Called with UST app session lock and RCU read-side lock held.
2612 * Return 0 on success or else a negative value.
2614 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2615 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2616 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2617 struct ust_app_channel
**ua_chanp
)
2620 struct lttng_ht_iter iter
;
2621 struct lttng_ht_node_str
*ua_chan_node
;
2622 struct ust_app_channel
*ua_chan
;
2624 /* Lookup channel in the ust app session */
2625 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2626 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2627 if (ua_chan_node
!= NULL
) {
2628 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2632 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2633 if (ua_chan
== NULL
) {
2634 /* Only malloc can fail here */
2638 shadow_copy_channel(ua_chan
, uchan
);
2640 /* Set channel type. */
2641 ua_chan
->attr
.type
= type
;
2643 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2648 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2651 /* Only add the channel if successful on the tracer side. */
2652 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2656 *ua_chanp
= ua_chan
;
2659 /* Everything went well. */
2663 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2669 * Create UST app event and create it on the tracer side.
2671 * Called with ust app session mutex held.
2674 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2675 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2676 struct ust_app
*app
)
2679 struct ust_app_event
*ua_event
;
2681 /* Get event node */
2682 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2683 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
2684 if (ua_event
!= NULL
) {
2689 /* Does not exist so create one */
2690 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2691 if (ua_event
== NULL
) {
2692 /* Only malloc can failed so something is really wrong */
2696 shadow_copy_event(ua_event
, uevent
);
2698 /* Create it on the tracer side */
2699 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2701 /* Not found previously means that it does not exist on the tracer */
2702 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2706 add_unique_ust_app_event(ua_chan
, ua_event
);
2708 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2715 /* Valid. Calling here is already in a read side lock */
2716 delete_ust_app_event(-1, ua_event
);
2721 * Create UST metadata and open it on the tracer side.
2723 * Called with UST app session lock held and RCU read side lock.
2725 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2726 struct ust_app
*app
, struct consumer_output
*consumer
)
2729 struct ust_app_channel
*metadata
;
2730 struct consumer_socket
*socket
;
2731 struct ust_registry_session
*registry
;
2737 registry
= get_session_registry(ua_sess
);
2740 /* Metadata already exists for this registry or it was closed previously */
2741 if (registry
->metadata_key
|| registry
->metadata_closed
) {
2746 /* Allocate UST metadata */
2747 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2749 /* malloc() failed */
2754 memcpy(&metadata
->attr
, &ua_sess
->metadata_attr
, sizeof(metadata
->attr
));
2756 /* Need one fd for the channel. */
2757 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2759 ERR("Exhausted number of available FD upon create metadata");
2763 /* Get the right consumer socket for the application. */
2764 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2767 goto error_consumer
;
2771 * Keep metadata key so we can identify it on the consumer side. Assign it
2772 * to the registry *before* we ask the consumer so we avoid the race of the
2773 * consumer requesting the metadata and the ask_channel call on our side
2774 * did not returned yet.
2776 registry
->metadata_key
= metadata
->key
;
2779 * Ask the metadata channel creation to the consumer. The metadata object
2780 * will be created by the consumer and kept their. However, the stream is
2781 * never added or monitored until we do a first push metadata to the
2784 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2787 /* Nullify the metadata key so we don't try to close it later on. */
2788 registry
->metadata_key
= 0;
2789 goto error_consumer
;
2793 * The setup command will make the metadata stream be sent to the relayd,
2794 * if applicable, and the thread managing the metadatas. This is important
2795 * because after this point, if an error occurs, the only way the stream
2796 * can be deleted is to be monitored in the consumer.
2798 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2800 /* Nullify the metadata key so we don't try to close it later on. */
2801 registry
->metadata_key
= 0;
2802 goto error_consumer
;
2805 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2806 metadata
->key
, app
->pid
);
2809 lttng_fd_put(LTTNG_FD_APPS
, 1);
2810 delete_ust_app_channel(-1, metadata
, app
);
2816 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2817 * acquired before calling this function.
2819 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2821 struct ust_app
*app
= NULL
;
2822 struct lttng_ht_node_ulong
*node
;
2823 struct lttng_ht_iter iter
;
2825 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2826 node
= lttng_ht_iter_get_node_ulong(&iter
);
2828 DBG2("UST app no found with pid %d", pid
);
2832 DBG2("Found UST app by pid %d", pid
);
2834 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2841 * Allocate and init an UST app object using the registration information and
2842 * the command socket. This is called when the command socket connects to the
2845 * The object is returned on success or else NULL.
2847 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2849 struct ust_app
*lta
= NULL
;
2854 DBG3("UST app creating application for socket %d", sock
);
2856 if ((msg
->bits_per_long
== 64 &&
2857 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2858 || (msg
->bits_per_long
== 32 &&
2859 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2860 ERR("Registration failed: application \"%s\" (pid: %d) has "
2861 "%d-bit long, but no consumerd for this size is available.\n",
2862 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2866 lta
= zmalloc(sizeof(struct ust_app
));
2872 lta
->ppid
= msg
->ppid
;
2873 lta
->uid
= msg
->uid
;
2874 lta
->gid
= msg
->gid
;
2876 lta
->bits_per_long
= msg
->bits_per_long
;
2877 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2878 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2879 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2880 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2881 lta
->long_alignment
= msg
->long_alignment
;
2882 lta
->byte_order
= msg
->byte_order
;
2884 lta
->v_major
= msg
->major
;
2885 lta
->v_minor
= msg
->minor
;
2886 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2887 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2888 lta
->notify_sock
= -1;
2890 /* Copy name and make sure it's NULL terminated. */
2891 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2892 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2895 * Before this can be called, when receiving the registration information,
2896 * the application compatibility is checked. So, at this point, the
2897 * application can work with this session daemon.
2899 lta
->compatible
= 1;
2901 lta
->pid
= msg
->pid
;
2902 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2904 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2906 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2913 * For a given application object, add it to every hash table.
2915 void ust_app_add(struct ust_app
*app
)
2918 assert(app
->notify_sock
>= 0);
2923 * On a re-registration, we want to kick out the previous registration of
2926 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2929 * The socket _should_ be unique until _we_ call close. So, a add_unique
2930 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2931 * already in the table.
2933 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2935 /* Add application to the notify socket hash table. */
2936 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2937 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2939 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2940 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2941 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2948 * Set the application version into the object.
2950 * Return 0 on success else a negative value either an errno code or a
2951 * LTTng-UST error code.
2953 int ust_app_version(struct ust_app
*app
)
2959 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2961 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2962 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2964 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2972 * Unregister app by removing it from the global traceable app list and freeing
2975 * The socket is already closed at this point so no close to sock.
2977 void ust_app_unregister(int sock
)
2979 struct ust_app
*lta
;
2980 struct lttng_ht_node_ulong
*node
;
2981 struct lttng_ht_iter iter
;
2982 struct ust_app_session
*ua_sess
;
2987 /* Get the node reference for a call_rcu */
2988 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2989 node
= lttng_ht_iter_get_node_ulong(&iter
);
2992 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2993 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2995 /* Remove application from PID hash table */
2996 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3000 * Remove application from notify hash table. The thread handling the
3001 * notify socket could have deleted the node so ignore on error because
3002 * either way it's valid. The close of that socket is handled by the other
3005 iter
.iter
.node
= <a
->notify_sock_n
.node
;
3006 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3009 * Ignore return value since the node might have been removed before by an
3010 * add replace during app registration because the PID can be reassigned by
3013 iter
.iter
.node
= <a
->pid_n
.node
;
3014 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3016 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
3020 /* Remove sessions so they are not visible during deletion.*/
3021 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
3023 struct ust_registry_session
*registry
;
3025 ret
= lttng_ht_del(lta
->sessions
, &iter
);
3027 /* The session was already removed so scheduled for teardown. */
3032 * Add session to list for teardown. This is safe since at this point we
3033 * are the only one using this list.
3035 pthread_mutex_lock(&ua_sess
->lock
);
3038 * Normally, this is done in the delete session process which is
3039 * executed in the call rcu below. However, upon registration we can't
3040 * afford to wait for the grace period before pushing data or else the
3041 * data pending feature can race between the unregistration and stop
3042 * command where the data pending command is sent *before* the grace
3045 * The close metadata below nullifies the metadata pointer in the
3046 * session so the delete session will NOT push/close a second time.
3048 registry
= get_session_registry(ua_sess
);
3049 if (registry
&& !registry
->metadata_closed
) {
3050 /* Push metadata for application before freeing the application. */
3051 (void) push_metadata(registry
, ua_sess
->consumer
);
3054 * Don't ask to close metadata for global per UID buffers. Close
3055 * metadata only on destroy trace session in this case. Also, the
3056 * previous push metadata could have flag the metadata registry to
3057 * close so don't send a close command if closed.
3059 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
&&
3060 !registry
->metadata_closed
) {
3061 /* And ask to close it for this session registry. */
3062 (void) close_metadata(registry
, ua_sess
->consumer
);
3066 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
3067 pthread_mutex_unlock(&ua_sess
->lock
);
3071 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
3078 * Fill events array with all events name of all registered apps.
3080 int ust_app_list_events(struct lttng_event
**events
)
3083 size_t nbmem
, count
= 0;
3084 struct lttng_ht_iter iter
;
3085 struct ust_app
*app
;
3086 struct lttng_event
*tmp_event
;
3088 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3089 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
3090 if (tmp_event
== NULL
) {
3091 PERROR("zmalloc ust app events");
3098 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3099 struct lttng_ust_tracepoint_iter uiter
;
3101 health_code_update();
3103 if (!app
->compatible
) {
3105 * TODO: In time, we should notice the caller of this error by
3106 * telling him that this is a version error.
3110 handle
= ustctl_tracepoint_list(app
->sock
);
3112 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3113 ERR("UST app list events getting handle failed for app pid %d",
3119 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
3120 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3121 /* Handle ustctl error. */
3123 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3124 ERR("UST app tp list get failed for app %d with ret %d",
3127 DBG3("UST app tp list get failed. Application is dead");
3129 * This is normal behavior, an application can die during the
3130 * creation process. Don't report an error so the execution can
3131 * continue normally. Continue normal execution.
3139 health_code_update();
3140 if (count
>= nbmem
) {
3141 /* In case the realloc fails, we free the memory */
3142 struct lttng_event
*new_tmp_event
;
3145 new_nbmem
= nbmem
<< 1;
3146 DBG2("Reallocating event list from %zu to %zu entries",
3148 new_tmp_event
= realloc(tmp_event
,
3149 new_nbmem
* sizeof(struct lttng_event
));
3150 if (new_tmp_event
== NULL
) {
3151 PERROR("realloc ust app events");
3156 /* Zero the new memory */
3157 memset(new_tmp_event
+ nbmem
, 0,
3158 (new_nbmem
- nbmem
) * sizeof(struct lttng_event
));
3160 tmp_event
= new_tmp_event
;
3162 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
3163 tmp_event
[count
].loglevel
= uiter
.loglevel
;
3164 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
3165 tmp_event
[count
].pid
= app
->pid
;
3166 tmp_event
[count
].enabled
= -1;
3172 *events
= tmp_event
;
3174 DBG2("UST app list events done (%zu events)", count
);
3179 health_code_update();
3184 * Fill events array with all events name of all registered apps.
3186 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
3189 size_t nbmem
, count
= 0;
3190 struct lttng_ht_iter iter
;
3191 struct ust_app
*app
;
3192 struct lttng_event_field
*tmp_event
;
3194 nbmem
= UST_APP_EVENT_LIST_SIZE
;
3195 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3196 if (tmp_event
== NULL
) {
3197 PERROR("zmalloc ust app event fields");
3204 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3205 struct lttng_ust_field_iter uiter
;
3207 health_code_update();
3209 if (!app
->compatible
) {
3211 * TODO: In time, we should notice the caller of this error by
3212 * telling him that this is a version error.
3216 handle
= ustctl_tracepoint_field_list(app
->sock
);
3218 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3219 ERR("UST app list field getting handle failed for app pid %d",
3225 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3226 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3227 /* Handle ustctl error. */
3229 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
3230 ERR("UST app tp list field failed for app %d with ret %d",
3233 DBG3("UST app tp list field failed. Application is dead");
3235 * This is normal behavior, an application can die during the
3236 * creation process. Don't report an error so the execution can
3237 * continue normally. Reset list and count for next app.
3245 health_code_update();
3246 if (count
>= nbmem
) {
3247 /* In case the realloc fails, we free the memory */
3248 struct lttng_event_field
*new_tmp_event
;
3251 new_nbmem
= nbmem
<< 1;
3252 DBG2("Reallocating event field list from %zu to %zu entries",
3254 new_tmp_event
= realloc(tmp_event
,
3255 new_nbmem
* sizeof(struct lttng_event_field
));
3256 if (new_tmp_event
== NULL
) {
3257 PERROR("realloc ust app event fields");
3262 /* Zero the new memory */
3263 memset(new_tmp_event
+ nbmem
, 0,
3264 (new_nbmem
- nbmem
) * sizeof(struct lttng_event_field
));
3266 tmp_event
= new_tmp_event
;
3269 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3270 /* Mapping between these enums matches 1 to 1. */
3271 tmp_event
[count
].type
= (enum lttng_event_field_type
) uiter
.type
;
3272 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3274 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3275 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3276 tmp_event
[count
].event
.type
= LTTNG_EVENT_TRACEPOINT
;
3277 tmp_event
[count
].event
.pid
= app
->pid
;
3278 tmp_event
[count
].event
.enabled
= -1;
3284 *fields
= tmp_event
;
3286 DBG2("UST app list event fields done (%zu events)", count
);
3291 health_code_update();
3296 * Free and clean all traceable apps of the global list.
3298 * Should _NOT_ be called with RCU read-side lock held.
3300 void ust_app_clean_list(void)
3303 struct ust_app
*app
;
3304 struct lttng_ht_iter iter
;
3306 DBG2("UST app cleaning registered apps hash table");
3310 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3311 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3313 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3316 /* Cleanup socket hash table */
3317 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3319 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3323 /* Cleanup notify socket hash table */
3324 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3325 notify_sock_n
.node
) {
3326 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3331 /* Destroy is done only when the ht is empty */
3332 ht_cleanup_push(ust_app_ht
);
3333 ht_cleanup_push(ust_app_ht_by_sock
);
3334 ht_cleanup_push(ust_app_ht_by_notify_sock
);
3338 * Init UST app hash table.
3340 void ust_app_ht_alloc(void)
3342 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3343 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3344 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3348 * For a specific UST session, disable the channel for all registered apps.
3350 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3351 struct ltt_ust_channel
*uchan
)
3354 struct lttng_ht_iter iter
;
3355 struct lttng_ht_node_str
*ua_chan_node
;
3356 struct ust_app
*app
;
3357 struct ust_app_session
*ua_sess
;
3358 struct ust_app_channel
*ua_chan
;
3360 if (usess
== NULL
|| uchan
== NULL
) {
3361 ERR("Disabling UST global channel with NULL values");
3366 DBG2("UST app disabling channel %s from global domain for session id %" PRIu64
,
3367 uchan
->name
, usess
->id
);
3371 /* For every registered applications */
3372 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3373 struct lttng_ht_iter uiter
;
3374 if (!app
->compatible
) {
3376 * TODO: In time, we should notice the caller of this error by
3377 * telling him that this is a version error.
3381 ua_sess
= lookup_session_by_app(usess
, app
);
3382 if (ua_sess
== NULL
) {
3387 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3388 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3389 /* If the session if found for the app, the channel must be there */
3390 assert(ua_chan_node
);
3392 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3393 /* The channel must not be already disabled */
3394 assert(ua_chan
->enabled
== 1);
3396 /* Disable channel onto application */
3397 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3399 /* XXX: We might want to report this error at some point... */
3411 * For a specific UST session, enable the channel for all registered apps.
3413 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3414 struct ltt_ust_channel
*uchan
)
3417 struct lttng_ht_iter iter
;
3418 struct ust_app
*app
;
3419 struct ust_app_session
*ua_sess
;
3421 if (usess
== NULL
|| uchan
== NULL
) {
3422 ERR("Adding UST global channel to NULL values");
3427 DBG2("UST app enabling channel %s to global domain for session id %" PRIu64
,
3428 uchan
->name
, usess
->id
);
3432 /* For every registered applications */
3433 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3434 if (!app
->compatible
) {
3436 * TODO: In time, we should notice the caller of this error by
3437 * telling him that this is a version error.
3441 ua_sess
= lookup_session_by_app(usess
, app
);
3442 if (ua_sess
== NULL
) {
3446 /* Enable channel onto application */
3447 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3449 /* XXX: We might want to report this error at some point... */
3461 * Disable an event in a channel and for a specific session.
3463 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3464 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3467 struct lttng_ht_iter iter
, uiter
;
3468 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3469 struct ust_app
*app
;
3470 struct ust_app_session
*ua_sess
;
3471 struct ust_app_channel
*ua_chan
;
3472 struct ust_app_event
*ua_event
;
3474 DBG("UST app disabling event %s for all apps in channel "
3475 "%s for session id %" PRIu64
,
3476 uevent
->attr
.name
, uchan
->name
, usess
->id
);
3480 /* For all registered applications */
3481 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3482 if (!app
->compatible
) {
3484 * TODO: In time, we should notice the caller of this error by
3485 * telling him that this is a version error.
3489 ua_sess
= lookup_session_by_app(usess
, app
);
3490 if (ua_sess
== NULL
) {
3495 /* Lookup channel in the ust app session */
3496 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3497 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3498 if (ua_chan_node
== NULL
) {
3499 DBG2("Channel %s not found in session id %" PRIu64
" for app pid %d."
3500 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3503 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3505 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3506 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3507 if (ua_event_node
== NULL
) {
3508 DBG2("Event %s not found in channel %s for app pid %d."
3509 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3512 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3514 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3516 /* XXX: Report error someday... */
3527 * For a specific UST session, create the channel for all registered apps.
3529 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3530 struct ltt_ust_channel
*uchan
)
3532 int ret
= 0, created
;
3533 struct lttng_ht_iter iter
;
3534 struct ust_app
*app
;
3535 struct ust_app_session
*ua_sess
= NULL
;
3537 /* Very wrong code flow */
3541 DBG2("UST app adding channel %s to UST domain for session id %" PRIu64
,
3542 uchan
->name
, usess
->id
);
3546 /* For every registered applications */
3547 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3548 if (!app
->compatible
) {
3550 * TODO: In time, we should notice the caller of this error by
3551 * telling him that this is a version error.
3556 * Create session on the tracer side and add it to app session HT. Note
3557 * that if session exist, it will simply return a pointer to the ust
3560 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3565 * The application's socket is not valid. Either a bad socket
3566 * or a timeout on it. We can't inform the caller that for a
3567 * specific app, the session failed so lets continue here.
3572 goto error_rcu_unlock
;
3577 pthread_mutex_lock(&ua_sess
->lock
);
3578 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3579 sizeof(uchan
->name
))) {
3580 copy_channel_attr_to_ustctl(&ua_sess
->metadata_attr
, &uchan
->attr
);
3583 /* Create channel onto application. We don't need the chan ref. */
3584 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3585 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3587 pthread_mutex_unlock(&ua_sess
->lock
);
3589 if (ret
== -ENOMEM
) {
3590 /* No more memory is a fatal error. Stop right now. */
3591 goto error_rcu_unlock
;
3593 /* Cleanup the created session if it's the case. */
3595 destroy_app_session(app
, ua_sess
);
3606 * Enable event for a specific session and channel on the tracer.
3608 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3609 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3612 struct lttng_ht_iter iter
, uiter
;
3613 struct lttng_ht_node_str
*ua_chan_node
;
3614 struct ust_app
*app
;
3615 struct ust_app_session
*ua_sess
;
3616 struct ust_app_channel
*ua_chan
;
3617 struct ust_app_event
*ua_event
;
3619 DBG("UST app enabling event %s for all apps for session id %" PRIu64
,
3620 uevent
->attr
.name
, usess
->id
);
3623 * NOTE: At this point, this function is called only if the session and
3624 * channel passed are already created for all apps. and enabled on the
3630 /* For all registered applications */
3631 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3632 if (!app
->compatible
) {
3634 * TODO: In time, we should notice the caller of this error by
3635 * telling him that this is a version error.
3639 ua_sess
= lookup_session_by_app(usess
, app
);
3641 /* The application has problem or is probably dead. */
3645 pthread_mutex_lock(&ua_sess
->lock
);
3647 /* Lookup channel in the ust app session */
3648 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3649 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3650 /* If the channel is not found, there is a code flow error */
3651 assert(ua_chan_node
);
3653 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3655 /* Get event node */
3656 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3657 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
3658 if (ua_event
== NULL
) {
3659 DBG3("UST app enable event %s not found for app PID %d."
3660 "Skipping app", uevent
->attr
.name
, app
->pid
);
3664 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3666 pthread_mutex_unlock(&ua_sess
->lock
);
3670 pthread_mutex_unlock(&ua_sess
->lock
);
3679 * For a specific existing UST session and UST channel, creates the event for
3680 * all registered apps.
3682 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3683 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3686 struct lttng_ht_iter iter
, uiter
;
3687 struct lttng_ht_node_str
*ua_chan_node
;
3688 struct ust_app
*app
;
3689 struct ust_app_session
*ua_sess
;
3690 struct ust_app_channel
*ua_chan
;
3692 DBG("UST app creating event %s for all apps for session id %" PRIu64
,
3693 uevent
->attr
.name
, usess
->id
);
3697 /* For all registered applications */
3698 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3699 if (!app
->compatible
) {
3701 * TODO: In time, we should notice the caller of this error by
3702 * telling him that this is a version error.
3706 ua_sess
= lookup_session_by_app(usess
, app
);
3708 /* The application has problem or is probably dead. */
3712 pthread_mutex_lock(&ua_sess
->lock
);
3713 /* Lookup channel in the ust app session */
3714 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3715 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3716 /* If the channel is not found, there is a code flow error */
3717 assert(ua_chan_node
);
3719 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3721 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3722 pthread_mutex_unlock(&ua_sess
->lock
);
3724 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3725 /* Possible value at this point: -ENOMEM. If so, we stop! */
3728 DBG2("UST app event %s already exist on app PID %d",
3729 uevent
->attr
.name
, app
->pid
);
3740 * Start tracing for a specific UST session and app.
3743 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3746 struct ust_app_session
*ua_sess
;
3748 DBG("Starting tracing for ust app pid %d", app
->pid
);
3752 if (!app
->compatible
) {
3756 ua_sess
= lookup_session_by_app(usess
, app
);
3757 if (ua_sess
== NULL
) {
3758 /* The session is in teardown process. Ignore and continue. */
3762 pthread_mutex_lock(&ua_sess
->lock
);
3764 /* Upon restart, we skip the setup, already done */
3765 if (ua_sess
->started
) {
3769 /* Create directories if consumer is LOCAL and has a path defined. */
3770 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3771 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3772 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3773 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3775 if (ret
!= -EEXIST
) {
3776 ERR("Trace directory creation error");
3783 * Create the metadata for the application. This returns gracefully if a
3784 * metadata was already set for the session.
3786 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
);
3791 health_code_update();
3794 /* This start the UST tracing */
3795 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3797 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3798 ERR("Error starting tracing for app pid: %d (ret: %d)",
3801 DBG("UST app start session failed. Application is dead.");
3803 * This is normal behavior, an application can die during the
3804 * creation process. Don't report an error so the execution can
3805 * continue normally.
3807 pthread_mutex_unlock(&ua_sess
->lock
);
3813 /* Indicate that the session has been started once */
3814 ua_sess
->started
= 1;
3816 pthread_mutex_unlock(&ua_sess
->lock
);
3818 health_code_update();
3820 /* Quiescent wait after starting trace */
3821 ret
= ustctl_wait_quiescent(app
->sock
);
3822 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3823 ERR("UST app wait quiescent failed for app pid %d ret %d",
3829 health_code_update();
3833 pthread_mutex_unlock(&ua_sess
->lock
);
3835 health_code_update();
3840 * Stop tracing for a specific UST session and app.
3843 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3846 struct ust_app_session
*ua_sess
;
3847 struct ust_registry_session
*registry
;
3849 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3853 if (!app
->compatible
) {
3854 goto end_no_session
;
3857 ua_sess
= lookup_session_by_app(usess
, app
);
3858 if (ua_sess
== NULL
) {
3859 goto end_no_session
;
3862 pthread_mutex_lock(&ua_sess
->lock
);
3865 * If started = 0, it means that stop trace has been called for a session
3866 * that was never started. It's possible since we can have a fail start
3867 * from either the application manager thread or the command thread. Simply
3868 * indicate that this is a stop error.
3870 if (!ua_sess
->started
) {
3871 goto error_rcu_unlock
;
3874 health_code_update();
3876 /* This inhibits UST tracing */
3877 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3879 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3880 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3883 DBG("UST app stop session failed. Application is dead.");
3885 * This is normal behavior, an application can die during the
3886 * creation process. Don't report an error so the execution can
3887 * continue normally.
3891 goto error_rcu_unlock
;
3894 health_code_update();
3896 /* Quiescent wait after stopping trace */
3897 ret
= ustctl_wait_quiescent(app
->sock
);
3898 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3899 ERR("UST app wait quiescent failed for app pid %d ret %d",
3903 health_code_update();
3905 registry
= get_session_registry(ua_sess
);
3908 if (!registry
->metadata_closed
) {
3909 /* Push metadata for application before freeing the application. */
3910 (void) push_metadata(registry
, ua_sess
->consumer
);
3914 pthread_mutex_unlock(&ua_sess
->lock
);
3917 health_code_update();
3921 pthread_mutex_unlock(&ua_sess
->lock
);
3923 health_code_update();
3928 * Flush buffers for a specific UST session and app.
3931 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3934 struct lttng_ht_iter iter
;
3935 struct ust_app_session
*ua_sess
;
3936 struct ust_app_channel
*ua_chan
;
3938 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3942 if (!app
->compatible
) {
3943 goto end_no_session
;
3946 ua_sess
= lookup_session_by_app(usess
, app
);
3947 if (ua_sess
== NULL
) {
3948 goto end_no_session
;
3951 pthread_mutex_lock(&ua_sess
->lock
);
3953 health_code_update();
3955 /* Flushing buffers */
3956 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3958 health_code_update();
3959 assert(ua_chan
->is_sent
);
3960 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3962 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3963 ERR("UST app PID %d channel %s flush failed with ret %d",
3964 app
->pid
, ua_chan
->name
, ret
);
3966 DBG3("UST app failed to flush %s. Application is dead.",
3969 * This is normal behavior, an application can die during the
3970 * creation process. Don't report an error so the execution can
3971 * continue normally.
3974 /* Continuing flushing all buffers */
3979 health_code_update();
3981 pthread_mutex_unlock(&ua_sess
->lock
);
3984 health_code_update();
3989 * Destroy a specific UST session in apps.
3991 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3994 struct ust_app_session
*ua_sess
;
3995 struct lttng_ht_iter iter
;
3996 struct lttng_ht_node_u64
*node
;
3998 DBG("Destroy tracing for ust app pid %d", app
->pid
);
4002 if (!app
->compatible
) {
4006 __lookup_session_by_app(usess
, app
, &iter
);
4007 node
= lttng_ht_iter_get_node_u64(&iter
);
4009 /* Session is being or is deleted. */
4012 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
4014 health_code_update();
4015 destroy_app_session(app
, ua_sess
);
4017 health_code_update();
4019 /* Quiescent wait after stopping trace */
4020 ret
= ustctl_wait_quiescent(app
->sock
);
4021 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4022 ERR("UST app wait quiescent failed for app pid %d ret %d",
4027 health_code_update();
4032 * Start tracing for the UST session.
4034 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
4037 struct lttng_ht_iter iter
;
4038 struct ust_app
*app
;
4040 DBG("Starting all UST traces");
4044 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4045 ret
= ust_app_start_trace(usess
, app
);
4047 /* Continue to next apps even on error */
4058 * Start tracing for the UST session.
4060 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
4063 struct lttng_ht_iter iter
;
4064 struct ust_app
*app
;
4066 DBG("Stopping all UST traces");
4070 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4071 ret
= ust_app_stop_trace(usess
, app
);
4073 /* Continue to next apps even on error */
4078 /* Flush buffers and push metadata (for UID buffers). */
4079 switch (usess
->buffer_type
) {
4080 case LTTNG_BUFFER_PER_UID
:
4082 struct buffer_reg_uid
*reg
;
4084 /* Flush all per UID buffers associated to that session. */
4085 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4086 struct ust_registry_session
*ust_session_reg
;
4087 struct buffer_reg_channel
*reg_chan
;
4088 struct consumer_socket
*socket
;
4090 /* Get consumer socket to use to push the metadata.*/
4091 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4094 /* Ignore request if no consumer is found for the session. */
4098 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4099 reg_chan
, node
.node
) {
4101 * The following call will print error values so the return
4102 * code is of little importance because whatever happens, we
4103 * have to try them all.
4105 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
4108 ust_session_reg
= reg
->registry
->reg
.ust
;
4109 if (!ust_session_reg
->metadata_closed
) {
4110 /* Push metadata. */
4111 (void) push_metadata(ust_session_reg
, usess
->consumer
);
4117 case LTTNG_BUFFER_PER_PID
:
4118 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4119 ret
= ust_app_flush_trace(usess
, app
);
4121 /* Continue to next apps even on error */
4137 * Destroy app UST session.
4139 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
4142 struct lttng_ht_iter iter
;
4143 struct ust_app
*app
;
4145 DBG("Destroy all UST traces");
4149 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4150 ret
= destroy_trace(usess
, app
);
4152 /* Continue to next apps even on error */
4163 * Add channels/events from UST global domain to registered apps at sock.
4165 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
4168 struct lttng_ht_iter iter
, uiter
;
4169 struct ust_app
*app
;
4170 struct ust_app_session
*ua_sess
= NULL
;
4171 struct ust_app_channel
*ua_chan
;
4172 struct ust_app_event
*ua_event
;
4173 struct ust_app_ctx
*ua_ctx
;
4178 DBG2("UST app global update for app sock %d for session id %" PRIu64
, sock
,
4183 app
= ust_app_find_by_sock(sock
);
4186 * Application can be unregistered before so this is possible hence
4187 * simply stopping the update.
4189 DBG3("UST app update failed to find app sock %d", sock
);
4193 if (!app
->compatible
) {
4197 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4199 /* Tracer is probably gone or ENOMEM. */
4204 pthread_mutex_lock(&ua_sess
->lock
);
4207 * We can iterate safely here over all UST app session since the create ust
4208 * app session above made a shadow copy of the UST global domain from the
4211 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4213 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4216 * Stop everything. On error, the application failed, no more
4217 * file descriptor are available or ENOMEM so stopping here is
4218 * the only thing we can do for now.
4224 * Add context using the list so they are enabled in the same order the
4227 cds_list_for_each_entry(ua_ctx
, &ua_chan
->ctx_list
, list
) {
4228 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4235 /* For each events */
4236 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4238 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4245 pthread_mutex_unlock(&ua_sess
->lock
);
4247 if (usess
->start_trace
) {
4248 ret
= ust_app_start_trace(usess
, app
);
4253 DBG2("UST trace started for app pid %d", app
->pid
);
4256 /* Everything went well at this point. */
4261 pthread_mutex_unlock(&ua_sess
->lock
);
4264 destroy_app_session(app
, ua_sess
);
4271 * Add context to a specific channel for global UST domain.
4273 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4274 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4277 struct lttng_ht_node_str
*ua_chan_node
;
4278 struct lttng_ht_iter iter
, uiter
;
4279 struct ust_app_channel
*ua_chan
= NULL
;
4280 struct ust_app_session
*ua_sess
;
4281 struct ust_app
*app
;
4285 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4286 if (!app
->compatible
) {
4288 * TODO: In time, we should notice the caller of this error by
4289 * telling him that this is a version error.
4293 ua_sess
= lookup_session_by_app(usess
, app
);
4294 if (ua_sess
== NULL
) {
4298 pthread_mutex_lock(&ua_sess
->lock
);
4299 /* Lookup channel in the ust app session */
4300 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4301 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4302 if (ua_chan_node
== NULL
) {
4305 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4307 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4312 pthread_mutex_unlock(&ua_sess
->lock
);
4320 * Enable event for a channel from a UST session for a specific PID.
4322 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4323 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4326 struct lttng_ht_iter iter
;
4327 struct lttng_ht_node_str
*ua_chan_node
;
4328 struct ust_app
*app
;
4329 struct ust_app_session
*ua_sess
;
4330 struct ust_app_channel
*ua_chan
;
4331 struct ust_app_event
*ua_event
;
4333 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4337 app
= ust_app_find_by_pid(pid
);
4339 ERR("UST app enable event per PID %d not found", pid
);
4344 if (!app
->compatible
) {
4349 ua_sess
= lookup_session_by_app(usess
, app
);
4351 /* The application has problem or is probably dead. */
4356 pthread_mutex_lock(&ua_sess
->lock
);
4357 /* Lookup channel in the ust app session */
4358 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4359 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4360 /* If the channel is not found, there is a code flow error */
4361 assert(ua_chan_node
);
4363 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4365 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4366 uevent
->filter
, uevent
->attr
.loglevel
, uevent
->exclusion
);
4367 if (ua_event
== NULL
) {
4368 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4373 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4380 pthread_mutex_unlock(&ua_sess
->lock
);
4387 * Calibrate registered applications.
4389 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4392 struct lttng_ht_iter iter
;
4393 struct ust_app
*app
;
4397 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4398 if (!app
->compatible
) {
4400 * TODO: In time, we should notice the caller of this error by
4401 * telling him that this is a version error.
4406 health_code_update();
4408 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4412 /* Means that it's not implemented on the tracer side. */
4416 DBG2("Calibrate app PID %d returned with error %d",
4423 DBG("UST app global domain calibration finished");
4427 health_code_update();
4433 * Receive registration and populate the given msg structure.
4435 * On success return 0 else a negative value returned by the ustctl call.
4437 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4440 uint32_t pid
, ppid
, uid
, gid
;
4444 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4445 &pid
, &ppid
, &uid
, &gid
,
4446 &msg
->bits_per_long
,
4447 &msg
->uint8_t_alignment
,
4448 &msg
->uint16_t_alignment
,
4449 &msg
->uint32_t_alignment
,
4450 &msg
->uint64_t_alignment
,
4451 &msg
->long_alignment
,
4458 case LTTNG_UST_ERR_EXITING
:
4459 DBG3("UST app recv reg message failed. Application died");
4461 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4462 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4463 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4464 LTTNG_UST_ABI_MINOR_VERSION
);
4467 ERR("UST app recv reg message failed with ret %d", ret
);
4472 msg
->pid
= (pid_t
) pid
;
4473 msg
->ppid
= (pid_t
) ppid
;
4474 msg
->uid
= (uid_t
) uid
;
4475 msg
->gid
= (gid_t
) gid
;
4482 * Return a ust app channel object using the application object and the channel
4483 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4484 * lock MUST be acquired before calling this function.
4486 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4489 struct lttng_ht_node_ulong
*node
;
4490 struct lttng_ht_iter iter
;
4491 struct ust_app_channel
*ua_chan
= NULL
;
4495 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4496 node
= lttng_ht_iter_get_node_ulong(&iter
);
4498 DBG2("UST app channel find by objd %d not found", objd
);
4502 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4509 * Reply to a register channel notification from an application on the notify
4510 * socket. The channel metadata is also created.
4512 * The session UST registry lock is acquired in this function.
4514 * On success 0 is returned else a negative value.
4516 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4517 size_t nr_fields
, struct ustctl_field
*fields
)
4519 int ret
, ret_code
= 0;
4520 uint32_t chan_id
, reg_count
;
4521 uint64_t chan_reg_key
;
4522 enum ustctl_channel_header type
;
4523 struct ust_app
*app
;
4524 struct ust_app_channel
*ua_chan
;
4525 struct ust_app_session
*ua_sess
;
4526 struct ust_registry_session
*registry
;
4527 struct ust_registry_channel
*chan_reg
;
4531 /* Lookup application. If not found, there is a code flow error. */
4532 app
= find_app_by_notify_sock(sock
);
4534 DBG("Application socket %d is being teardown. Abort event notify",
4538 goto error_rcu_unlock
;
4541 /* Lookup channel by UST object descriptor. */
4542 ua_chan
= find_channel_by_objd(app
, cobjd
);
4544 DBG("Application channel is being teardown. Abort event notify");
4547 goto error_rcu_unlock
;
4550 assert(ua_chan
->session
);
4551 ua_sess
= ua_chan
->session
;
4553 /* Get right session registry depending on the session buffer type. */
4554 registry
= get_session_registry(ua_sess
);
4557 /* Depending on the buffer type, a different channel key is used. */
4558 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4559 chan_reg_key
= ua_chan
->tracing_channel_id
;
4561 chan_reg_key
= ua_chan
->key
;
4564 pthread_mutex_lock(®istry
->lock
);
4566 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4569 if (!chan_reg
->register_done
) {
4570 reg_count
= ust_registry_get_event_count(chan_reg
);
4571 if (reg_count
< 31) {
4572 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4574 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4577 chan_reg
->nr_ctx_fields
= nr_fields
;
4578 chan_reg
->ctx_fields
= fields
;
4579 chan_reg
->header_type
= type
;
4581 /* Get current already assigned values. */
4582 type
= chan_reg
->header_type
;
4584 /* Set to NULL so the error path does not do a double free. */
4587 /* Channel id is set during the object creation. */
4588 chan_id
= chan_reg
->chan_id
;
4590 /* Append to metadata */
4591 if (!chan_reg
->metadata_dumped
) {
4592 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4594 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4600 DBG3("UST app replying to register channel key %" PRIu64
4601 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4604 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4606 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4607 ERR("UST app reply channel failed with ret %d", ret
);
4609 DBG3("UST app reply channel failed. Application died");
4614 /* This channel registry registration is completed. */
4615 chan_reg
->register_done
= 1;
4618 pthread_mutex_unlock(®istry
->lock
);
4628 * Add event to the UST channel registry. When the event is added to the
4629 * registry, the metadata is also created. Once done, this replies to the
4630 * application with the appropriate error code.
4632 * The session UST registry lock is acquired in the function.
4634 * On success 0 is returned else a negative value.
4636 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4637 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4638 char *model_emf_uri
)
4641 uint32_t event_id
= 0;
4642 uint64_t chan_reg_key
;
4643 struct ust_app
*app
;
4644 struct ust_app_channel
*ua_chan
;
4645 struct ust_app_session
*ua_sess
;
4646 struct ust_registry_session
*registry
;
4650 /* Lookup application. If not found, there is a code flow error. */
4651 app
= find_app_by_notify_sock(sock
);
4653 DBG("Application socket %d is being teardown. Abort event notify",
4658 free(model_emf_uri
);
4659 goto error_rcu_unlock
;
4662 /* Lookup channel by UST object descriptor. */
4663 ua_chan
= find_channel_by_objd(app
, cobjd
);
4665 DBG("Application channel is being teardown. Abort event notify");
4669 free(model_emf_uri
);
4670 goto error_rcu_unlock
;
4673 assert(ua_chan
->session
);
4674 ua_sess
= ua_chan
->session
;
4676 registry
= get_session_registry(ua_sess
);
4679 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4680 chan_reg_key
= ua_chan
->tracing_channel_id
;
4682 chan_reg_key
= ua_chan
->key
;
4685 pthread_mutex_lock(®istry
->lock
);
4688 * From this point on, this call acquires the ownership of the sig, fields
4689 * and model_emf_uri meaning any free are done inside it if needed. These
4690 * three variables MUST NOT be read/write after this.
4692 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4693 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4694 model_emf_uri
, ua_sess
->buffer_type
, &event_id
,
4698 * The return value is returned to ustctl so in case of an error, the
4699 * application can be notified. In case of an error, it's important not to
4700 * return a negative error or else the application will get closed.
4702 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4704 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4705 ERR("UST app reply event failed with ret %d", ret
);
4707 DBG3("UST app reply event failed. Application died");
4710 * No need to wipe the create event since the application socket will
4711 * get close on error hence cleaning up everything by itself.
4716 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4720 pthread_mutex_unlock(®istry
->lock
);
4727 * Handle application notification through the given notify socket.
4729 * Return 0 on success or else a negative value.
4731 int ust_app_recv_notify(int sock
)
4734 enum ustctl_notify_cmd cmd
;
4736 DBG3("UST app receiving notify from sock %d", sock
);
4738 ret
= ustctl_recv_notify(sock
, &cmd
);
4740 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4741 ERR("UST app recv notify failed with ret %d", ret
);
4743 DBG3("UST app recv notify failed. Application died");
4749 case USTCTL_NOTIFY_CMD_EVENT
:
4751 int sobjd
, cobjd
, loglevel
;
4752 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4754 struct ustctl_field
*fields
;
4756 DBG2("UST app ustctl register event received");
4758 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4759 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4761 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4762 ERR("UST app recv event failed with ret %d", ret
);
4764 DBG3("UST app recv event failed. Application died");
4770 * Add event to the UST registry coming from the notify socket. This
4771 * call will free if needed the sig, fields and model_emf_uri. This
4772 * code path loses the ownsership of these variables and transfer them
4773 * to the this function.
4775 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4776 fields
, loglevel
, model_emf_uri
);
4783 case USTCTL_NOTIFY_CMD_CHANNEL
:
4787 struct ustctl_field
*fields
;
4789 DBG2("UST app ustctl register channel received");
4791 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4794 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4795 ERR("UST app recv channel failed with ret %d", ret
);
4797 DBG3("UST app recv channel failed. Application died");
4803 * The fields ownership are transfered to this function call meaning
4804 * that if needed it will be freed. After this, it's invalid to access
4805 * fields or clean it up.
4807 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4816 /* Should NEVER happen. */
4825 * Once the notify socket hangs up, this is called. First, it tries to find the
4826 * corresponding application. On failure, the call_rcu to close the socket is
4827 * executed. If an application is found, it tries to delete it from the notify
4828 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4830 * Note that an object needs to be allocated here so on ENOMEM failure, the
4831 * call RCU is not done but the rest of the cleanup is.
4833 void ust_app_notify_sock_unregister(int sock
)
4836 struct lttng_ht_iter iter
;
4837 struct ust_app
*app
;
4838 struct ust_app_notify_sock_obj
*obj
;
4844 obj
= zmalloc(sizeof(*obj
));
4847 * An ENOMEM is kind of uncool. If this strikes we continue the
4848 * procedure but the call_rcu will not be called. In this case, we
4849 * accept the fd leak rather than possibly creating an unsynchronized
4850 * state between threads.
4852 * TODO: The notify object should be created once the notify socket is
4853 * registered and stored independantely from the ust app object. The
4854 * tricky part is to synchronize the teardown of the application and
4855 * this notify object. Let's keep that in mind so we can avoid this
4856 * kind of shenanigans with ENOMEM in the teardown path.
4863 DBG("UST app notify socket unregister %d", sock
);
4866 * Lookup application by notify socket. If this fails, this means that the
4867 * hash table delete has already been done by the application
4868 * unregistration process so we can safely close the notify socket in a
4871 app
= find_app_by_notify_sock(sock
);
4876 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4879 * Whatever happens here either we fail or succeed, in both cases we have
4880 * to close the socket after a grace period to continue to the call RCU
4881 * here. If the deletion is successful, the application is not visible
4882 * anymore by other threads and is it fails it means that it was already
4883 * deleted from the hash table so either way we just have to close the
4886 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4892 * Close socket after a grace period to avoid for the socket to be reused
4893 * before the application object is freed creating potential race between
4894 * threads trying to add unique in the global hash table.
4897 call_rcu(&obj
->head
, close_notify_sock_rcu
);
4902 * Destroy a ust app data structure and free its memory.
4904 void ust_app_destroy(struct ust_app
*app
)
4910 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
4914 * Take a snapshot for a given UST session. The snapshot is sent to the given
4917 * Return 0 on success or else a negative value.
4919 int ust_app_snapshot_record(struct ltt_ust_session
*usess
,
4920 struct snapshot_output
*output
, int wait
, unsigned int nb_streams
)
4923 unsigned int snapshot_done
= 0;
4924 struct lttng_ht_iter iter
;
4925 struct ust_app
*app
;
4926 char pathname
[PATH_MAX
];
4927 uint64_t max_stream_size
= 0;
4935 * Compute the maximum size of a single stream if a max size is asked by
4938 if (output
->max_size
> 0 && nb_streams
> 0) {
4939 max_stream_size
= output
->max_size
/ nb_streams
;
4942 switch (usess
->buffer_type
) {
4943 case LTTNG_BUFFER_PER_UID
:
4945 struct buffer_reg_uid
*reg
;
4947 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
4948 struct buffer_reg_channel
*reg_chan
;
4949 struct consumer_socket
*socket
;
4951 /* Get consumer socket to use to push the metadata.*/
4952 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
4959 memset(pathname
, 0, sizeof(pathname
));
4960 ret
= snprintf(pathname
, sizeof(pathname
),
4961 DEFAULT_UST_TRACE_DIR
"/" DEFAULT_UST_TRACE_UID_PATH
,
4962 reg
->uid
, reg
->bits_per_long
);
4964 PERROR("snprintf snapshot path");
4968 /* Add the UST default trace dir to path. */
4969 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
4970 reg_chan
, node
.node
) {
4973 * Make sure the maximum stream size is not lower than the
4974 * subbuffer size or else it's an error since we won't be able to
4975 * snapshot anything.
4977 if (max_stream_size
&&
4978 reg_chan
->subbuf_size
> max_stream_size
) {
4980 DBG3("UST app snapshot record maximum stream size %" PRIu64
4981 " is smaller than subbuffer size of %zu",
4982 max_stream_size
, reg_chan
->subbuf_size
);
4985 ret
= consumer_snapshot_channel(socket
, reg_chan
->consumer_key
, output
, 0,
4986 usess
->uid
, usess
->gid
, pathname
, wait
,
4992 ret
= consumer_snapshot_channel(socket
, reg
->registry
->reg
.ust
->metadata_key
, output
,
4993 1, usess
->uid
, usess
->gid
, pathname
, wait
,
5002 case LTTNG_BUFFER_PER_PID
:
5004 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5005 struct consumer_socket
*socket
;
5006 struct lttng_ht_iter chan_iter
;
5007 struct ust_app_channel
*ua_chan
;
5008 struct ust_app_session
*ua_sess
;
5009 struct ust_registry_session
*registry
;
5011 ua_sess
= lookup_session_by_app(usess
, app
);
5013 /* Session not associated with this app. */
5017 /* Get the right consumer socket for the application. */
5018 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
,
5025 /* Add the UST default trace dir to path. */
5026 memset(pathname
, 0, sizeof(pathname
));
5027 ret
= snprintf(pathname
, sizeof(pathname
), DEFAULT_UST_TRACE_DIR
"/%s",
5030 PERROR("snprintf snapshot path");
5034 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5035 ua_chan
, node
.node
) {
5037 * Make sure the maximum stream size is not lower than the
5038 * subbuffer size or else it's an error since we won't be able to
5039 * snapshot anything.
5041 if (max_stream_size
&&
5042 ua_chan
->attr
.subbuf_size
> max_stream_size
) {
5044 DBG3("UST app snapshot record maximum stream size %" PRIu64
5045 " is smaller than subbuffer size of %" PRIu64
,
5046 max_stream_size
, ua_chan
->attr
.subbuf_size
);
5050 ret
= consumer_snapshot_channel(socket
, ua_chan
->key
, output
, 0,
5051 ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5058 registry
= get_session_registry(ua_sess
);
5060 ret
= consumer_snapshot_channel(socket
, registry
->metadata_key
, output
,
5061 1, ua_sess
->euid
, ua_sess
->egid
, pathname
, wait
,
5075 if (!snapshot_done
) {
5077 * If no snapshot was made and we are not in the error path, this means
5078 * that there are no buffers thus no (prior) application to snapshot
5079 * data from so we have simply NO data.
5090 * Return the number of streams for a UST session.
5092 unsigned int ust_app_get_nb_stream(struct ltt_ust_session
*usess
)
5094 unsigned int ret
= 0;
5095 struct ust_app
*app
;
5096 struct lttng_ht_iter iter
;
5100 switch (usess
->buffer_type
) {
5101 case LTTNG_BUFFER_PER_UID
:
5103 struct buffer_reg_uid
*reg
;
5105 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
5106 struct buffer_reg_channel
*reg_chan
;
5108 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
5109 reg_chan
, node
.node
) {
5110 ret
+= reg_chan
->stream_count
;
5115 case LTTNG_BUFFER_PER_PID
:
5118 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
5119 struct ust_app_channel
*ua_chan
;
5120 struct ust_app_session
*ua_sess
;
5121 struct lttng_ht_iter chan_iter
;
5123 ua_sess
= lookup_session_by_app(usess
, app
);
5125 /* Session not associated with this app. */
5129 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &chan_iter
.iter
,
5130 ua_chan
, node
.node
) {
5131 ret
+= ua_chan
->streams
.count
;