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"
39 #include "ust-consumer.h"
42 /* Next available channel key. */
43 static unsigned long next_channel_key
;
44 static unsigned long next_session_id
;
47 * Return the atomically incremented value of next_channel_key.
49 static inline unsigned long get_next_channel_key(void)
51 return uatomic_add_return(&next_channel_key
, 1);
55 * Return the atomically incremented value of next_session_id.
57 static inline unsigned long get_next_session_id(void)
59 return uatomic_add_return(&next_session_id
, 1);
62 static void copy_channel_attr_to_ustctl(
63 struct ustctl_consumer_channel_attr
*attr
,
64 struct lttng_ust_channel_attr
*uattr
)
66 /* Copy event attributes since the layout is different. */
67 attr
->subbuf_size
= uattr
->subbuf_size
;
68 attr
->num_subbuf
= uattr
->num_subbuf
;
69 attr
->overwrite
= uattr
->overwrite
;
70 attr
->switch_timer_interval
= uattr
->switch_timer_interval
;
71 attr
->read_timer_interval
= uattr
->read_timer_interval
;
72 attr
->output
= uattr
->output
;
76 * Match function for the hash table lookup.
78 * It matches an ust app event based on three attributes which are the event
79 * name, the filter bytecode and the loglevel.
81 static int ht_match_ust_app_event(struct cds_lfht_node
*node
, const void *_key
)
83 struct ust_app_event
*event
;
84 const struct ust_app_ht_key
*key
;
89 event
= caa_container_of(node
, struct ust_app_event
, node
.node
);
92 /* Match the 3 elements of the key: name, filter and loglevel. */
95 if (strncmp(event
->attr
.name
, key
->name
, sizeof(event
->attr
.name
)) != 0) {
100 if (event
->attr
.loglevel
!= key
->loglevel
) {
101 if (event
->attr
.loglevel_type
== LTTNG_UST_LOGLEVEL_ALL
102 && key
->loglevel
== 0 && event
->attr
.loglevel
== -1) {
104 * Match is accepted. This is because on event creation, the
105 * loglevel is set to -1 if the event loglevel type is ALL so 0 and
106 * -1 are accepted for this loglevel type since 0 is the one set by
107 * the API when receiving an enable event.
114 /* One of the filters is NULL, fail. */
115 if ((key
->filter
&& !event
->filter
) || (!key
->filter
&& event
->filter
)) {
119 if (key
->filter
&& event
->filter
) {
120 /* Both filters exists, check length followed by the bytecode. */
121 if (event
->filter
->len
!= key
->filter
->len
||
122 memcmp(event
->filter
->data
, key
->filter
->data
,
123 event
->filter
->len
) != 0) {
136 * Unique add of an ust app event in the given ht. This uses the custom
137 * ht_match_ust_app_event match function and the event name as hash.
139 static void add_unique_ust_app_event(struct ust_app_channel
*ua_chan
,
140 struct ust_app_event
*event
)
142 struct cds_lfht_node
*node_ptr
;
143 struct ust_app_ht_key key
;
147 assert(ua_chan
->events
);
150 ht
= ua_chan
->events
;
151 key
.name
= event
->attr
.name
;
152 key
.filter
= event
->filter
;
153 key
.loglevel
= event
->attr
.loglevel
;
155 node_ptr
= cds_lfht_add_unique(ht
->ht
,
156 ht
->hash_fct(event
->node
.key
, lttng_ht_seed
),
157 ht_match_ust_app_event
, &key
, &event
->node
.node
);
158 assert(node_ptr
== &event
->node
.node
);
162 * Close the notify socket from the given RCU head object. This MUST be called
163 * through a call_rcu().
165 static void close_notify_sock_rcu(struct rcu_head
*head
)
168 struct ust_app_notify_sock_obj
*obj
=
169 caa_container_of(head
, struct ust_app_notify_sock_obj
, head
);
171 /* Must have a valid fd here. */
172 assert(obj
->fd
>= 0);
174 ret
= close(obj
->fd
);
176 ERR("close notify sock %d RCU", obj
->fd
);
178 lttng_fd_put(LTTNG_FD_APPS
, 1);
184 * Return the session registry according to the buffer type of the given
187 * A registry per UID object MUST exists before calling this function or else
188 * it assert() if not found. RCU read side lock must be acquired.
190 static struct ust_registry_session
*get_session_registry(
191 struct ust_app_session
*ua_sess
)
193 struct ust_registry_session
*registry
= NULL
;
197 switch (ua_sess
->buffer_type
) {
198 case LTTNG_BUFFER_PER_PID
:
200 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
204 registry
= reg_pid
->registry
->reg
.ust
;
207 case LTTNG_BUFFER_PER_UID
:
209 struct buffer_reg_uid
*reg_uid
= buffer_reg_uid_find(
210 ua_sess
->tracing_id
, ua_sess
->bits_per_long
, ua_sess
->uid
);
214 registry
= reg_uid
->registry
->reg
.ust
;
226 * Delete ust context safely. RCU read lock must be held before calling
230 void delete_ust_app_ctx(int sock
, struct ust_app_ctx
*ua_ctx
)
237 ret
= ustctl_release_object(sock
, ua_ctx
->obj
);
238 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
239 ERR("UST app sock %d release ctx obj handle %d failed with ret %d",
240 sock
, ua_ctx
->obj
->handle
, ret
);
248 * Delete ust app event safely. RCU read lock must be held before calling
252 void delete_ust_app_event(int sock
, struct ust_app_event
*ua_event
)
258 free(ua_event
->filter
);
260 if (ua_event
->obj
!= NULL
) {
261 ret
= ustctl_release_object(sock
, ua_event
->obj
);
262 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
263 ERR("UST app sock %d release event obj failed with ret %d",
272 * Release ust data object of the given stream.
274 * Return 0 on success or else a negative value.
276 static int release_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
283 ret
= ustctl_release_object(sock
, stream
->obj
);
284 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
285 ERR("UST app sock %d release stream obj failed with ret %d",
288 lttng_fd_put(LTTNG_FD_APPS
, 2);
296 * Delete ust app stream safely. RCU read lock must be held before calling
300 void delete_ust_app_stream(int sock
, struct ust_app_stream
*stream
)
304 (void) release_ust_app_stream(sock
, stream
);
309 * We need to execute ht_destroy outside of RCU read-side critical
310 * section, so we postpone its execution using call_rcu. It is simpler
311 * than to change the semantic of the many callers of
312 * delete_ust_app_channel().
315 void delete_ust_app_channel_rcu(struct rcu_head
*head
)
317 struct ust_app_channel
*ua_chan
=
318 caa_container_of(head
, struct ust_app_channel
, rcu_head
);
320 lttng_ht_destroy(ua_chan
->ctx
);
321 lttng_ht_destroy(ua_chan
->events
);
326 * Delete ust app channel safely. RCU read lock must be held before calling
330 void delete_ust_app_channel(int sock
, struct ust_app_channel
*ua_chan
,
334 struct lttng_ht_iter iter
;
335 struct ust_app_event
*ua_event
;
336 struct ust_app_ctx
*ua_ctx
;
337 struct ust_app_stream
*stream
, *stmp
;
338 struct ust_registry_session
*registry
;
342 DBG3("UST app deleting channel %s", ua_chan
->name
);
345 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
346 cds_list_del(&stream
->list
);
347 delete_ust_app_stream(sock
, stream
);
351 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter
.iter
, ua_ctx
, node
.node
) {
352 ret
= lttng_ht_del(ua_chan
->ctx
, &iter
);
354 delete_ust_app_ctx(sock
, ua_ctx
);
358 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &iter
.iter
, ua_event
,
360 ret
= lttng_ht_del(ua_chan
->events
, &iter
);
362 delete_ust_app_event(sock
, ua_event
);
365 /* Wipe and free registry from session registry. */
366 registry
= get_session_registry(ua_chan
->session
);
368 ust_registry_channel_del_free(registry
, ua_chan
->key
);
371 if (ua_chan
->obj
!= NULL
) {
372 /* Remove channel from application UST object descriptor. */
373 iter
.iter
.node
= &ua_chan
->ust_objd_node
.node
;
374 lttng_ht_del(app
->ust_objd
, &iter
);
375 ret
= ustctl_release_object(sock
, ua_chan
->obj
);
376 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
377 ERR("UST app sock %d release channel obj failed with ret %d",
380 lttng_fd_put(LTTNG_FD_APPS
, 1);
383 call_rcu(&ua_chan
->rcu_head
, delete_ust_app_channel_rcu
);
387 * Push metadata to consumer socket. The socket lock MUST be acquired.
389 * On success, return the len of metadata pushed or else a negative value.
391 ssize_t
ust_app_push_metadata(struct ust_registry_session
*registry
,
392 struct consumer_socket
*socket
, int send_zero_data
)
395 char *metadata_str
= NULL
;
401 /* Should never be 0 which is the initial state. */
402 assert(registry
->metadata_key
);
404 pthread_mutex_lock(®istry
->lock
);
406 offset
= registry
->metadata_len_sent
;
407 len
= registry
->metadata_len
- registry
->metadata_len_sent
;
409 DBG3("No metadata to push for metadata key %" PRIu64
,
410 registry
->metadata_key
);
412 if (send_zero_data
) {
413 DBG("No metadata to push");
419 /* Allocate only what we have to send. */
420 metadata_str
= zmalloc(len
);
422 PERROR("zmalloc ust app metadata string");
426 /* Copy what we haven't send out. */
427 memcpy(metadata_str
, registry
->metadata
+ offset
, len
);
428 registry
->metadata_len_sent
+= len
;
431 pthread_mutex_unlock(®istry
->lock
);
432 ret
= consumer_push_metadata(socket
, registry
->metadata_key
,
433 metadata_str
, len
, offset
);
444 pthread_mutex_unlock(®istry
->lock
);
451 * For a given application and session, push metadata to consumer. The session
452 * lock MUST be acquired here before calling this.
453 * Either sock or consumer is required : if sock is NULL, the default
454 * socket to send the metadata is retrieved from consumer, if sock
455 * is not NULL we use it to send the metadata.
457 * Return 0 on success else a negative error.
459 static int push_metadata(struct ust_registry_session
*registry
,
460 struct consumer_output
*consumer
)
464 struct consumer_socket
*socket
;
472 * Means that no metadata was assigned to the session. This can happens if
473 * no start has been done previously.
475 if (!registry
->metadata_key
) {
477 goto error_rcu_unlock
;
480 /* Get consumer socket to use to push the metadata.*/
481 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
485 goto error_rcu_unlock
;
489 * TODO: Currently, we hold the socket lock around sampling of the next
490 * metadata segment to ensure we send metadata over the consumer socket in
491 * the correct order. This makes the registry lock nest inside the socket
494 * Please note that this is a temporary measure: we should move this lock
495 * back into ust_consumer_push_metadata() when the consumer gets the
496 * ability to reorder the metadata it receives.
498 pthread_mutex_lock(socket
->lock
);
499 ret
= ust_app_push_metadata(registry
, socket
, 0);
500 pthread_mutex_unlock(socket
->lock
);
503 goto error_rcu_unlock
;
515 * Send to the consumer a close metadata command for the given session. Once
516 * done, the metadata channel is deleted and the session metadata pointer is
517 * nullified. The session lock MUST be acquired here unless the application is
518 * in the destroy path.
520 * Return 0 on success else a negative value.
522 static int close_metadata(struct ust_registry_session
*registry
,
523 struct consumer_output
*consumer
)
526 struct consumer_socket
*socket
;
533 if (!registry
->metadata_key
|| registry
->metadata_closed
) {
538 /* Get consumer socket to use to push the metadata.*/
539 socket
= consumer_find_socket_by_bitness(registry
->bits_per_long
,
546 ret
= consumer_close_metadata(socket
, registry
->metadata_key
);
551 /* Metadata successfully closed. Flag the registry. */
552 registry
->metadata_closed
= 1;
560 * We need to execute ht_destroy outside of RCU read-side critical
561 * section, so we postpone its execution using call_rcu. It is simpler
562 * than to change the semantic of the many callers of
563 * delete_ust_app_session().
566 void delete_ust_app_session_rcu(struct rcu_head
*head
)
568 struct ust_app_session
*ua_sess
=
569 caa_container_of(head
, struct ust_app_session
, rcu_head
);
571 lttng_ht_destroy(ua_sess
->channels
);
576 * Delete ust app session safely. RCU read lock must be held before calling
580 void delete_ust_app_session(int sock
, struct ust_app_session
*ua_sess
,
584 struct lttng_ht_iter iter
;
585 struct ust_app_channel
*ua_chan
;
586 struct ust_registry_session
*registry
;
590 registry
= get_session_registry(ua_sess
);
592 /* Push metadata for application before freeing the application. */
593 (void) push_metadata(registry
, ua_sess
->consumer
);
596 * Don't ask to close metadata for global per UID buffers. Close
597 * metadata only on destroy trace session in this case.
599 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
600 /* And ask to close it for this session registry. */
601 (void) close_metadata(registry
, ua_sess
->consumer
);
605 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
607 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
609 delete_ust_app_channel(sock
, ua_chan
, app
);
612 /* In case of per PID, the registry is kept in the session. */
613 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_PID
) {
614 struct buffer_reg_pid
*reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
616 buffer_reg_pid_remove(reg_pid
);
617 buffer_reg_pid_destroy(reg_pid
);
621 if (ua_sess
->handle
!= -1) {
622 ret
= ustctl_release_handle(sock
, ua_sess
->handle
);
623 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
624 ERR("UST app sock %d release session handle failed with ret %d",
628 call_rcu(&ua_sess
->rcu_head
, delete_ust_app_session_rcu
);
632 * Delete a traceable application structure from the global list. Never call
633 * this function outside of a call_rcu call.
635 * RCU read side lock should _NOT_ be held when calling this function.
638 void delete_ust_app(struct ust_app
*app
)
641 struct ust_app_session
*ua_sess
, *tmp_ua_sess
;
643 /* Delete ust app sessions info */
648 cds_list_for_each_entry_safe(ua_sess
, tmp_ua_sess
, &app
->teardown_head
,
650 /* Free every object in the session and the session. */
652 delete_ust_app_session(sock
, ua_sess
, app
);
656 lttng_ht_destroy(app
->sessions
);
657 lttng_ht_destroy(app
->ust_objd
);
660 * Wait until we have deleted the application from the sock hash table
661 * before closing this socket, otherwise an application could re-use the
662 * socket ID and race with the teardown, using the same hash table entry.
664 * It's OK to leave the close in call_rcu. We want it to stay unique for
665 * all RCU readers that could run concurrently with unregister app,
666 * therefore we _need_ to only close that socket after a grace period. So
667 * it should stay in this RCU callback.
669 * This close() is a very important step of the synchronization model so
670 * every modification to this function must be carefully reviewed.
676 lttng_fd_put(LTTNG_FD_APPS
, 1);
678 DBG2("UST app pid %d deleted", app
->pid
);
683 * URCU intermediate call to delete an UST app.
686 void delete_ust_app_rcu(struct rcu_head
*head
)
688 struct lttng_ht_node_ulong
*node
=
689 caa_container_of(head
, struct lttng_ht_node_ulong
, head
);
690 struct ust_app
*app
=
691 caa_container_of(node
, struct ust_app
, pid_n
);
693 DBG3("Call RCU deleting app PID %d", app
->pid
);
698 * Delete the session from the application ht and delete the data structure by
699 * freeing every object inside and releasing them.
701 static void destroy_app_session(struct ust_app
*app
,
702 struct ust_app_session
*ua_sess
)
705 struct lttng_ht_iter iter
;
710 iter
.iter
.node
= &ua_sess
->node
.node
;
711 ret
= lttng_ht_del(app
->sessions
, &iter
);
713 /* Already scheduled for teardown. */
717 /* Once deleted, free the data structure. */
718 delete_ust_app_session(app
->sock
, ua_sess
, app
);
725 * Alloc new UST app session.
728 struct ust_app_session
*alloc_ust_app_session(struct ust_app
*app
)
730 struct ust_app_session
*ua_sess
;
732 /* Init most of the default value by allocating and zeroing */
733 ua_sess
= zmalloc(sizeof(struct ust_app_session
));
734 if (ua_sess
== NULL
) {
739 ua_sess
->handle
= -1;
740 ua_sess
->channels
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
741 pthread_mutex_init(&ua_sess
->lock
, NULL
);
750 * Alloc new UST app channel.
753 struct ust_app_channel
*alloc_ust_app_channel(char *name
,
754 struct ust_app_session
*ua_sess
,
755 struct lttng_ust_channel_attr
*attr
)
757 struct ust_app_channel
*ua_chan
;
759 /* Init most of the default value by allocating and zeroing */
760 ua_chan
= zmalloc(sizeof(struct ust_app_channel
));
761 if (ua_chan
== NULL
) {
766 /* Setup channel name */
767 strncpy(ua_chan
->name
, name
, sizeof(ua_chan
->name
));
768 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
770 ua_chan
->enabled
= 1;
771 ua_chan
->handle
= -1;
772 ua_chan
->session
= ua_sess
;
773 ua_chan
->key
= get_next_channel_key();
774 ua_chan
->ctx
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
775 ua_chan
->events
= lttng_ht_new(0, LTTNG_HT_TYPE_STRING
);
776 lttng_ht_node_init_str(&ua_chan
->node
, ua_chan
->name
);
778 CDS_INIT_LIST_HEAD(&ua_chan
->streams
.head
);
780 /* Copy attributes */
782 /* Translate from lttng_ust_channel to ustctl_consumer_channel_attr. */
783 ua_chan
->attr
.subbuf_size
= attr
->subbuf_size
;
784 ua_chan
->attr
.num_subbuf
= attr
->num_subbuf
;
785 ua_chan
->attr
.overwrite
= attr
->overwrite
;
786 ua_chan
->attr
.switch_timer_interval
= attr
->switch_timer_interval
;
787 ua_chan
->attr
.read_timer_interval
= attr
->read_timer_interval
;
788 ua_chan
->attr
.output
= attr
->output
;
790 /* By default, the channel is a per cpu channel. */
791 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
793 DBG3("UST app channel %s allocated", ua_chan
->name
);
802 * Allocate and initialize a UST app stream.
804 * Return newly allocated stream pointer or NULL on error.
806 struct ust_app_stream
*ust_app_alloc_stream(void)
808 struct ust_app_stream
*stream
= NULL
;
810 stream
= zmalloc(sizeof(*stream
));
811 if (stream
== NULL
) {
812 PERROR("zmalloc ust app stream");
816 /* Zero could be a valid value for a handle so flag it to -1. */
824 * Alloc new UST app event.
827 struct ust_app_event
*alloc_ust_app_event(char *name
,
828 struct lttng_ust_event
*attr
)
830 struct ust_app_event
*ua_event
;
832 /* Init most of the default value by allocating and zeroing */
833 ua_event
= zmalloc(sizeof(struct ust_app_event
));
834 if (ua_event
== NULL
) {
839 ua_event
->enabled
= 1;
840 strncpy(ua_event
->name
, name
, sizeof(ua_event
->name
));
841 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
842 lttng_ht_node_init_str(&ua_event
->node
, ua_event
->name
);
844 /* Copy attributes */
846 memcpy(&ua_event
->attr
, attr
, sizeof(ua_event
->attr
));
849 DBG3("UST app event %s allocated", ua_event
->name
);
858 * Alloc new UST app context.
861 struct ust_app_ctx
*alloc_ust_app_ctx(struct lttng_ust_context
*uctx
)
863 struct ust_app_ctx
*ua_ctx
;
865 ua_ctx
= zmalloc(sizeof(struct ust_app_ctx
));
866 if (ua_ctx
== NULL
) {
871 memcpy(&ua_ctx
->ctx
, uctx
, sizeof(ua_ctx
->ctx
));
874 DBG3("UST app context %d allocated", ua_ctx
->ctx
.ctx
);
881 * Allocate a filter and copy the given original filter.
883 * Return allocated filter or NULL on error.
885 static struct lttng_ust_filter_bytecode
*alloc_copy_ust_app_filter(
886 struct lttng_ust_filter_bytecode
*orig_f
)
888 struct lttng_ust_filter_bytecode
*filter
= NULL
;
890 /* Copy filter bytecode */
891 filter
= zmalloc(sizeof(*filter
) + orig_f
->len
);
893 PERROR("zmalloc alloc ust app filter");
897 memcpy(filter
, orig_f
, sizeof(*filter
) + orig_f
->len
);
904 * Find an ust_app using the sock and return it. RCU read side lock must be
905 * held before calling this helper function.
908 struct ust_app
*find_app_by_sock(int sock
)
910 struct lttng_ht_node_ulong
*node
;
911 struct lttng_ht_iter iter
;
913 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
914 node
= lttng_ht_iter_get_node_ulong(&iter
);
916 DBG2("UST app find by sock %d not found", sock
);
920 return caa_container_of(node
, struct ust_app
, sock_n
);
927 * Find an ust_app using the notify sock and return it. RCU read side lock must
928 * be held before calling this helper function.
930 static struct ust_app
*find_app_by_notify_sock(int sock
)
932 struct lttng_ht_node_ulong
*node
;
933 struct lttng_ht_iter iter
;
935 lttng_ht_lookup(ust_app_ht_by_notify_sock
, (void *)((unsigned long) sock
),
937 node
= lttng_ht_iter_get_node_ulong(&iter
);
939 DBG2("UST app find by notify sock %d not found", sock
);
943 return caa_container_of(node
, struct ust_app
, notify_sock_n
);
950 * Lookup for an ust app event based on event name, filter bytecode and the
953 * Return an ust_app_event object or NULL on error.
955 static struct ust_app_event
*find_ust_app_event(struct lttng_ht
*ht
,
956 char *name
, struct lttng_ust_filter_bytecode
*filter
, int loglevel
)
958 struct lttng_ht_iter iter
;
959 struct lttng_ht_node_str
*node
;
960 struct ust_app_event
*event
= NULL
;
961 struct ust_app_ht_key key
;
966 /* Setup key for event lookup. */
969 key
.loglevel
= loglevel
;
971 /* Lookup using the event name as hash and a custom match fct. */
972 cds_lfht_lookup(ht
->ht
, ht
->hash_fct((void *) name
, lttng_ht_seed
),
973 ht_match_ust_app_event
, &key
, &iter
.iter
);
974 node
= lttng_ht_iter_get_node_str(&iter
);
979 event
= caa_container_of(node
, struct ust_app_event
, node
);
986 * Create the channel context on the tracer.
988 * Called with UST app session lock held.
991 int create_ust_channel_context(struct ust_app_channel
*ua_chan
,
992 struct ust_app_ctx
*ua_ctx
, struct ust_app
*app
)
996 health_code_update();
998 ret
= ustctl_add_context(app
->sock
, &ua_ctx
->ctx
,
999 ua_chan
->obj
, &ua_ctx
->obj
);
1001 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1002 ERR("UST app create channel context failed for app (pid: %d) "
1003 "with ret %d", app
->pid
, ret
);
1005 DBG3("UST app disable event failed. Application is dead.");
1010 ua_ctx
->handle
= ua_ctx
->obj
->handle
;
1012 DBG2("UST app context handle %d created successfully for channel %s",
1013 ua_ctx
->handle
, ua_chan
->name
);
1016 health_code_update();
1021 * Set the filter on the tracer.
1024 int set_ust_event_filter(struct ust_app_event
*ua_event
,
1025 struct ust_app
*app
)
1029 health_code_update();
1031 if (!ua_event
->filter
) {
1036 ret
= ustctl_set_filter(app
->sock
, ua_event
->filter
,
1039 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1040 ERR("UST app event %s filter failed for app (pid: %d) "
1041 "with ret %d", ua_event
->attr
.name
, app
->pid
, ret
);
1043 DBG3("UST app filter event failed. Application is dead.");
1048 DBG2("UST filter set successfully for event %s", ua_event
->name
);
1051 health_code_update();
1056 * Disable the specified event on to UST tracer for the UST session.
1058 static int disable_ust_event(struct ust_app
*app
,
1059 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1063 health_code_update();
1065 ret
= ustctl_disable(app
->sock
, ua_event
->obj
);
1067 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1068 ERR("UST app event %s disable failed for app (pid: %d) "
1069 "and session handle %d with ret %d",
1070 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1072 DBG3("UST app disable event failed. Application is dead.");
1077 DBG2("UST app event %s disabled successfully for app (pid: %d)",
1078 ua_event
->attr
.name
, app
->pid
);
1081 health_code_update();
1086 * Disable the specified channel on to UST tracer for the UST session.
1088 static int disable_ust_channel(struct ust_app
*app
,
1089 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1093 health_code_update();
1095 ret
= ustctl_disable(app
->sock
, ua_chan
->obj
);
1097 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1098 ERR("UST app channel %s disable failed for app (pid: %d) "
1099 "and session handle %d with ret %d",
1100 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1102 DBG3("UST app disable channel failed. Application is dead.");
1107 DBG2("UST app channel %s disabled successfully for app (pid: %d)",
1108 ua_chan
->name
, app
->pid
);
1111 health_code_update();
1116 * Enable the specified channel on to UST tracer for the UST session.
1118 static int enable_ust_channel(struct ust_app
*app
,
1119 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1123 health_code_update();
1125 ret
= ustctl_enable(app
->sock
, ua_chan
->obj
);
1127 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1128 ERR("UST app channel %s enable failed for app (pid: %d) "
1129 "and session handle %d with ret %d",
1130 ua_chan
->name
, app
->pid
, ua_sess
->handle
, ret
);
1132 DBG3("UST app enable channel failed. Application is dead.");
1137 ua_chan
->enabled
= 1;
1139 DBG2("UST app channel %s enabled successfully for app (pid: %d)",
1140 ua_chan
->name
, app
->pid
);
1143 health_code_update();
1148 * Enable the specified event on to UST tracer for the UST session.
1150 static int enable_ust_event(struct ust_app
*app
,
1151 struct ust_app_session
*ua_sess
, struct ust_app_event
*ua_event
)
1155 health_code_update();
1157 ret
= ustctl_enable(app
->sock
, ua_event
->obj
);
1159 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1160 ERR("UST app event %s enable failed for app (pid: %d) "
1161 "and session handle %d with ret %d",
1162 ua_event
->attr
.name
, app
->pid
, ua_sess
->handle
, ret
);
1164 DBG3("UST app enable event failed. Application is dead.");
1169 DBG2("UST app event %s enabled successfully for app (pid: %d)",
1170 ua_event
->attr
.name
, app
->pid
);
1173 health_code_update();
1178 * Send channel and stream buffer to application.
1180 * Return 0 on success. On error, a negative value is returned.
1182 static int send_channel_pid_to_ust(struct ust_app
*app
,
1183 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
)
1186 struct ust_app_stream
*stream
, *stmp
;
1192 health_code_update();
1194 DBG("UST app sending channel %s to UST app sock %d", ua_chan
->name
,
1197 /* Send channel to the application. */
1198 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
1203 health_code_update();
1205 /* Send all streams to application. */
1206 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
1207 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, stream
);
1211 /* We don't need the stream anymore once sent to the tracer. */
1212 cds_list_del(&stream
->list
);
1213 delete_ust_app_stream(-1, stream
);
1215 /* Flag the channel that it is sent to the application. */
1216 ua_chan
->is_sent
= 1;
1219 health_code_update();
1224 * Create the specified event onto the UST tracer for a UST session.
1226 * Should be called with session mutex held.
1229 int create_ust_event(struct ust_app
*app
, struct ust_app_session
*ua_sess
,
1230 struct ust_app_channel
*ua_chan
, struct ust_app_event
*ua_event
)
1234 health_code_update();
1236 /* Create UST event on tracer */
1237 ret
= ustctl_create_event(app
->sock
, &ua_event
->attr
, ua_chan
->obj
,
1240 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1241 ERR("Error ustctl create event %s for app pid: %d with ret %d",
1242 ua_event
->attr
.name
, app
->pid
, ret
);
1244 DBG3("UST app create event failed. Application is dead.");
1249 ua_event
->handle
= ua_event
->obj
->handle
;
1251 DBG2("UST app event %s created successfully for pid:%d",
1252 ua_event
->attr
.name
, app
->pid
);
1254 health_code_update();
1256 /* Set filter if one is present. */
1257 if (ua_event
->filter
) {
1258 ret
= set_ust_event_filter(ua_event
, app
);
1264 /* If event not enabled, disable it on the tracer */
1265 if (ua_event
->enabled
== 0) {
1266 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1269 * If we hit an EPERM, something is wrong with our disable call. If
1270 * we get an EEXIST, there is a problem on the tracer side since we
1274 case -LTTNG_UST_ERR_PERM
:
1275 /* Code flow problem */
1277 case -LTTNG_UST_ERR_EXIST
:
1278 /* It's OK for our use case. */
1289 health_code_update();
1294 * Copy data between an UST app event and a LTT event.
1296 static void shadow_copy_event(struct ust_app_event
*ua_event
,
1297 struct ltt_ust_event
*uevent
)
1299 strncpy(ua_event
->name
, uevent
->attr
.name
, sizeof(ua_event
->name
));
1300 ua_event
->name
[sizeof(ua_event
->name
) - 1] = '\0';
1302 ua_event
->enabled
= uevent
->enabled
;
1304 /* Copy event attributes */
1305 memcpy(&ua_event
->attr
, &uevent
->attr
, sizeof(ua_event
->attr
));
1307 /* Copy filter bytecode */
1308 if (uevent
->filter
) {
1309 ua_event
->filter
= alloc_copy_ust_app_filter(uevent
->filter
);
1310 /* Filter might be NULL here in case of ENONEM. */
1315 * Copy data between an UST app channel and a LTT channel.
1317 static void shadow_copy_channel(struct ust_app_channel
*ua_chan
,
1318 struct ltt_ust_channel
*uchan
)
1320 struct lttng_ht_iter iter
;
1321 struct ltt_ust_event
*uevent
;
1322 struct ltt_ust_context
*uctx
;
1323 struct ust_app_event
*ua_event
;
1324 struct ust_app_ctx
*ua_ctx
;
1326 DBG2("UST app shadow copy of channel %s started", ua_chan
->name
);
1328 strncpy(ua_chan
->name
, uchan
->name
, sizeof(ua_chan
->name
));
1329 ua_chan
->name
[sizeof(ua_chan
->name
) - 1] = '\0';
1331 ua_chan
->tracefile_size
= uchan
->tracefile_size
;
1332 ua_chan
->tracefile_count
= uchan
->tracefile_count
;
1334 /* Copy event attributes since the layout is different. */
1335 ua_chan
->attr
.subbuf_size
= uchan
->attr
.subbuf_size
;
1336 ua_chan
->attr
.num_subbuf
= uchan
->attr
.num_subbuf
;
1337 ua_chan
->attr
.overwrite
= uchan
->attr
.overwrite
;
1338 ua_chan
->attr
.switch_timer_interval
= uchan
->attr
.switch_timer_interval
;
1339 ua_chan
->attr
.read_timer_interval
= uchan
->attr
.read_timer_interval
;
1340 ua_chan
->attr
.output
= uchan
->attr
.output
;
1342 * Note that the attribute channel type is not set since the channel on the
1343 * tracing registry side does not have this information.
1346 ua_chan
->enabled
= uchan
->enabled
;
1347 ua_chan
->tracing_channel_id
= uchan
->id
;
1349 cds_lfht_for_each_entry(uchan
->ctx
->ht
, &iter
.iter
, uctx
, node
.node
) {
1350 ua_ctx
= alloc_ust_app_ctx(&uctx
->ctx
);
1351 if (ua_ctx
== NULL
) {
1354 lttng_ht_node_init_ulong(&ua_ctx
->node
,
1355 (unsigned long) ua_ctx
->ctx
.ctx
);
1356 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1359 /* Copy all events from ltt ust channel to ust app channel */
1360 cds_lfht_for_each_entry(uchan
->events
->ht
, &iter
.iter
, uevent
, node
.node
) {
1361 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
1362 uevent
->filter
, uevent
->attr
.loglevel
);
1363 if (ua_event
== NULL
) {
1364 DBG2("UST event %s not found on shadow copy channel",
1366 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
1367 if (ua_event
== NULL
) {
1370 shadow_copy_event(ua_event
, uevent
);
1371 add_unique_ust_app_event(ua_chan
, ua_event
);
1375 DBG3("UST app shadow copy of channel %s done", ua_chan
->name
);
1379 * Copy data between a UST app session and a regular LTT session.
1381 static void shadow_copy_session(struct ust_app_session
*ua_sess
,
1382 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1384 struct lttng_ht_node_str
*ua_chan_node
;
1385 struct lttng_ht_iter iter
;
1386 struct ltt_ust_channel
*uchan
;
1387 struct ust_app_channel
*ua_chan
;
1389 struct tm
*timeinfo
;
1393 /* Get date and time for unique app path */
1395 timeinfo
= localtime(&rawtime
);
1396 strftime(datetime
, sizeof(datetime
), "%Y%m%d-%H%M%S", timeinfo
);
1398 DBG2("Shadow copy of session handle %d", ua_sess
->handle
);
1400 ua_sess
->tracing_id
= usess
->id
;
1401 ua_sess
->id
= get_next_session_id();
1402 ua_sess
->uid
= app
->uid
;
1403 ua_sess
->gid
= app
->gid
;
1404 ua_sess
->euid
= usess
->uid
;
1405 ua_sess
->egid
= usess
->gid
;
1406 ua_sess
->buffer_type
= usess
->buffer_type
;
1407 ua_sess
->bits_per_long
= app
->bits_per_long
;
1408 /* There is only one consumer object per session possible. */
1409 ua_sess
->consumer
= usess
->consumer
;
1411 switch (ua_sess
->buffer_type
) {
1412 case LTTNG_BUFFER_PER_PID
:
1413 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1414 DEFAULT_UST_TRACE_PID_PATH
"/%s-%d-%s", app
->name
, app
->pid
,
1417 case LTTNG_BUFFER_PER_UID
:
1418 ret
= snprintf(ua_sess
->path
, sizeof(ua_sess
->path
),
1419 DEFAULT_UST_TRACE_UID_PATH
, ua_sess
->uid
, app
->bits_per_long
);
1426 PERROR("asprintf UST shadow copy session");
1431 /* Iterate over all channels in global domain. */
1432 cds_lfht_for_each_entry(usess
->domain_global
.channels
->ht
, &iter
.iter
,
1434 struct lttng_ht_iter uiter
;
1436 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
1437 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
1438 if (ua_chan_node
!= NULL
) {
1439 /* Session exist. Contiuing. */
1443 DBG2("Channel %s not found on shadow session copy, creating it",
1445 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
1446 if (ua_chan
== NULL
) {
1447 /* malloc failed FIXME: Might want to do handle ENOMEM .. */
1450 shadow_copy_channel(ua_chan
, uchan
);
1452 * The concept of metadata channel does not exist on the tracing
1453 * registry side of the session daemon so this can only be a per CPU
1454 * channel and not metadata.
1456 ua_chan
->attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1458 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
1466 * Lookup sesison wrapper.
1469 void __lookup_session_by_app(struct ltt_ust_session
*usess
,
1470 struct ust_app
*app
, struct lttng_ht_iter
*iter
)
1472 /* Get right UST app session from app */
1473 lttng_ht_lookup(app
->sessions
, (void *)((unsigned long) usess
->id
), iter
);
1477 * Return ust app session from the app session hashtable using the UST session
1480 static struct ust_app_session
*lookup_session_by_app(
1481 struct ltt_ust_session
*usess
, struct ust_app
*app
)
1483 struct lttng_ht_iter iter
;
1484 struct lttng_ht_node_ulong
*node
;
1486 __lookup_session_by_app(usess
, app
, &iter
);
1487 node
= lttng_ht_iter_get_node_ulong(&iter
);
1492 return caa_container_of(node
, struct ust_app_session
, node
);
1499 * Setup buffer registry per PID for the given session and application. If none
1500 * is found, a new one is created, added to the global registry and
1501 * initialized. If regp is valid, it's set with the newly created object.
1503 * Return 0 on success or else a negative value.
1505 static int setup_buffer_reg_pid(struct ust_app_session
*ua_sess
,
1506 struct ust_app
*app
, struct buffer_reg_pid
**regp
)
1509 struct buffer_reg_pid
*reg_pid
;
1516 reg_pid
= buffer_reg_pid_find(ua_sess
->id
);
1519 * This is the create channel path meaning that if there is NO
1520 * registry available, we have to create one for this session.
1522 ret
= buffer_reg_pid_create(ua_sess
->id
, ®_pid
);
1526 buffer_reg_pid_add(reg_pid
);
1531 /* Initialize registry. */
1532 ret
= ust_registry_session_init(®_pid
->registry
->reg
.ust
, app
,
1533 app
->bits_per_long
, app
->uint8_t_alignment
,
1534 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1535 app
->uint64_t_alignment
, app
->long_alignment
,
1536 app
->byte_order
, app
->version
.major
,
1537 app
->version
.minor
);
1542 DBG3("UST app buffer registry per PID created successfully");
1554 * Setup buffer registry per UID for the given session and application. If none
1555 * is found, a new one is created, added to the global registry and
1556 * initialized. If regp is valid, it's set with the newly created object.
1558 * Return 0 on success or else a negative value.
1560 static int setup_buffer_reg_uid(struct ltt_ust_session
*usess
,
1561 struct ust_app
*app
, struct buffer_reg_uid
**regp
)
1564 struct buffer_reg_uid
*reg_uid
;
1571 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
1574 * This is the create channel path meaning that if there is NO
1575 * registry available, we have to create one for this session.
1577 ret
= buffer_reg_uid_create(usess
->id
, app
->bits_per_long
, app
->uid
,
1578 LTTNG_DOMAIN_UST
, ®_uid
);
1582 buffer_reg_uid_add(reg_uid
);
1587 /* Initialize registry. */
1588 ret
= ust_registry_session_init(®_uid
->registry
->reg
.ust
, NULL
,
1589 app
->bits_per_long
, app
->uint8_t_alignment
,
1590 app
->uint16_t_alignment
, app
->uint32_t_alignment
,
1591 app
->uint64_t_alignment
, app
->long_alignment
,
1592 app
->byte_order
, app
->version
.major
,
1593 app
->version
.minor
);
1597 /* Add node to teardown list of the session. */
1598 cds_list_add(®_uid
->lnode
, &usess
->buffer_reg_uid_list
);
1600 DBG3("UST app buffer registry per UID created successfully");
1612 * Create a session on the tracer side for the given app.
1614 * On success, ua_sess_ptr is populated with the session pointer or else left
1615 * untouched. If the session was created, is_created is set to 1. On error,
1616 * it's left untouched. Note that ua_sess_ptr is mandatory but is_created can
1619 * Returns 0 on success or else a negative code which is either -ENOMEM or
1620 * -ENOTCONN which is the default code if the ustctl_create_session fails.
1622 static int create_ust_app_session(struct ltt_ust_session
*usess
,
1623 struct ust_app
*app
, struct ust_app_session
**ua_sess_ptr
,
1626 int ret
, created
= 0;
1627 struct ust_app_session
*ua_sess
;
1631 assert(ua_sess_ptr
);
1633 health_code_update();
1635 ua_sess
= lookup_session_by_app(usess
, app
);
1636 if (ua_sess
== NULL
) {
1637 DBG2("UST app pid: %d session id %d not found, creating it",
1638 app
->pid
, usess
->id
);
1639 ua_sess
= alloc_ust_app_session(app
);
1640 if (ua_sess
== NULL
) {
1641 /* Only malloc can failed so something is really wrong */
1645 shadow_copy_session(ua_sess
, usess
, app
);
1649 switch (usess
->buffer_type
) {
1650 case LTTNG_BUFFER_PER_PID
:
1651 /* Init local registry. */
1652 ret
= setup_buffer_reg_pid(ua_sess
, app
, NULL
);
1657 case LTTNG_BUFFER_PER_UID
:
1658 /* Look for a global registry. If none exists, create one. */
1659 ret
= setup_buffer_reg_uid(usess
, app
, NULL
);
1670 health_code_update();
1672 if (ua_sess
->handle
== -1) {
1673 ret
= ustctl_create_session(app
->sock
);
1675 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
1676 ERR("Creating session for app pid %d with ret %d",
1679 DBG("UST app creating session failed. Application is dead");
1681 delete_ust_app_session(-1, ua_sess
, app
);
1682 if (ret
!= -ENOMEM
) {
1684 * Tracer is probably gone or got an internal error so let's
1685 * behave like it will soon unregister or not usable.
1692 ua_sess
->handle
= ret
;
1694 /* Add ust app session to app's HT */
1695 lttng_ht_node_init_ulong(&ua_sess
->node
,
1696 (unsigned long) ua_sess
->tracing_id
);
1697 lttng_ht_add_unique_ulong(app
->sessions
, &ua_sess
->node
);
1699 DBG2("UST app session created successfully with handle %d", ret
);
1702 *ua_sess_ptr
= ua_sess
;
1704 *is_created
= created
;
1707 /* Everything went well. */
1711 health_code_update();
1716 * Create a context for the channel on the tracer.
1718 * Called with UST app session lock held and a RCU read side lock.
1721 int create_ust_app_channel_context(struct ust_app_session
*ua_sess
,
1722 struct ust_app_channel
*ua_chan
, struct lttng_ust_context
*uctx
,
1723 struct ust_app
*app
)
1726 struct lttng_ht_iter iter
;
1727 struct lttng_ht_node_ulong
*node
;
1728 struct ust_app_ctx
*ua_ctx
;
1730 DBG2("UST app adding context to channel %s", ua_chan
->name
);
1732 lttng_ht_lookup(ua_chan
->ctx
, (void *)((unsigned long)uctx
->ctx
), &iter
);
1733 node
= lttng_ht_iter_get_node_ulong(&iter
);
1739 ua_ctx
= alloc_ust_app_ctx(uctx
);
1740 if (ua_ctx
== NULL
) {
1746 lttng_ht_node_init_ulong(&ua_ctx
->node
, (unsigned long) ua_ctx
->ctx
.ctx
);
1747 lttng_ht_add_unique_ulong(ua_chan
->ctx
, &ua_ctx
->node
);
1749 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
1759 * Enable on the tracer side a ust app event for the session and channel.
1761 * Called with UST app session lock held.
1764 int enable_ust_app_event(struct ust_app_session
*ua_sess
,
1765 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1769 ret
= enable_ust_event(app
, ua_sess
, ua_event
);
1774 ua_event
->enabled
= 1;
1781 * Disable on the tracer side a ust app event for the session and channel.
1783 static int disable_ust_app_event(struct ust_app_session
*ua_sess
,
1784 struct ust_app_event
*ua_event
, struct ust_app
*app
)
1788 ret
= disable_ust_event(app
, ua_sess
, ua_event
);
1793 ua_event
->enabled
= 0;
1800 * Lookup ust app channel for session and disable it on the tracer side.
1803 int disable_ust_app_channel(struct ust_app_session
*ua_sess
,
1804 struct ust_app_channel
*ua_chan
, struct ust_app
*app
)
1808 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
1813 ua_chan
->enabled
= 0;
1820 * Lookup ust app channel for session and enable it on the tracer side. This
1821 * MUST be called with a RCU read side lock acquired.
1823 static int enable_ust_app_channel(struct ust_app_session
*ua_sess
,
1824 struct ltt_ust_channel
*uchan
, struct ust_app
*app
)
1827 struct lttng_ht_iter iter
;
1828 struct lttng_ht_node_str
*ua_chan_node
;
1829 struct ust_app_channel
*ua_chan
;
1831 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
1832 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
1833 if (ua_chan_node
== NULL
) {
1834 DBG2("Unable to find channel %s in ust session id %u",
1835 uchan
->name
, ua_sess
->tracing_id
);
1839 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
1841 ret
= enable_ust_channel(app
, ua_sess
, ua_chan
);
1851 * Ask the consumer to create a channel and get it if successful.
1853 * Return 0 on success or else a negative value.
1855 static int do_consumer_create_channel(struct ltt_ust_session
*usess
,
1856 struct ust_app_session
*ua_sess
, struct ust_app_channel
*ua_chan
,
1857 int bitness
, struct ust_registry_session
*registry
)
1860 unsigned int nb_fd
= 0;
1861 struct consumer_socket
*socket
;
1869 health_code_update();
1871 /* Get the right consumer socket for the application. */
1872 socket
= consumer_find_socket_by_bitness(bitness
, usess
->consumer
);
1878 health_code_update();
1880 /* Need one fd for the channel. */
1881 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1883 ERR("Exhausted number of available FD upon create channel");
1888 * Ask consumer to create channel. The consumer will return the number of
1889 * stream we have to expect.
1891 ret
= ust_consumer_ask_channel(ua_sess
, ua_chan
, usess
->consumer
, socket
,
1898 * Compute the number of fd needed before receiving them. It must be 2 per
1899 * stream (2 being the default value here).
1901 nb_fd
= DEFAULT_UST_STREAM_FD_NUM
* ua_chan
->expected_stream_count
;
1903 /* Reserve the amount of file descriptor we need. */
1904 ret
= lttng_fd_get(LTTNG_FD_APPS
, nb_fd
);
1906 ERR("Exhausted number of available FD upon create channel");
1907 goto error_fd_get_stream
;
1910 health_code_update();
1913 * Now get the channel from the consumer. This call wil populate the stream
1914 * list of that channel and set the ust objects.
1916 ret
= ust_consumer_get_channel(socket
, ua_chan
);
1925 lttng_fd_put(LTTNG_FD_APPS
, nb_fd
);
1926 error_fd_get_stream
:
1928 * Initiate a destroy channel on the consumer since we had an error
1929 * handling it on our side. The return value is of no importance since we
1930 * already have a ret value set by the previous error that we need to
1933 (void) ust_consumer_destroy_channel(socket
, ua_chan
);
1935 lttng_fd_put(LTTNG_FD_APPS
, 1);
1937 health_code_update();
1943 * Duplicate the ust data object of the ust app stream and save it in the
1944 * buffer registry stream.
1946 * Return 0 on success or else a negative value.
1948 static int duplicate_stream_object(struct buffer_reg_stream
*reg_stream
,
1949 struct ust_app_stream
*stream
)
1956 /* Reserve the amount of file descriptor we need. */
1957 ret
= lttng_fd_get(LTTNG_FD_APPS
, 2);
1959 ERR("Exhausted number of available FD upon duplicate stream");
1963 /* Duplicate object for stream once the original is in the registry. */
1964 ret
= ustctl_duplicate_ust_object_data(&stream
->obj
,
1965 reg_stream
->obj
.ust
);
1967 ERR("Duplicate stream obj from %p to %p failed with ret %d",
1968 reg_stream
->obj
.ust
, stream
->obj
, ret
);
1969 lttng_fd_put(LTTNG_FD_APPS
, 2);
1972 stream
->handle
= stream
->obj
->handle
;
1979 * Duplicate the ust data object of the ust app. channel and save it in the
1980 * buffer registry channel.
1982 * Return 0 on success or else a negative value.
1984 static int duplicate_channel_object(struct buffer_reg_channel
*reg_chan
,
1985 struct ust_app_channel
*ua_chan
)
1992 /* Need two fds for the channel. */
1993 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
1995 ERR("Exhausted number of available FD upon duplicate channel");
1999 /* Duplicate object for stream once the original is in the registry. */
2000 ret
= ustctl_duplicate_ust_object_data(&ua_chan
->obj
, reg_chan
->obj
.ust
);
2002 ERR("Duplicate channel obj from %p to %p failed with ret: %d",
2003 reg_chan
->obj
.ust
, ua_chan
->obj
, ret
);
2006 ua_chan
->handle
= ua_chan
->obj
->handle
;
2011 lttng_fd_put(LTTNG_FD_APPS
, 1);
2017 * For a given channel buffer registry, setup all streams of the given ust
2018 * application channel.
2020 * Return 0 on success or else a negative value.
2022 static int setup_buffer_reg_streams(struct buffer_reg_channel
*reg_chan
,
2023 struct ust_app_channel
*ua_chan
)
2026 struct ust_app_stream
*stream
, *stmp
;
2031 DBG2("UST app setup buffer registry stream");
2033 /* Send all streams to application. */
2034 cds_list_for_each_entry_safe(stream
, stmp
, &ua_chan
->streams
.head
, list
) {
2035 struct buffer_reg_stream
*reg_stream
;
2037 ret
= buffer_reg_stream_create(®_stream
);
2043 * Keep original pointer and nullify it in the stream so the delete
2044 * stream call does not release the object.
2046 reg_stream
->obj
.ust
= stream
->obj
;
2048 buffer_reg_stream_add(reg_stream
, reg_chan
);
2050 /* We don't need the streams anymore. */
2051 cds_list_del(&stream
->list
);
2052 delete_ust_app_stream(-1, stream
);
2060 * Create a buffer registry channel for the given session registry and
2061 * application channel object. If regp pointer is valid, it's set with the
2062 * created object. Important, the created object is NOT added to the session
2063 * registry hash table.
2065 * Return 0 on success else a negative value.
2067 static int create_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2068 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
**regp
)
2071 struct buffer_reg_channel
*reg_chan
= NULL
;
2076 DBG2("UST app creating buffer registry channel for %s", ua_chan
->name
);
2078 /* Create buffer registry channel. */
2079 ret
= buffer_reg_channel_create(ua_chan
->tracing_channel_id
, ®_chan
);
2084 reg_chan
->consumer_key
= ua_chan
->key
;
2086 /* Create and add a channel registry to session. */
2087 ret
= ust_registry_channel_add(reg_sess
->reg
.ust
,
2088 ua_chan
->tracing_channel_id
);
2092 buffer_reg_channel_add(reg_sess
, reg_chan
);
2101 /* Safe because the registry channel object was not added to any HT. */
2102 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2108 * Setup buffer registry channel for the given session registry and application
2109 * channel object. If regp pointer is valid, it's set with the created object.
2111 * Return 0 on success else a negative value.
2113 static int setup_buffer_reg_channel(struct buffer_reg_session
*reg_sess
,
2114 struct ust_app_channel
*ua_chan
, struct buffer_reg_channel
*reg_chan
)
2121 assert(ua_chan
->obj
);
2123 DBG2("UST app setup buffer registry channel for %s", ua_chan
->name
);
2125 /* Setup all streams for the registry. */
2126 ret
= setup_buffer_reg_streams(reg_chan
, ua_chan
);
2131 reg_chan
->obj
.ust
= ua_chan
->obj
;
2132 ua_chan
->obj
= NULL
;
2137 buffer_reg_channel_remove(reg_sess
, reg_chan
);
2138 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2143 * Send buffer registry channel to the application.
2145 * Return 0 on success else a negative value.
2147 static int send_channel_uid_to_ust(struct buffer_reg_channel
*reg_chan
,
2148 struct ust_app
*app
, struct ust_app_session
*ua_sess
,
2149 struct ust_app_channel
*ua_chan
)
2152 struct buffer_reg_stream
*reg_stream
;
2159 DBG("UST app sending buffer registry channel to ust sock %d", app
->sock
);
2161 ret
= duplicate_channel_object(reg_chan
, ua_chan
);
2166 /* Send channel to the application. */
2167 ret
= ust_consumer_send_channel_to_ust(app
, ua_sess
, ua_chan
);
2172 health_code_update();
2174 /* Send all streams to application. */
2175 pthread_mutex_lock(®_chan
->stream_list_lock
);
2176 cds_list_for_each_entry(reg_stream
, ®_chan
->streams
, lnode
) {
2177 struct ust_app_stream stream
;
2179 ret
= duplicate_stream_object(reg_stream
, &stream
);
2181 goto error_stream_unlock
;
2184 ret
= ust_consumer_send_stream_to_ust(app
, ua_chan
, &stream
);
2186 (void) release_ust_app_stream(-1, &stream
);
2187 goto error_stream_unlock
;
2191 * The return value is not important here. This function will output an
2194 (void) release_ust_app_stream(-1, &stream
);
2196 ua_chan
->is_sent
= 1;
2198 error_stream_unlock
:
2199 pthread_mutex_unlock(®_chan
->stream_list_lock
);
2205 * Create and send to the application the created buffers with per UID buffers.
2207 * Return 0 on success else a negative value.
2209 static int create_channel_per_uid(struct ust_app
*app
,
2210 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2211 struct ust_app_channel
*ua_chan
)
2214 struct buffer_reg_uid
*reg_uid
;
2215 struct buffer_reg_channel
*reg_chan
;
2222 DBG("UST app creating channel %s with per UID buffers", ua_chan
->name
);
2224 reg_uid
= buffer_reg_uid_find(usess
->id
, app
->bits_per_long
, app
->uid
);
2226 * The session creation handles the creation of this global registry
2227 * object. If none can be find, there is a code flow problem or a
2232 reg_chan
= buffer_reg_channel_find(ua_chan
->tracing_channel_id
,
2235 /* Create the buffer registry channel object. */
2236 ret
= create_buffer_reg_channel(reg_uid
->registry
, ua_chan
, ®_chan
);
2243 * Create the buffers on the consumer side. This call populates the
2244 * ust app channel object with all streams and data object.
2246 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2247 app
->bits_per_long
, reg_uid
->registry
->reg
.ust
);
2250 * Let's remove the previously created buffer registry channel so
2251 * it's not visible anymore in the session registry.
2253 ust_registry_channel_del_free(reg_uid
->registry
->reg
.ust
,
2254 ua_chan
->tracing_channel_id
);
2255 buffer_reg_channel_remove(reg_uid
->registry
, reg_chan
);
2256 buffer_reg_channel_destroy(reg_chan
, LTTNG_DOMAIN_UST
);
2261 * Setup the streams and add it to the session registry.
2263 ret
= setup_buffer_reg_channel(reg_uid
->registry
, ua_chan
, reg_chan
);
2270 /* Send buffers to the application. */
2271 ret
= send_channel_uid_to_ust(reg_chan
, app
, ua_sess
, ua_chan
);
2281 * Create and send to the application the created buffers with per PID buffers.
2283 * Return 0 on success else a negative value.
2285 static int create_channel_per_pid(struct ust_app
*app
,
2286 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2287 struct ust_app_channel
*ua_chan
)
2290 struct ust_registry_session
*registry
;
2297 DBG("UST app creating channel %s with per PID buffers", ua_chan
->name
);
2301 registry
= get_session_registry(ua_sess
);
2304 /* Create and add a new channel registry to session. */
2305 ret
= ust_registry_channel_add(registry
, ua_chan
->key
);
2310 /* Create and get channel on the consumer side. */
2311 ret
= do_consumer_create_channel(usess
, ua_sess
, ua_chan
,
2312 app
->bits_per_long
, registry
);
2317 ret
= send_channel_pid_to_ust(app
, ua_sess
, ua_chan
);
2328 * From an already allocated ust app channel, create the channel buffers if
2329 * need and send it to the application. This MUST be called with a RCU read
2330 * side lock acquired.
2332 * Return 0 on success or else a negative value.
2334 static int do_create_channel(struct ust_app
*app
,
2335 struct ltt_ust_session
*usess
, struct ust_app_session
*ua_sess
,
2336 struct ust_app_channel
*ua_chan
)
2345 /* Handle buffer type before sending the channel to the application. */
2346 switch (usess
->buffer_type
) {
2347 case LTTNG_BUFFER_PER_UID
:
2349 ret
= create_channel_per_uid(app
, usess
, ua_sess
, ua_chan
);
2355 case LTTNG_BUFFER_PER_PID
:
2357 ret
= create_channel_per_pid(app
, usess
, ua_sess
, ua_chan
);
2369 /* Initialize ust objd object using the received handle and add it. */
2370 lttng_ht_node_init_ulong(&ua_chan
->ust_objd_node
, ua_chan
->handle
);
2371 lttng_ht_add_unique_ulong(app
->ust_objd
, &ua_chan
->ust_objd_node
);
2373 /* If channel is not enabled, disable it on the tracer */
2374 if (!ua_chan
->enabled
) {
2375 ret
= disable_ust_channel(app
, ua_sess
, ua_chan
);
2386 * Create UST app channel and create it on the tracer. Set ua_chanp of the
2387 * newly created channel if not NULL.
2389 * Called with UST app session lock and RCU read-side lock held.
2391 * Return 0 on success or else a negative value.
2393 static int create_ust_app_channel(struct ust_app_session
*ua_sess
,
2394 struct ltt_ust_channel
*uchan
, struct ust_app
*app
,
2395 enum lttng_ust_chan_type type
, struct ltt_ust_session
*usess
,
2396 struct ust_app_channel
**ua_chanp
)
2399 struct lttng_ht_iter iter
;
2400 struct lttng_ht_node_str
*ua_chan_node
;
2401 struct ust_app_channel
*ua_chan
;
2403 /* Lookup channel in the ust app session */
2404 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
2405 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
2406 if (ua_chan_node
!= NULL
) {
2407 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
2411 ua_chan
= alloc_ust_app_channel(uchan
->name
, ua_sess
, &uchan
->attr
);
2412 if (ua_chan
== NULL
) {
2413 /* Only malloc can fail here */
2417 shadow_copy_channel(ua_chan
, uchan
);
2419 /* Set channel type. */
2420 ua_chan
->attr
.type
= type
;
2422 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
2427 DBG2("UST app create channel %s for PID %d completed", ua_chan
->name
,
2430 /* Only add the channel if successful on the tracer side. */
2431 lttng_ht_add_unique_str(ua_sess
->channels
, &ua_chan
->node
);
2435 *ua_chanp
= ua_chan
;
2438 /* Everything went well. */
2442 delete_ust_app_channel(ua_chan
->is_sent
? app
->sock
: -1, ua_chan
, app
);
2448 * Create UST app event and create it on the tracer side.
2450 * Called with ust app session mutex held.
2453 int create_ust_app_event(struct ust_app_session
*ua_sess
,
2454 struct ust_app_channel
*ua_chan
, struct ltt_ust_event
*uevent
,
2455 struct ust_app
*app
)
2458 struct ust_app_event
*ua_event
;
2460 /* Get event node */
2461 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
2462 uevent
->filter
, uevent
->attr
.loglevel
);
2463 if (ua_event
!= NULL
) {
2468 /* Does not exist so create one */
2469 ua_event
= alloc_ust_app_event(uevent
->attr
.name
, &uevent
->attr
);
2470 if (ua_event
== NULL
) {
2471 /* Only malloc can failed so something is really wrong */
2475 shadow_copy_event(ua_event
, uevent
);
2477 /* Create it on the tracer side */
2478 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
2480 /* Not found previously means that it does not exist on the tracer */
2481 assert(ret
!= -LTTNG_UST_ERR_EXIST
);
2485 add_unique_ust_app_event(ua_chan
, ua_event
);
2487 DBG2("UST app create event %s for PID %d completed", ua_event
->name
,
2494 /* Valid. Calling here is already in a read side lock */
2495 delete_ust_app_event(-1, ua_event
);
2500 * Create UST metadata and open it on the tracer side.
2502 * Called with UST app session lock held and RCU read side lock.
2504 static int create_ust_app_metadata(struct ust_app_session
*ua_sess
,
2505 struct ust_app
*app
, struct consumer_output
*consumer
,
2506 struct ustctl_consumer_channel_attr
*attr
)
2509 struct ust_app_channel
*metadata
;
2510 struct consumer_socket
*socket
;
2511 struct ust_registry_session
*registry
;
2517 registry
= get_session_registry(ua_sess
);
2520 /* Metadata already exists for this registry. */
2521 if (registry
->metadata_key
) {
2526 /* Allocate UST metadata */
2527 metadata
= alloc_ust_app_channel(DEFAULT_METADATA_NAME
, ua_sess
, NULL
);
2529 /* malloc() failed */
2535 /* Set default attributes for metadata. */
2536 metadata
->attr
.overwrite
= DEFAULT_CHANNEL_OVERWRITE
;
2537 metadata
->attr
.subbuf_size
= default_get_metadata_subbuf_size();
2538 metadata
->attr
.num_subbuf
= DEFAULT_METADATA_SUBBUF_NUM
;
2539 metadata
->attr
.switch_timer_interval
= DEFAULT_METADATA_SWITCH_TIMER
;
2540 metadata
->attr
.read_timer_interval
= DEFAULT_METADATA_READ_TIMER
;
2541 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2542 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2544 memcpy(&metadata
->attr
, attr
, sizeof(metadata
->attr
));
2545 metadata
->attr
.output
= LTTNG_UST_MMAP
;
2546 metadata
->attr
.type
= LTTNG_UST_CHAN_METADATA
;
2549 /* Need one fd for the channel. */
2550 ret
= lttng_fd_get(LTTNG_FD_APPS
, 1);
2552 ERR("Exhausted number of available FD upon create metadata");
2556 /* Get the right consumer socket for the application. */
2557 socket
= consumer_find_socket_by_bitness(app
->bits_per_long
, consumer
);
2560 goto error_consumer
;
2564 * Keep metadata key so we can identify it on the consumer side. Assign it
2565 * to the registry *before* we ask the consumer so we avoid the race of the
2566 * consumer requesting the metadata and the ask_channel call on our side
2567 * did not returned yet.
2569 registry
->metadata_key
= metadata
->key
;
2572 * Ask the metadata channel creation to the consumer. The metadata object
2573 * will be created by the consumer and kept their. However, the stream is
2574 * never added or monitored until we do a first push metadata to the
2577 ret
= ust_consumer_ask_channel(ua_sess
, metadata
, consumer
, socket
,
2581 * Safe because the metadata obj pointer is not set so the delete below
2582 * will not put a FD back again.
2584 goto error_consumer
;
2588 * The setup command will make the metadata stream be sent to the relayd,
2589 * if applicable, and the thread managing the metadatas. This is important
2590 * because after this point, if an error occurs, the only way the stream
2591 * can be deleted is to be monitored in the consumer.
2593 ret
= consumer_setup_metadata(socket
, metadata
->key
);
2596 * Safe because the metadata obj pointer is not set so the delete below
2597 * will not put a FD back again.
2599 goto error_consumer
;
2602 DBG2("UST metadata with key %" PRIu64
" created for app pid %d",
2603 metadata
->key
, app
->pid
);
2606 lttng_fd_put(LTTNG_FD_APPS
, 1);
2607 delete_ust_app_channel(-1, metadata
, app
);
2613 * Return pointer to traceable apps list.
2615 struct lttng_ht
*ust_app_get_ht(void)
2621 * Return ust app pointer or NULL if not found. RCU read side lock MUST be
2622 * acquired before calling this function.
2624 struct ust_app
*ust_app_find_by_pid(pid_t pid
)
2626 struct ust_app
*app
= NULL
;
2627 struct lttng_ht_node_ulong
*node
;
2628 struct lttng_ht_iter iter
;
2630 lttng_ht_lookup(ust_app_ht
, (void *)((unsigned long) pid
), &iter
);
2631 node
= lttng_ht_iter_get_node_ulong(&iter
);
2633 DBG2("UST app no found with pid %d", pid
);
2637 DBG2("Found UST app by pid %d", pid
);
2639 app
= caa_container_of(node
, struct ust_app
, pid_n
);
2646 * Allocate and init an UST app object using the registration information and
2647 * the command socket. This is called when the command socket connects to the
2650 * The object is returned on success or else NULL.
2652 struct ust_app
*ust_app_create(struct ust_register_msg
*msg
, int sock
)
2654 struct ust_app
*lta
= NULL
;
2659 DBG3("UST app creating application for socket %d", sock
);
2661 if ((msg
->bits_per_long
== 64 &&
2662 (uatomic_read(&ust_consumerd64_fd
) == -EINVAL
))
2663 || (msg
->bits_per_long
== 32 &&
2664 (uatomic_read(&ust_consumerd32_fd
) == -EINVAL
))) {
2665 ERR("Registration failed: application \"%s\" (pid: %d) has "
2666 "%d-bit long, but no consumerd for this size is available.\n",
2667 msg
->name
, msg
->pid
, msg
->bits_per_long
);
2671 lta
= zmalloc(sizeof(struct ust_app
));
2677 lta
->ppid
= msg
->ppid
;
2678 lta
->uid
= msg
->uid
;
2679 lta
->gid
= msg
->gid
;
2681 lta
->bits_per_long
= msg
->bits_per_long
;
2682 lta
->uint8_t_alignment
= msg
->uint8_t_alignment
;
2683 lta
->uint16_t_alignment
= msg
->uint16_t_alignment
;
2684 lta
->uint32_t_alignment
= msg
->uint32_t_alignment
;
2685 lta
->uint64_t_alignment
= msg
->uint64_t_alignment
;
2686 lta
->long_alignment
= msg
->long_alignment
;
2687 lta
->byte_order
= msg
->byte_order
;
2689 lta
->v_major
= msg
->major
;
2690 lta
->v_minor
= msg
->minor
;
2691 lta
->sessions
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2692 lta
->ust_objd
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
2693 lta
->notify_sock
= -1;
2695 /* Copy name and make sure it's NULL terminated. */
2696 strncpy(lta
->name
, msg
->name
, sizeof(lta
->name
));
2697 lta
->name
[UST_APP_PROCNAME_LEN
] = '\0';
2700 * Before this can be called, when receiving the registration information,
2701 * the application compatibility is checked. So, at this point, the
2702 * application can work with this session daemon.
2704 lta
->compatible
= 1;
2706 lta
->pid
= msg
->pid
;
2707 lttng_ht_node_init_ulong(<a
->pid_n
, (unsigned long) lta
->pid
);
2709 lttng_ht_node_init_ulong(<a
->sock_n
, (unsigned long) lta
->sock
);
2711 CDS_INIT_LIST_HEAD(<a
->teardown_head
);
2718 * For a given application object, add it to every hash table.
2720 void ust_app_add(struct ust_app
*app
)
2723 assert(app
->notify_sock
>= 0);
2728 * On a re-registration, we want to kick out the previous registration of
2731 lttng_ht_add_replace_ulong(ust_app_ht
, &app
->pid_n
);
2734 * The socket _should_ be unique until _we_ call close. So, a add_unique
2735 * for the ust_app_ht_by_sock is used which asserts fail if the entry was
2736 * already in the table.
2738 lttng_ht_add_unique_ulong(ust_app_ht_by_sock
, &app
->sock_n
);
2740 /* Add application to the notify socket hash table. */
2741 lttng_ht_node_init_ulong(&app
->notify_sock_n
, app
->notify_sock
);
2742 lttng_ht_add_unique_ulong(ust_app_ht_by_notify_sock
, &app
->notify_sock_n
);
2744 DBG("App registered with pid:%d ppid:%d uid:%d gid:%d sock:%d name:%s "
2745 "notify_sock:%d (version %d.%d)", app
->pid
, app
->ppid
, app
->uid
,
2746 app
->gid
, app
->sock
, app
->name
, app
->notify_sock
, app
->v_major
,
2753 * Set the application version into the object.
2755 * Return 0 on success else a negative value either an errno code or a
2756 * LTTng-UST error code.
2758 int ust_app_version(struct ust_app
*app
)
2764 ret
= ustctl_tracer_version(app
->sock
, &app
->version
);
2766 if (ret
!= -LTTNG_UST_ERR_EXITING
&& ret
!= -EPIPE
) {
2767 ERR("UST app %d verson failed with ret %d", app
->sock
, ret
);
2769 DBG3("UST app %d verion failed. Application is dead", app
->sock
);
2777 * Unregister app by removing it from the global traceable app list and freeing
2780 * The socket is already closed at this point so no close to sock.
2782 void ust_app_unregister(int sock
)
2784 struct ust_app
*lta
;
2785 struct lttng_ht_node_ulong
*node
;
2786 struct lttng_ht_iter iter
;
2787 struct ust_app_session
*ua_sess
;
2792 /* Get the node reference for a call_rcu */
2793 lttng_ht_lookup(ust_app_ht_by_sock
, (void *)((unsigned long) sock
), &iter
);
2794 node
= lttng_ht_iter_get_node_ulong(&iter
);
2797 lta
= caa_container_of(node
, struct ust_app
, sock_n
);
2798 DBG("PID %d unregistering with sock %d", lta
->pid
, sock
);
2800 /* Remove application from PID hash table */
2801 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
2805 * Remove application from notify hash table. The thread handling the
2806 * notify socket could have deleted the node so ignore on error because
2807 * either way it's valid. The close of that socket is handled by the other
2810 iter
.iter
.node
= <a
->notify_sock_n
.node
;
2811 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
2814 * Ignore return value since the node might have been removed before by an
2815 * add replace during app registration because the PID can be reassigned by
2818 iter
.iter
.node
= <a
->pid_n
.node
;
2819 ret
= lttng_ht_del(ust_app_ht
, &iter
);
2821 DBG3("Unregister app by PID %d failed. This can happen on pid reuse",
2825 /* Remove sessions so they are not visible during deletion.*/
2826 cds_lfht_for_each_entry(lta
->sessions
->ht
, &iter
.iter
, ua_sess
,
2828 struct ust_registry_session
*registry
;
2830 ret
= lttng_ht_del(lta
->sessions
, &iter
);
2832 /* The session was already removed so scheduled for teardown. */
2837 * Add session to list for teardown. This is safe since at this point we
2838 * are the only one using this list.
2840 pthread_mutex_lock(&ua_sess
->lock
);
2843 * Normally, this is done in the delete session process which is
2844 * executed in the call rcu below. However, upon registration we can't
2845 * afford to wait for the grace period before pushing data or else the
2846 * data pending feature can race between the unregistration and stop
2847 * command where the data pending command is sent *before* the grace
2850 * The close metadata below nullifies the metadata pointer in the
2851 * session so the delete session will NOT push/close a second time.
2853 registry
= get_session_registry(ua_sess
);
2855 /* Push metadata for application before freeing the application. */
2856 (void) push_metadata(registry
, ua_sess
->consumer
);
2859 * Don't ask to close metadata for global per UID buffers. Close
2860 * metadata only on destroy trace session in this case.
2862 if (ua_sess
->buffer_type
!= LTTNG_BUFFER_PER_UID
) {
2863 /* And ask to close it for this session registry. */
2864 (void) close_metadata(registry
, ua_sess
->consumer
);
2868 cds_list_add(&ua_sess
->teardown_node
, <a
->teardown_head
);
2869 pthread_mutex_unlock(&ua_sess
->lock
);
2873 call_rcu(<a
->pid_n
.head
, delete_ust_app_rcu
);
2880 * Return traceable_app_count
2882 unsigned long ust_app_list_count(void)
2884 unsigned long count
;
2887 count
= lttng_ht_get_count(ust_app_ht
);
2894 * Fill events array with all events name of all registered apps.
2896 int ust_app_list_events(struct lttng_event
**events
)
2899 size_t nbmem
, count
= 0;
2900 struct lttng_ht_iter iter
;
2901 struct ust_app
*app
;
2902 struct lttng_event
*tmp_event
;
2904 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2905 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event
));
2906 if (tmp_event
== NULL
) {
2907 PERROR("zmalloc ust app events");
2914 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
2915 struct lttng_ust_tracepoint_iter uiter
;
2917 health_code_update();
2919 if (!app
->compatible
) {
2921 * TODO: In time, we should notice the caller of this error by
2922 * telling him that this is a version error.
2926 handle
= ustctl_tracepoint_list(app
->sock
);
2928 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
2929 ERR("UST app list events getting handle failed for app pid %d",
2935 while ((ret
= ustctl_tracepoint_list_get(app
->sock
, handle
,
2936 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
2937 /* Handle ustctl error. */
2940 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
2941 ERR("UST app tp list get failed for app %d with ret %d",
2944 DBG3("UST app tp list get failed. Application is dead");
2949 health_code_update();
2950 if (count
>= nbmem
) {
2951 /* In case the realloc fails, we free the memory */
2954 DBG2("Reallocating event list from %zu to %zu entries", nbmem
,
2957 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event
));
2959 PERROR("realloc ust app events");
2966 memcpy(tmp_event
[count
].name
, uiter
.name
, LTTNG_UST_SYM_NAME_LEN
);
2967 tmp_event
[count
].loglevel
= uiter
.loglevel
;
2968 tmp_event
[count
].type
= (enum lttng_event_type
) LTTNG_UST_TRACEPOINT
;
2969 tmp_event
[count
].pid
= app
->pid
;
2970 tmp_event
[count
].enabled
= -1;
2976 *events
= tmp_event
;
2978 DBG2("UST app list events done (%zu events)", count
);
2983 health_code_update();
2988 * Fill events array with all events name of all registered apps.
2990 int ust_app_list_event_fields(struct lttng_event_field
**fields
)
2993 size_t nbmem
, count
= 0;
2994 struct lttng_ht_iter iter
;
2995 struct ust_app
*app
;
2996 struct lttng_event_field
*tmp_event
;
2998 nbmem
= UST_APP_EVENT_LIST_SIZE
;
2999 tmp_event
= zmalloc(nbmem
* sizeof(struct lttng_event_field
));
3000 if (tmp_event
== NULL
) {
3001 PERROR("zmalloc ust app event fields");
3008 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3009 struct lttng_ust_field_iter uiter
;
3011 health_code_update();
3013 if (!app
->compatible
) {
3015 * TODO: In time, we should notice the caller of this error by
3016 * telling him that this is a version error.
3020 handle
= ustctl_tracepoint_field_list(app
->sock
);
3022 if (handle
!= -EPIPE
&& handle
!= -LTTNG_UST_ERR_EXITING
) {
3023 ERR("UST app list field getting handle failed for app pid %d",
3029 while ((ret
= ustctl_tracepoint_field_list_get(app
->sock
, handle
,
3030 &uiter
)) != -LTTNG_UST_ERR_NOENT
) {
3031 /* Handle ustctl error. */
3034 if (ret
!= -LTTNG_UST_ERR_EXITING
|| ret
!= -EPIPE
) {
3035 ERR("UST app tp list field failed for app %d with ret %d",
3038 DBG3("UST app tp list field failed. Application is dead");
3043 health_code_update();
3044 if (count
>= nbmem
) {
3045 /* In case the realloc fails, we free the memory */
3048 DBG2("Reallocating event field list from %zu to %zu entries", nbmem
,
3051 ptr
= realloc(tmp_event
, nbmem
* sizeof(struct lttng_event_field
));
3053 PERROR("realloc ust app event fields");
3061 memcpy(tmp_event
[count
].field_name
, uiter
.field_name
, LTTNG_UST_SYM_NAME_LEN
);
3062 tmp_event
[count
].type
= uiter
.type
;
3063 tmp_event
[count
].nowrite
= uiter
.nowrite
;
3065 memcpy(tmp_event
[count
].event
.name
, uiter
.event_name
, LTTNG_UST_SYM_NAME_LEN
);
3066 tmp_event
[count
].event
.loglevel
= uiter
.loglevel
;
3067 tmp_event
[count
].event
.type
= LTTNG_UST_TRACEPOINT
;
3068 tmp_event
[count
].event
.pid
= app
->pid
;
3069 tmp_event
[count
].event
.enabled
= -1;
3075 *fields
= tmp_event
;
3077 DBG2("UST app list event fields done (%zu events)", count
);
3082 health_code_update();
3087 * Free and clean all traceable apps of the global list.
3089 * Should _NOT_ be called with RCU read-side lock held.
3091 void ust_app_clean_list(void)
3094 struct ust_app
*app
;
3095 struct lttng_ht_iter iter
;
3097 DBG2("UST app cleaning registered apps hash table");
3101 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3102 ret
= lttng_ht_del(ust_app_ht
, &iter
);
3104 call_rcu(&app
->pid_n
.head
, delete_ust_app_rcu
);
3107 /* Cleanup socket hash table */
3108 cds_lfht_for_each_entry(ust_app_ht_by_sock
->ht
, &iter
.iter
, app
,
3110 ret
= lttng_ht_del(ust_app_ht_by_sock
, &iter
);
3114 /* Cleanup notify socket hash table */
3115 cds_lfht_for_each_entry(ust_app_ht_by_notify_sock
->ht
, &iter
.iter
, app
,
3116 notify_sock_n
.node
) {
3117 ret
= lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
3122 /* Destroy is done only when the ht is empty */
3123 lttng_ht_destroy(ust_app_ht
);
3124 lttng_ht_destroy(ust_app_ht_by_sock
);
3125 lttng_ht_destroy(ust_app_ht_by_notify_sock
);
3129 * Init UST app hash table.
3131 void ust_app_ht_alloc(void)
3133 ust_app_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3134 ust_app_ht_by_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3135 ust_app_ht_by_notify_sock
= lttng_ht_new(0, LTTNG_HT_TYPE_ULONG
);
3139 * For a specific UST session, disable the channel for all registered apps.
3141 int ust_app_disable_channel_glb(struct ltt_ust_session
*usess
,
3142 struct ltt_ust_channel
*uchan
)
3145 struct lttng_ht_iter iter
;
3146 struct lttng_ht_node_str
*ua_chan_node
;
3147 struct ust_app
*app
;
3148 struct ust_app_session
*ua_sess
;
3149 struct ust_app_channel
*ua_chan
;
3151 if (usess
== NULL
|| uchan
== NULL
) {
3152 ERR("Disabling UST global channel with NULL values");
3157 DBG2("UST app disabling channel %s from global domain for session id %d",
3158 uchan
->name
, usess
->id
);
3162 /* For every registered applications */
3163 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3164 struct lttng_ht_iter uiter
;
3165 if (!app
->compatible
) {
3167 * TODO: In time, we should notice the caller of this error by
3168 * telling him that this is a version error.
3172 ua_sess
= lookup_session_by_app(usess
, app
);
3173 if (ua_sess
== NULL
) {
3178 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3179 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3180 /* If the session if found for the app, the channel must be there */
3181 assert(ua_chan_node
);
3183 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3184 /* The channel must not be already disabled */
3185 assert(ua_chan
->enabled
== 1);
3187 /* Disable channel onto application */
3188 ret
= disable_ust_app_channel(ua_sess
, ua_chan
, app
);
3190 /* XXX: We might want to report this error at some point... */
3202 * For a specific UST session, enable the channel for all registered apps.
3204 int ust_app_enable_channel_glb(struct ltt_ust_session
*usess
,
3205 struct ltt_ust_channel
*uchan
)
3208 struct lttng_ht_iter iter
;
3209 struct ust_app
*app
;
3210 struct ust_app_session
*ua_sess
;
3212 if (usess
== NULL
|| uchan
== NULL
) {
3213 ERR("Adding UST global channel to NULL values");
3218 DBG2("UST app enabling channel %s to global domain for session id %d",
3219 uchan
->name
, usess
->id
);
3223 /* For every registered applications */
3224 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3225 if (!app
->compatible
) {
3227 * TODO: In time, we should notice the caller of this error by
3228 * telling him that this is a version error.
3232 ua_sess
= lookup_session_by_app(usess
, app
);
3233 if (ua_sess
== NULL
) {
3237 /* Enable channel onto application */
3238 ret
= enable_ust_app_channel(ua_sess
, uchan
, app
);
3240 /* XXX: We might want to report this error at some point... */
3252 * Disable an event in a channel and for a specific session.
3254 int ust_app_disable_event_glb(struct ltt_ust_session
*usess
,
3255 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3258 struct lttng_ht_iter iter
, uiter
;
3259 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
3260 struct ust_app
*app
;
3261 struct ust_app_session
*ua_sess
;
3262 struct ust_app_channel
*ua_chan
;
3263 struct ust_app_event
*ua_event
;
3265 DBG("UST app disabling event %s for all apps in channel "
3266 "%s for session id %d", uevent
->attr
.name
, uchan
->name
, usess
->id
);
3270 /* For all registered applications */
3271 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3272 if (!app
->compatible
) {
3274 * TODO: In time, we should notice the caller of this error by
3275 * telling him that this is a version error.
3279 ua_sess
= lookup_session_by_app(usess
, app
);
3280 if (ua_sess
== NULL
) {
3285 /* Lookup channel in the ust app session */
3286 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3287 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3288 if (ua_chan_node
== NULL
) {
3289 DBG2("Channel %s not found in session id %d for app pid %d."
3290 "Skipping", uchan
->name
, usess
->id
, app
->pid
);
3293 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3295 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &uiter
);
3296 ua_event_node
= lttng_ht_iter_get_node_str(&uiter
);
3297 if (ua_event_node
== NULL
) {
3298 DBG2("Event %s not found in channel %s for app pid %d."
3299 "Skipping", uevent
->attr
.name
, uchan
->name
, app
->pid
);
3302 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
3304 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3306 /* XXX: Report error someday... */
3317 * For a specific UST session and UST channel, the event for all
3320 int ust_app_disable_all_event_glb(struct ltt_ust_session
*usess
,
3321 struct ltt_ust_channel
*uchan
)
3324 struct lttng_ht_iter iter
, uiter
;
3325 struct lttng_ht_node_str
*ua_chan_node
;
3326 struct ust_app
*app
;
3327 struct ust_app_session
*ua_sess
;
3328 struct ust_app_channel
*ua_chan
;
3329 struct ust_app_event
*ua_event
;
3331 DBG("UST app disabling all event for all apps in channel "
3332 "%s for session id %d", uchan
->name
, usess
->id
);
3336 /* For all registered applications */
3337 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3338 if (!app
->compatible
) {
3340 * TODO: In time, we should notice the caller of this error by
3341 * telling him that this is a version error.
3345 ua_sess
= lookup_session_by_app(usess
, app
);
3347 /* The application has problem or is probably dead. */
3351 /* Lookup channel in the ust app session */
3352 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3353 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3354 /* If the channel is not found, there is a code flow error */
3355 assert(ua_chan_node
);
3357 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3359 /* Disable each events of channel */
3360 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
3362 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
3364 /* XXX: Report error someday... */
3376 * For a specific UST session, create the channel for all registered apps.
3378 int ust_app_create_channel_glb(struct ltt_ust_session
*usess
,
3379 struct ltt_ust_channel
*uchan
)
3381 int ret
= 0, created
;
3382 struct lttng_ht_iter iter
;
3383 struct ust_app
*app
;
3384 struct ust_app_session
*ua_sess
= NULL
;
3386 /* Very wrong code flow */
3390 DBG2("UST app adding channel %s to UST domain for session id %d",
3391 uchan
->name
, usess
->id
);
3395 /* For every registered applications */
3396 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3397 if (!app
->compatible
) {
3399 * TODO: In time, we should notice the caller of this error by
3400 * telling him that this is a version error.
3405 * Create session on the tracer side and add it to app session HT. Note
3406 * that if session exist, it will simply return a pointer to the ust
3409 ret
= create_ust_app_session(usess
, app
, &ua_sess
, &created
);
3414 * The application's socket is not valid. Either a bad socket
3415 * or a timeout on it. We can't inform the caller that for a
3416 * specific app, the session failed so lets continue here.
3421 goto error_rcu_unlock
;
3426 pthread_mutex_lock(&ua_sess
->lock
);
3427 if (!strncmp(uchan
->name
, DEFAULT_METADATA_NAME
,
3428 sizeof(uchan
->name
))) {
3429 struct ustctl_consumer_channel_attr attr
;
3430 copy_channel_attr_to_ustctl(&attr
, &uchan
->attr
);
3431 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
3434 /* Create channel onto application. We don't need the chan ref. */
3435 ret
= create_ust_app_channel(ua_sess
, uchan
, app
,
3436 LTTNG_UST_CHAN_PER_CPU
, usess
, NULL
);
3438 pthread_mutex_unlock(&ua_sess
->lock
);
3440 if (ret
== -ENOMEM
) {
3441 /* No more memory is a fatal error. Stop right now. */
3442 goto error_rcu_unlock
;
3444 /* Cleanup the created session if it's the case. */
3446 destroy_app_session(app
, ua_sess
);
3457 * Enable event for a specific session and channel on the tracer.
3459 int ust_app_enable_event_glb(struct ltt_ust_session
*usess
,
3460 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3463 struct lttng_ht_iter iter
, uiter
;
3464 struct lttng_ht_node_str
*ua_chan_node
;
3465 struct ust_app
*app
;
3466 struct ust_app_session
*ua_sess
;
3467 struct ust_app_channel
*ua_chan
;
3468 struct ust_app_event
*ua_event
;
3470 DBG("UST app enabling event %s for all apps for session id %d",
3471 uevent
->attr
.name
, usess
->id
);
3474 * NOTE: At this point, this function is called only if the session and
3475 * channel passed are already created for all apps. and enabled on the
3481 /* For all registered applications */
3482 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3483 if (!app
->compatible
) {
3485 * TODO: In time, we should notice the caller of this error by
3486 * telling him that this is a version error.
3490 ua_sess
= lookup_session_by_app(usess
, app
);
3492 /* The application has problem or is probably dead. */
3496 pthread_mutex_lock(&ua_sess
->lock
);
3498 /* Lookup channel in the ust app session */
3499 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3500 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3501 /* If the channel is not found, there is a code flow error */
3502 assert(ua_chan_node
);
3504 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3506 /* Get event node */
3507 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
3508 uevent
->filter
, uevent
->attr
.loglevel
);
3509 if (ua_event
== NULL
) {
3510 DBG3("UST app enable event %s not found for app PID %d."
3511 "Skipping app", uevent
->attr
.name
, app
->pid
);
3515 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
3517 pthread_mutex_unlock(&ua_sess
->lock
);
3521 pthread_mutex_unlock(&ua_sess
->lock
);
3530 * For a specific existing UST session and UST channel, creates the event for
3531 * all registered apps.
3533 int ust_app_create_event_glb(struct ltt_ust_session
*usess
,
3534 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
)
3537 struct lttng_ht_iter iter
, uiter
;
3538 struct lttng_ht_node_str
*ua_chan_node
;
3539 struct ust_app
*app
;
3540 struct ust_app_session
*ua_sess
;
3541 struct ust_app_channel
*ua_chan
;
3543 DBG("UST app creating event %s for all apps for session id %d",
3544 uevent
->attr
.name
, usess
->id
);
3548 /* For all registered applications */
3549 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3550 if (!app
->compatible
) {
3552 * TODO: In time, we should notice the caller of this error by
3553 * telling him that this is a version error.
3557 ua_sess
= lookup_session_by_app(usess
, app
);
3559 /* The application has problem or is probably dead. */
3563 pthread_mutex_lock(&ua_sess
->lock
);
3564 /* Lookup channel in the ust app session */
3565 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
3566 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
3567 /* If the channel is not found, there is a code flow error */
3568 assert(ua_chan_node
);
3570 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
3572 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
3573 pthread_mutex_unlock(&ua_sess
->lock
);
3575 if (ret
!= -LTTNG_UST_ERR_EXIST
) {
3576 /* Possible value at this point: -ENOMEM. If so, we stop! */
3579 DBG2("UST app event %s already exist on app PID %d",
3580 uevent
->attr
.name
, app
->pid
);
3591 * Start tracing for a specific UST session and app.
3594 int ust_app_start_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3597 struct ust_app_session
*ua_sess
;
3599 DBG("Starting tracing for ust app pid %d", app
->pid
);
3603 if (!app
->compatible
) {
3607 ua_sess
= lookup_session_by_app(usess
, app
);
3608 if (ua_sess
== NULL
) {
3609 /* The session is in teardown process. Ignore and continue. */
3613 pthread_mutex_lock(&ua_sess
->lock
);
3615 /* Upon restart, we skip the setup, already done */
3616 if (ua_sess
->started
) {
3620 /* Create directories if consumer is LOCAL and has a path defined. */
3621 if (usess
->consumer
->type
== CONSUMER_DST_LOCAL
&&
3622 strlen(usess
->consumer
->dst
.trace_path
) > 0) {
3623 ret
= run_as_mkdir_recursive(usess
->consumer
->dst
.trace_path
,
3624 S_IRWXU
| S_IRWXG
, ua_sess
->euid
, ua_sess
->egid
);
3626 if (ret
!= -EEXIST
) {
3627 ERR("Trace directory creation error");
3634 * Create the metadata for the application. This returns gracefully if a
3635 * metadata was already set for the session.
3637 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
, NULL
);
3642 health_code_update();
3645 /* This start the UST tracing */
3646 ret
= ustctl_start_session(app
->sock
, ua_sess
->handle
);
3648 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3649 ERR("Error starting tracing for app pid: %d (ret: %d)",
3652 DBG("UST app start session failed. Application is dead.");
3657 /* Indicate that the session has been started once */
3658 ua_sess
->started
= 1;
3660 pthread_mutex_unlock(&ua_sess
->lock
);
3662 health_code_update();
3664 /* Quiescent wait after starting trace */
3665 ret
= ustctl_wait_quiescent(app
->sock
);
3666 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3667 ERR("UST app wait quiescent failed for app pid %d ret %d",
3673 health_code_update();
3677 pthread_mutex_unlock(&ua_sess
->lock
);
3679 health_code_update();
3684 * Stop tracing for a specific UST session and app.
3687 int ust_app_stop_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3690 struct ust_app_session
*ua_sess
;
3691 struct ust_registry_session
*registry
;
3693 DBG("Stopping tracing for ust app pid %d", app
->pid
);
3697 if (!app
->compatible
) {
3698 goto end_no_session
;
3701 ua_sess
= lookup_session_by_app(usess
, app
);
3702 if (ua_sess
== NULL
) {
3703 goto end_no_session
;
3706 pthread_mutex_lock(&ua_sess
->lock
);
3709 * If started = 0, it means that stop trace has been called for a session
3710 * that was never started. It's possible since we can have a fail start
3711 * from either the application manager thread or the command thread. Simply
3712 * indicate that this is a stop error.
3714 if (!ua_sess
->started
) {
3715 goto error_rcu_unlock
;
3718 health_code_update();
3720 /* This inhibits UST tracing */
3721 ret
= ustctl_stop_session(app
->sock
, ua_sess
->handle
);
3723 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3724 ERR("Error stopping tracing for app pid: %d (ret: %d)",
3727 DBG("UST app stop session failed. Application is dead.");
3729 goto error_rcu_unlock
;
3732 health_code_update();
3734 /* Quiescent wait after stopping trace */
3735 ret
= ustctl_wait_quiescent(app
->sock
);
3736 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3737 ERR("UST app wait quiescent failed for app pid %d ret %d",
3741 health_code_update();
3743 registry
= get_session_registry(ua_sess
);
3745 /* Push metadata for application before freeing the application. */
3746 (void) push_metadata(registry
, ua_sess
->consumer
);
3748 pthread_mutex_unlock(&ua_sess
->lock
);
3751 health_code_update();
3755 pthread_mutex_unlock(&ua_sess
->lock
);
3757 health_code_update();
3762 * Flush buffers for a specific UST session and app.
3765 int ust_app_flush_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3768 struct lttng_ht_iter iter
;
3769 struct ust_app_session
*ua_sess
;
3770 struct ust_app_channel
*ua_chan
;
3772 DBG("Flushing buffers for ust app pid %d", app
->pid
);
3776 if (!app
->compatible
) {
3777 goto end_no_session
;
3780 ua_sess
= lookup_session_by_app(usess
, app
);
3781 if (ua_sess
== NULL
) {
3782 goto end_no_session
;
3785 pthread_mutex_lock(&ua_sess
->lock
);
3787 health_code_update();
3789 /* Flushing buffers */
3790 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
3792 health_code_update();
3793 assert(ua_chan
->is_sent
);
3794 ret
= ustctl_sock_flush_buffer(app
->sock
, ua_chan
->obj
);
3796 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3797 ERR("UST app PID %d channel %s flush failed with ret %d",
3798 app
->pid
, ua_chan
->name
, ret
);
3800 DBG3("UST app failed to flush %s. Application is dead.",
3802 /* No need to continue. */
3805 /* Continuing flushing all buffers */
3810 health_code_update();
3812 pthread_mutex_unlock(&ua_sess
->lock
);
3815 health_code_update();
3820 * Destroy a specific UST session in apps.
3822 static int destroy_trace(struct ltt_ust_session
*usess
, struct ust_app
*app
)
3825 struct ust_app_session
*ua_sess
;
3826 struct lttng_ht_iter iter
;
3827 struct lttng_ht_node_ulong
*node
;
3829 DBG("Destroy tracing for ust app pid %d", app
->pid
);
3833 if (!app
->compatible
) {
3837 __lookup_session_by_app(usess
, app
, &iter
);
3838 node
= lttng_ht_iter_get_node_ulong(&iter
);
3840 /* Session is being or is deleted. */
3843 ua_sess
= caa_container_of(node
, struct ust_app_session
, node
);
3845 health_code_update();
3846 destroy_app_session(app
, ua_sess
);
3848 health_code_update();
3850 /* Quiescent wait after stopping trace */
3851 ret
= ustctl_wait_quiescent(app
->sock
);
3852 if (ret
< 0 && ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
3853 ERR("UST app wait quiescent failed for app pid %d ret %d",
3858 health_code_update();
3863 * Start tracing for the UST session.
3865 int ust_app_start_trace_all(struct ltt_ust_session
*usess
)
3868 struct lttng_ht_iter iter
;
3869 struct ust_app
*app
;
3871 DBG("Starting all UST traces");
3875 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3876 ret
= ust_app_start_trace(usess
, app
);
3878 /* Continue to next apps even on error */
3889 * Start tracing for the UST session.
3891 int ust_app_stop_trace_all(struct ltt_ust_session
*usess
)
3894 struct lttng_ht_iter iter
;
3895 struct ust_app
*app
;
3897 DBG("Stopping all UST traces");
3901 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3902 ret
= ust_app_stop_trace(usess
, app
);
3904 /* Continue to next apps even on error */
3910 switch (usess
->buffer_type
) {
3911 case LTTNG_BUFFER_PER_UID
:
3913 struct buffer_reg_uid
*reg
;
3915 /* Flush all per UID buffers associated to that session. */
3916 cds_list_for_each_entry(reg
, &usess
->buffer_reg_uid_list
, lnode
) {
3917 struct buffer_reg_channel
*reg_chan
;
3918 struct consumer_socket
*socket
;
3920 /* Get consumer socket to use to push the metadata.*/
3921 socket
= consumer_find_socket_by_bitness(reg
->bits_per_long
,
3924 /* Ignore request if no consumer is found for the session. */
3928 cds_lfht_for_each_entry(reg
->registry
->channels
->ht
, &iter
.iter
,
3929 reg_chan
, node
.node
) {
3931 * The following call will print error values so the return
3932 * code is of little importance because whatever happens, we
3933 * have to try them all.
3935 (void) consumer_flush_channel(socket
, reg_chan
->consumer_key
);
3940 case LTTNG_BUFFER_PER_PID
:
3941 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3942 ret
= ust_app_flush_trace(usess
, app
);
3944 /* Continue to next apps even on error */
3960 * Destroy app UST session.
3962 int ust_app_destroy_trace_all(struct ltt_ust_session
*usess
)
3965 struct lttng_ht_iter iter
;
3966 struct ust_app
*app
;
3968 DBG("Destroy all UST traces");
3972 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
3973 ret
= destroy_trace(usess
, app
);
3975 /* Continue to next apps even on error */
3986 * Add channels/events from UST global domain to registered apps at sock.
3988 void ust_app_global_update(struct ltt_ust_session
*usess
, int sock
)
3991 struct lttng_ht_iter iter
, uiter
, iter_ctx
;
3992 struct ust_app
*app
;
3993 struct ust_app_session
*ua_sess
= NULL
;
3994 struct ust_app_channel
*ua_chan
;
3995 struct ust_app_event
*ua_event
;
3996 struct ust_app_ctx
*ua_ctx
;
4001 DBG2("UST app global update for app sock %d for session id %d", sock
,
4006 app
= find_app_by_sock(sock
);
4009 * Application can be unregistered before so this is possible hence
4010 * simply stopping the update.
4012 DBG3("UST app update failed to find app sock %d", sock
);
4016 if (!app
->compatible
) {
4020 ret
= create_ust_app_session(usess
, app
, &ua_sess
, NULL
);
4022 /* Tracer is probably gone or ENOMEM. */
4027 pthread_mutex_lock(&ua_sess
->lock
);
4030 * We can iterate safely here over all UST app session since the create ust
4031 * app session above made a shadow copy of the UST global domain from the
4034 cds_lfht_for_each_entry(ua_sess
->channels
->ht
, &iter
.iter
, ua_chan
,
4037 * For a metadata channel, handle it differently.
4039 if (!strncmp(ua_chan
->name
, DEFAULT_METADATA_NAME
,
4040 sizeof(ua_chan
->name
))) {
4041 ret
= create_ust_app_metadata(ua_sess
, app
, usess
->consumer
,
4046 /* Remove it from the hash table and continue!. */
4047 ret
= lttng_ht_del(ua_sess
->channels
, &iter
);
4049 delete_ust_app_channel(-1, ua_chan
, app
);
4052 ret
= do_create_channel(app
, usess
, ua_sess
, ua_chan
);
4055 * Stop everything. On error, the application failed, no more
4056 * file descriptor are available or ENOMEM so stopping here is
4057 * the only thing we can do for now.
4063 cds_lfht_for_each_entry(ua_chan
->ctx
->ht
, &iter_ctx
.iter
, ua_ctx
,
4065 ret
= create_ust_channel_context(ua_chan
, ua_ctx
, app
);
4072 /* For each events */
4073 cds_lfht_for_each_entry(ua_chan
->events
->ht
, &uiter
.iter
, ua_event
,
4075 ret
= create_ust_event(app
, ua_sess
, ua_chan
, ua_event
);
4082 pthread_mutex_unlock(&ua_sess
->lock
);
4084 if (usess
->start_trace
) {
4085 ret
= ust_app_start_trace(usess
, app
);
4090 DBG2("UST trace started for app pid %d", app
->pid
);
4093 /* Everything went well at this point. */
4098 pthread_mutex_unlock(&ua_sess
->lock
);
4101 destroy_app_session(app
, ua_sess
);
4108 * Add context to a specific channel for global UST domain.
4110 int ust_app_add_ctx_channel_glb(struct ltt_ust_session
*usess
,
4111 struct ltt_ust_channel
*uchan
, struct ltt_ust_context
*uctx
)
4114 struct lttng_ht_node_str
*ua_chan_node
;
4115 struct lttng_ht_iter iter
, uiter
;
4116 struct ust_app_channel
*ua_chan
= NULL
;
4117 struct ust_app_session
*ua_sess
;
4118 struct ust_app
*app
;
4122 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4123 if (!app
->compatible
) {
4125 * TODO: In time, we should notice the caller of this error by
4126 * telling him that this is a version error.
4130 ua_sess
= lookup_session_by_app(usess
, app
);
4131 if (ua_sess
== NULL
) {
4135 pthread_mutex_lock(&ua_sess
->lock
);
4136 /* Lookup channel in the ust app session */
4137 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &uiter
);
4138 ua_chan_node
= lttng_ht_iter_get_node_str(&uiter
);
4139 if (ua_chan_node
== NULL
) {
4142 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
,
4144 ret
= create_ust_app_channel_context(ua_sess
, ua_chan
, &uctx
->ctx
, app
);
4149 pthread_mutex_unlock(&ua_sess
->lock
);
4157 * Enable event for a channel from a UST session for a specific PID.
4159 int ust_app_enable_event_pid(struct ltt_ust_session
*usess
,
4160 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4163 struct lttng_ht_iter iter
;
4164 struct lttng_ht_node_str
*ua_chan_node
;
4165 struct ust_app
*app
;
4166 struct ust_app_session
*ua_sess
;
4167 struct ust_app_channel
*ua_chan
;
4168 struct ust_app_event
*ua_event
;
4170 DBG("UST app enabling event %s for PID %d", uevent
->attr
.name
, pid
);
4174 app
= ust_app_find_by_pid(pid
);
4176 ERR("UST app enable event per PID %d not found", pid
);
4181 if (!app
->compatible
) {
4186 ua_sess
= lookup_session_by_app(usess
, app
);
4188 /* The application has problem or is probably dead. */
4193 pthread_mutex_lock(&ua_sess
->lock
);
4194 /* Lookup channel in the ust app session */
4195 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4196 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4197 /* If the channel is not found, there is a code flow error */
4198 assert(ua_chan_node
);
4200 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4202 ua_event
= find_ust_app_event(ua_chan
->events
, uevent
->attr
.name
,
4203 uevent
->filter
, uevent
->attr
.loglevel
);
4204 if (ua_event
== NULL
) {
4205 ret
= create_ust_app_event(ua_sess
, ua_chan
, uevent
, app
);
4210 ret
= enable_ust_app_event(ua_sess
, ua_event
, app
);
4217 pthread_mutex_unlock(&ua_sess
->lock
);
4224 * Disable event for a channel from a UST session for a specific PID.
4226 int ust_app_disable_event_pid(struct ltt_ust_session
*usess
,
4227 struct ltt_ust_channel
*uchan
, struct ltt_ust_event
*uevent
, pid_t pid
)
4230 struct lttng_ht_iter iter
;
4231 struct lttng_ht_node_str
*ua_chan_node
, *ua_event_node
;
4232 struct ust_app
*app
;
4233 struct ust_app_session
*ua_sess
;
4234 struct ust_app_channel
*ua_chan
;
4235 struct ust_app_event
*ua_event
;
4237 DBG("UST app disabling event %s for PID %d", uevent
->attr
.name
, pid
);
4241 app
= ust_app_find_by_pid(pid
);
4243 ERR("UST app disable event per PID %d not found", pid
);
4248 if (!app
->compatible
) {
4253 ua_sess
= lookup_session_by_app(usess
, app
);
4255 /* The application has problem or is probably dead. */
4259 /* Lookup channel in the ust app session */
4260 lttng_ht_lookup(ua_sess
->channels
, (void *)uchan
->name
, &iter
);
4261 ua_chan_node
= lttng_ht_iter_get_node_str(&iter
);
4262 if (ua_chan_node
== NULL
) {
4263 /* Channel does not exist, skip disabling */
4266 ua_chan
= caa_container_of(ua_chan_node
, struct ust_app_channel
, node
);
4268 lttng_ht_lookup(ua_chan
->events
, (void *)uevent
->attr
.name
, &iter
);
4269 ua_event_node
= lttng_ht_iter_get_node_str(&iter
);
4270 if (ua_event_node
== NULL
) {
4271 /* Event does not exist, skip disabling */
4274 ua_event
= caa_container_of(ua_event_node
, struct ust_app_event
, node
);
4276 ret
= disable_ust_app_event(ua_sess
, ua_event
, app
);
4287 * Calibrate registered applications.
4289 int ust_app_calibrate_glb(struct lttng_ust_calibrate
*calibrate
)
4292 struct lttng_ht_iter iter
;
4293 struct ust_app
*app
;
4297 cds_lfht_for_each_entry(ust_app_ht
->ht
, &iter
.iter
, app
, pid_n
.node
) {
4298 if (!app
->compatible
) {
4300 * TODO: In time, we should notice the caller of this error by
4301 * telling him that this is a version error.
4306 health_code_update();
4308 ret
= ustctl_calibrate(app
->sock
, calibrate
);
4312 /* Means that it's not implemented on the tracer side. */
4316 DBG2("Calibrate app PID %d returned with error %d",
4323 DBG("UST app global domain calibration finished");
4327 health_code_update();
4333 * Receive registration and populate the given msg structure.
4335 * On success return 0 else a negative value returned by the ustctl call.
4337 int ust_app_recv_registration(int sock
, struct ust_register_msg
*msg
)
4340 uint32_t pid
, ppid
, uid
, gid
;
4344 ret
= ustctl_recv_reg_msg(sock
, &msg
->type
, &msg
->major
, &msg
->minor
,
4345 &pid
, &ppid
, &uid
, &gid
,
4346 &msg
->bits_per_long
,
4347 &msg
->uint8_t_alignment
,
4348 &msg
->uint16_t_alignment
,
4349 &msg
->uint32_t_alignment
,
4350 &msg
->uint64_t_alignment
,
4351 &msg
->long_alignment
,
4358 case LTTNG_UST_ERR_EXITING
:
4359 DBG3("UST app recv reg message failed. Application died");
4361 case LTTNG_UST_ERR_UNSUP_MAJOR
:
4362 ERR("UST app recv reg unsupported version %d.%d. Supporting %d.%d",
4363 msg
->major
, msg
->minor
, LTTNG_UST_ABI_MAJOR_VERSION
,
4364 LTTNG_UST_ABI_MINOR_VERSION
);
4367 ERR("UST app recv reg message failed with ret %d", ret
);
4372 msg
->pid
= (pid_t
) pid
;
4373 msg
->ppid
= (pid_t
) ppid
;
4374 msg
->uid
= (uid_t
) uid
;
4375 msg
->gid
= (gid_t
) gid
;
4382 * Return a ust app channel object using the application object and the channel
4383 * object descriptor has a key. If not found, NULL is returned. A RCU read side
4384 * lock MUST be acquired before calling this function.
4386 static struct ust_app_channel
*find_channel_by_objd(struct ust_app
*app
,
4389 struct lttng_ht_node_ulong
*node
;
4390 struct lttng_ht_iter iter
;
4391 struct ust_app_channel
*ua_chan
= NULL
;
4395 lttng_ht_lookup(app
->ust_objd
, (void *)((unsigned long) objd
), &iter
);
4396 node
= lttng_ht_iter_get_node_ulong(&iter
);
4398 DBG2("UST app channel find by objd %d not found", objd
);
4402 ua_chan
= caa_container_of(node
, struct ust_app_channel
, ust_objd_node
);
4409 * Reply to a register channel notification from an application on the notify
4410 * socket. The channel metadata is also created.
4412 * The session UST registry lock is acquired in this function.
4414 * On success 0 is returned else a negative value.
4416 static int reply_ust_register_channel(int sock
, int sobjd
, int cobjd
,
4417 size_t nr_fields
, struct ustctl_field
*fields
)
4419 int ret
, ret_code
= 0;
4420 uint32_t chan_id
, reg_count
;
4421 uint64_t chan_reg_key
;
4422 enum ustctl_channel_header type
;
4423 struct ust_app
*app
;
4424 struct ust_app_channel
*ua_chan
;
4425 struct ust_app_session
*ua_sess
;
4426 struct ust_registry_session
*registry
;
4427 struct ust_registry_channel
*chan_reg
;
4431 /* Lookup application. If not found, there is a code flow error. */
4432 app
= find_app_by_notify_sock(sock
);
4434 DBG("Application socket %d is being teardown. Abort event notify",
4437 goto error_rcu_unlock
;
4440 /* Lookup channel by UST object descriptor. Should always be found. */
4441 ua_chan
= find_channel_by_objd(app
, cobjd
);
4443 assert(ua_chan
->session
);
4444 ua_sess
= ua_chan
->session
;
4446 /* Get right session registry depending on the session buffer type. */
4447 registry
= get_session_registry(ua_sess
);
4450 /* Depending on the buffer type, a different channel key is used. */
4451 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4452 chan_reg_key
= ua_chan
->tracing_channel_id
;
4454 chan_reg_key
= ua_chan
->key
;
4457 pthread_mutex_lock(®istry
->lock
);
4459 chan_reg
= ust_registry_channel_find(registry
, chan_reg_key
);
4462 if (!chan_reg
->register_done
) {
4463 reg_count
= ust_registry_get_event_count(chan_reg
);
4464 if (reg_count
< 31) {
4465 type
= USTCTL_CHANNEL_HEADER_COMPACT
;
4467 type
= USTCTL_CHANNEL_HEADER_LARGE
;
4470 chan_reg
->nr_ctx_fields
= nr_fields
;
4471 chan_reg
->ctx_fields
= fields
;
4472 chan_reg
->header_type
= type
;
4474 /* Get current already assigned values. */
4475 type
= chan_reg
->header_type
;
4477 /* Channel id is set during the object creation. */
4478 chan_id
= chan_reg
->chan_id
;
4480 /* Append to metadata */
4481 if (!chan_reg
->metadata_dumped
) {
4482 ret_code
= ust_metadata_channel_statedump(registry
, chan_reg
);
4484 ERR("Error appending channel metadata (errno = %d)", ret_code
);
4490 DBG3("UST app replying to register channel key %" PRIu64
4491 " with id %u, type: %d, ret: %d", chan_reg_key
, chan_id
, type
,
4494 ret
= ustctl_reply_register_channel(sock
, chan_id
, type
, ret_code
);
4496 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4497 ERR("UST app reply channel failed with ret %d", ret
);
4499 DBG3("UST app reply channel failed. Application died");
4504 /* This channel registry registration is completed. */
4505 chan_reg
->register_done
= 1;
4508 pthread_mutex_unlock(®istry
->lock
);
4515 * Add event to the UST channel registry. When the event is added to the
4516 * registry, the metadata is also created. Once done, this replies to the
4517 * application with the appropriate error code.
4519 * The session UST registry lock is acquired in the function.
4521 * On success 0 is returned else a negative value.
4523 static int add_event_ust_registry(int sock
, int sobjd
, int cobjd
, char *name
,
4524 char *sig
, size_t nr_fields
, struct ustctl_field
*fields
, int loglevel
,
4525 char *model_emf_uri
)
4528 uint32_t event_id
= 0;
4529 uint64_t chan_reg_key
;
4530 struct ust_app
*app
;
4531 struct ust_app_channel
*ua_chan
;
4532 struct ust_app_session
*ua_sess
;
4533 struct ust_registry_session
*registry
;
4537 /* Lookup application. If not found, there is a code flow error. */
4538 app
= find_app_by_notify_sock(sock
);
4540 DBG("Application socket %d is being teardown. Abort event notify",
4543 goto error_rcu_unlock
;
4546 /* Lookup channel by UST object descriptor. Should always be found. */
4547 ua_chan
= find_channel_by_objd(app
, cobjd
);
4549 assert(ua_chan
->session
);
4550 ua_sess
= ua_chan
->session
;
4552 registry
= get_session_registry(ua_sess
);
4555 if (ua_sess
->buffer_type
== LTTNG_BUFFER_PER_UID
) {
4556 chan_reg_key
= ua_chan
->tracing_channel_id
;
4558 chan_reg_key
= ua_chan
->key
;
4561 pthread_mutex_lock(®istry
->lock
);
4563 ret_code
= ust_registry_create_event(registry
, chan_reg_key
,
4564 sobjd
, cobjd
, name
, sig
, nr_fields
, fields
, loglevel
,
4565 model_emf_uri
, ua_sess
->buffer_type
, &event_id
);
4568 * The return value is returned to ustctl so in case of an error, the
4569 * application can be notified. In case of an error, it's important not to
4570 * return a negative error or else the application will get closed.
4572 ret
= ustctl_reply_register_event(sock
, event_id
, ret_code
);
4574 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4575 ERR("UST app reply event failed with ret %d", ret
);
4577 DBG3("UST app reply event failed. Application died");
4580 * No need to wipe the create event since the application socket will
4581 * get close on error hence cleaning up everything by itself.
4586 DBG3("UST registry event %s with id %" PRId32
" added successfully",
4590 pthread_mutex_unlock(®istry
->lock
);
4597 * Handle application notification through the given notify socket.
4599 * Return 0 on success or else a negative value.
4601 int ust_app_recv_notify(int sock
)
4604 enum ustctl_notify_cmd cmd
;
4606 DBG3("UST app receiving notify from sock %d", sock
);
4608 ret
= ustctl_recv_notify(sock
, &cmd
);
4610 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4611 ERR("UST app recv notify failed with ret %d", ret
);
4613 DBG3("UST app recv notify failed. Application died");
4619 case USTCTL_NOTIFY_CMD_EVENT
:
4621 int sobjd
, cobjd
, loglevel
;
4622 char name
[LTTNG_UST_SYM_NAME_LEN
], *sig
, *model_emf_uri
;
4624 struct ustctl_field
*fields
;
4626 DBG2("UST app ustctl register event received");
4628 ret
= ustctl_recv_register_event(sock
, &sobjd
, &cobjd
, name
, &loglevel
,
4629 &sig
, &nr_fields
, &fields
, &model_emf_uri
);
4631 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4632 ERR("UST app recv event failed with ret %d", ret
);
4634 DBG3("UST app recv event failed. Application died");
4639 /* Add event to the UST registry coming from the notify socket. */
4640 ret
= add_event_ust_registry(sock
, sobjd
, cobjd
, name
, sig
, nr_fields
,
4641 fields
, loglevel
, model_emf_uri
);
4648 case USTCTL_NOTIFY_CMD_CHANNEL
:
4652 struct ustctl_field
*fields
;
4654 DBG2("UST app ustctl register channel received");
4656 ret
= ustctl_recv_register_channel(sock
, &sobjd
, &cobjd
, &nr_fields
,
4659 if (ret
!= -EPIPE
&& ret
!= -LTTNG_UST_ERR_EXITING
) {
4660 ERR("UST app recv channel failed with ret %d", ret
);
4662 DBG3("UST app recv channel failed. Application died");
4667 ret
= reply_ust_register_channel(sock
, sobjd
, cobjd
, nr_fields
,
4676 /* Should NEVER happen. */
4685 * Once the notify socket hangs up, this is called. First, it tries to find the
4686 * corresponding application. On failure, the call_rcu to close the socket is
4687 * executed. If an application is found, it tries to delete it from the notify
4688 * socket hash table. Whathever the result, it proceeds to the call_rcu.
4690 * Note that an object needs to be allocated here so on ENOMEM failure, the
4691 * call RCU is not done but the rest of the cleanup is.
4693 void ust_app_notify_sock_unregister(int sock
)
4696 struct lttng_ht_iter iter
;
4697 struct ust_app
*app
;
4698 struct ust_app_notify_sock_obj
*obj
;
4704 obj
= zmalloc(sizeof(*obj
));
4707 * An ENOMEM is kind of uncool. If this strikes we continue the
4708 * procedure but the call_rcu will not be called. In this case, we
4709 * accept the fd leak rather than possibly creating an unsynchronized
4710 * state between threads.
4712 * TODO: The notify object should be created once the notify socket is
4713 * registered and stored independantely from the ust app object. The
4714 * tricky part is to synchronize the teardown of the application and
4715 * this notify object. Let's keep that in mind so we can avoid this
4716 * kind of shenanigans with ENOMEM in the teardown path.
4723 DBG("UST app notify socket unregister %d", sock
);
4726 * Lookup application by notify socket. If this fails, this means that the
4727 * hash table delete has already been done by the application
4728 * unregistration process so we can safely close the notify socket in a
4731 app
= find_app_by_notify_sock(sock
);
4736 iter
.iter
.node
= &app
->notify_sock_n
.node
;
4739 * Whatever happens here either we fail or succeed, in both cases we have
4740 * to close the socket after a grace period to continue to the call RCU
4741 * here. If the deletion is successful, the application is not visible
4742 * anymore by other threads and is it fails it means that it was already
4743 * deleted from the hash table so either way we just have to close the
4746 (void) lttng_ht_del(ust_app_ht_by_notify_sock
, &iter
);
4752 * Close socket after a grace period to avoid for the socket to be reused
4753 * before the application object is freed creating potential race between
4754 * threads trying to add unique in the global hash table.
4757 call_rcu(&obj
->head
, close_notify_sock_rcu
);