2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #include <lttng/ust-ctl.h>
28 #include <sys/socket.h>
30 #include <sys/types.h>
33 #include <urcu/list.h>
36 #include <bin/lttng-consumerd/health-consumerd.h>
37 #include <common/common.h>
38 #include <common/sessiond-comm/sessiond-comm.h>
39 #include <common/relayd/relayd.h>
40 #include <common/compat/fcntl.h>
41 #include <common/compat/endian.h>
42 #include <common/consumer/consumer-metadata-cache.h>
43 #include <common/consumer/consumer-stream.h>
44 #include <common/consumer/consumer-timer.h>
45 #include <common/utils.h>
46 #include <common/index/index.h>
48 #include "ust-consumer.h"
50 #define INT_MAX_STR_LEN 12 /* includes \0 */
52 extern struct lttng_consumer_global_data consumer_data
;
53 extern int consumer_poll_timeout
;
56 * Free channel object and all streams associated with it. This MUST be used
57 * only and only if the channel has _NEVER_ been added to the global channel
60 static void destroy_channel(struct lttng_consumer_channel
*channel
)
62 struct lttng_consumer_stream
*stream
, *stmp
;
66 DBG("UST consumer cleaning stream list");
68 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
73 cds_list_del(&stream
->send_node
);
74 ustctl_destroy_stream(stream
->ustream
);
79 * If a channel is available meaning that was created before the streams
83 lttng_ustconsumer_del_channel(channel
);
84 lttng_ustconsumer_free_channel(channel
);
90 * Add channel to internal consumer state.
92 * Returns 0 on success or else a negative value.
94 static int add_channel(struct lttng_consumer_channel
*channel
,
95 struct lttng_consumer_local_data
*ctx
)
102 if (ctx
->on_recv_channel
!= NULL
) {
103 ret
= ctx
->on_recv_channel(channel
);
105 ret
= consumer_add_channel(channel
, ctx
);
106 } else if (ret
< 0) {
107 /* Most likely an ENOMEM. */
108 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
112 ret
= consumer_add_channel(channel
, ctx
);
115 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
122 * Allocate and return a consumer channel object.
124 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
125 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
126 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
127 uint64_t tracefile_size
, uint64_t tracefile_count
,
128 uint64_t session_id_per_pid
, unsigned int monitor
,
129 unsigned int live_timer_interval
,
130 const char *root_shm_path
, const char *shm_path
)
135 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
136 gid
, relayd_id
, output
, tracefile_size
,
137 tracefile_count
, session_id_per_pid
, monitor
,
138 live_timer_interval
, root_shm_path
, shm_path
);
142 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
143 * error value if applicable is set in it else it is kept untouched.
145 * Return NULL on error else the newly allocated stream object.
147 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
148 struct lttng_consumer_channel
*channel
,
149 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
152 struct lttng_consumer_stream
*stream
= NULL
;
157 stream
= consumer_allocate_stream(channel
->key
,
159 LTTNG_CONSUMER_ACTIVE_STREAM
,
169 if (stream
== NULL
) {
173 * We could not find the channel. Can happen if cpu hotplug
174 * happens while tearing down.
176 DBG3("Could not find channel");
181 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
187 stream
->chan
= channel
;
191 *_alloc_ret
= alloc_ret
;
197 * Send the given stream pointer to the corresponding thread.
199 * Returns 0 on success else a negative value.
201 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
202 struct lttng_consumer_local_data
*ctx
)
205 struct lttng_pipe
*stream_pipe
;
207 /* Get the right pipe where the stream will be sent. */
208 if (stream
->metadata_flag
) {
209 consumer_add_metadata_stream(stream
);
210 stream_pipe
= ctx
->consumer_metadata_pipe
;
212 consumer_add_data_stream(stream
);
213 stream_pipe
= ctx
->consumer_data_pipe
;
217 * From this point on, the stream's ownership has been moved away from
218 * the channel and it becomes globally visible. Hence, remove it from
219 * the local stream list to prevent the stream from being both local and
222 stream
->globally_visible
= 1;
223 cds_list_del(&stream
->send_node
);
225 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
227 ERR("Consumer write %s stream to pipe %d",
228 stream
->metadata_flag
? "metadata" : "data",
229 lttng_pipe_get_writefd(stream_pipe
));
230 if (stream
->metadata_flag
) {
231 consumer_del_stream_for_metadata(stream
);
233 consumer_del_stream_for_data(stream
);
243 int get_stream_shm_path(char *stream_shm_path
, const char *shm_path
, int cpu
)
245 char cpu_nr
[INT_MAX_STR_LEN
]; /* int max len */
248 strncpy(stream_shm_path
, shm_path
, PATH_MAX
);
249 stream_shm_path
[PATH_MAX
- 1] = '\0';
250 ret
= snprintf(cpu_nr
, INT_MAX_STR_LEN
, "%i", cpu
);
255 strncat(stream_shm_path
, cpu_nr
,
256 PATH_MAX
- strlen(stream_shm_path
) - 1);
263 * Create streams for the given channel using liblttng-ust-ctl.
265 * Return 0 on success else a negative value.
267 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
268 struct lttng_consumer_local_data
*ctx
)
271 struct ustctl_consumer_stream
*ustream
;
272 struct lttng_consumer_stream
*stream
;
278 * While a stream is available from ustctl. When NULL is returned, we've
279 * reached the end of the possible stream for the channel.
281 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
283 int ust_metadata_pipe
[2];
285 health_code_update();
287 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
288 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
290 ERR("Create ust metadata poll pipe");
293 wait_fd
= ust_metadata_pipe
[0];
295 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
298 /* Allocate consumer stream object. */
299 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
303 stream
->ustream
= ustream
;
305 * Store it so we can save multiple function calls afterwards since
306 * this value is used heavily in the stream threads. This is UST
307 * specific so this is why it's done after allocation.
309 stream
->wait_fd
= wait_fd
;
312 * Increment channel refcount since the channel reference has now been
313 * assigned in the allocation process above.
315 if (stream
->chan
->monitor
) {
316 uatomic_inc(&stream
->chan
->refcount
);
320 * Order is important this is why a list is used. On error, the caller
321 * should clean this list.
323 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
325 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
326 &stream
->max_sb_size
);
328 ERR("ustctl_get_max_subbuf_size failed for stream %s",
333 /* Do actions once stream has been received. */
334 if (ctx
->on_recv_stream
) {
335 ret
= ctx
->on_recv_stream(stream
);
341 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
342 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
344 /* Set next CPU stream. */
345 channel
->streams
.count
= ++cpu
;
347 /* Keep stream reference when creating metadata. */
348 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
349 channel
->metadata_stream
= stream
;
350 if (channel
->monitor
) {
351 /* Set metadata poll pipe if we created one */
352 memcpy(stream
->ust_metadata_poll_pipe
,
354 sizeof(ust_metadata_pipe
));
367 * create_posix_shm is never called concurrently within a process.
370 int create_posix_shm(void)
372 char tmp_name
[NAME_MAX
];
375 ret
= snprintf(tmp_name
, NAME_MAX
, "/ust-shm-consumer-%d", getpid());
381 * Allocate shm, and immediately unlink its shm oject, keeping
382 * only the file descriptor as a reference to the object.
383 * We specifically do _not_ use the / at the beginning of the
384 * pathname so that some OS implementations can keep it local to
385 * the process (POSIX leaves this implementation-defined).
387 shmfd
= shm_open(tmp_name
, O_CREAT
| O_EXCL
| O_RDWR
, 0700);
392 ret
= shm_unlink(tmp_name
);
393 if (ret
< 0 && errno
!= ENOENT
) {
394 PERROR("shm_unlink");
395 goto error_shm_release
;
408 static int open_ust_stream_fd(struct lttng_consumer_channel
*channel
,
409 struct ustctl_consumer_channel_attr
*attr
,
412 char shm_path
[PATH_MAX
];
415 if (!channel
->shm_path
[0]) {
416 return create_posix_shm();
418 ret
= get_stream_shm_path(shm_path
, channel
->shm_path
, cpu
);
422 return run_as_open(shm_path
,
423 O_RDWR
| O_CREAT
| O_EXCL
, S_IRUSR
| S_IWUSR
,
424 channel
->uid
, channel
->gid
);
431 * Create an UST channel with the given attributes and send it to the session
432 * daemon using the ust ctl API.
434 * Return 0 on success or else a negative value.
436 static int create_ust_channel(struct lttng_consumer_channel
*channel
,
437 struct ustctl_consumer_channel_attr
*attr
,
438 struct ustctl_consumer_channel
**ust_chanp
)
440 int ret
, nr_stream_fds
, i
, j
;
442 struct ustctl_consumer_channel
*ust_channel
;
448 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
449 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
450 "switch_timer_interval: %u, read_timer_interval: %u, "
451 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
452 attr
->num_subbuf
, attr
->switch_timer_interval
,
453 attr
->read_timer_interval
, attr
->output
, attr
->type
);
455 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
)
458 nr_stream_fds
= ustctl_get_nr_stream_per_channel();
459 stream_fds
= zmalloc(nr_stream_fds
* sizeof(*stream_fds
));
464 for (i
= 0; i
< nr_stream_fds
; i
++) {
465 stream_fds
[i
] = open_ust_stream_fd(channel
, attr
, i
);
466 if (stream_fds
[i
] < 0) {
471 ust_channel
= ustctl_create_channel(attr
, stream_fds
, nr_stream_fds
);
476 channel
->nr_stream_fds
= nr_stream_fds
;
477 channel
->stream_fds
= stream_fds
;
478 *ust_chanp
= ust_channel
;
484 for (j
= i
- 1; j
>= 0; j
--) {
487 closeret
= close(stream_fds
[j
]);
491 if (channel
->shm_path
[0]) {
492 char shm_path
[PATH_MAX
];
494 closeret
= get_stream_shm_path(shm_path
,
495 channel
->shm_path
, j
);
497 ERR("Cannot get stream shm path");
499 closeret
= run_as_unlink(shm_path
,
500 channel
->uid
, channel
->gid
);
502 PERROR("unlink %s", shm_path
);
506 /* Try to rmdir all directories under shm_path root. */
507 if (channel
->root_shm_path
[0]) {
508 (void) run_as_rmdir_recursive(channel
->root_shm_path
,
509 channel
->uid
, channel
->gid
);
517 * Send a single given stream to the session daemon using the sock.
519 * Return 0 on success else a negative value.
521 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
528 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
530 /* Send stream to session daemon. */
531 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
541 * Send channel to sessiond.
543 * Return 0 on success or else a negative value.
545 static int send_sessiond_channel(int sock
,
546 struct lttng_consumer_channel
*channel
,
547 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
549 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
550 struct lttng_consumer_stream
*stream
;
551 uint64_t net_seq_idx
= -1ULL;
557 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
559 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
560 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
562 health_code_update();
564 /* Try to send the stream to the relayd if one is available. */
565 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
568 * Flag that the relayd was the problem here probably due to a
569 * communicaton error on the socket.
574 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
576 if (net_seq_idx
== -1ULL) {
577 net_seq_idx
= stream
->net_seq_idx
;
582 /* Inform sessiond that we are about to send channel and streams. */
583 ret
= consumer_send_status_msg(sock
, ret_code
);
584 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
586 * Either the session daemon is not responding or the relayd died so we
592 /* Send channel to sessiond. */
593 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
598 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
603 /* The channel was sent successfully to the sessiond at this point. */
604 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
606 health_code_update();
608 /* Send stream to session daemon. */
609 ret
= send_sessiond_stream(sock
, stream
);
615 /* Tell sessiond there is no more stream. */
616 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
621 DBG("UST consumer NULL stream sent to sessiond");
626 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
633 * Creates a channel and streams and add the channel it to the channel internal
634 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
637 * Return 0 on success or else, a negative value is returned and the channel
638 * MUST be destroyed by consumer_del_channel().
640 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
641 struct lttng_consumer_channel
*channel
,
642 struct ustctl_consumer_channel_attr
*attr
)
651 * This value is still used by the kernel consumer since for the kernel,
652 * the stream ownership is not IN the consumer so we need to have the
653 * number of left stream that needs to be initialized so we can know when
654 * to delete the channel (see consumer.c).
656 * As for the user space tracer now, the consumer creates and sends the
657 * stream to the session daemon which only sends them to the application
658 * once every stream of a channel is received making this value useless
659 * because we they will be added to the poll thread before the application
660 * receives them. This ensures that a stream can not hang up during
661 * initilization of a channel.
663 channel
->nb_init_stream_left
= 0;
665 /* The reply msg status is handled in the following call. */
666 ret
= create_ust_channel(channel
, attr
, &channel
->uchan
);
671 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
674 * For the snapshots (no monitor), we create the metadata streams
675 * on demand, not during the channel creation.
677 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
682 /* Open all streams for this channel. */
683 ret
= create_ust_streams(channel
, ctx
);
693 * Send all stream of a channel to the right thread handling it.
695 * On error, return a negative value else 0 on success.
697 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
698 struct lttng_consumer_local_data
*ctx
)
701 struct lttng_consumer_stream
*stream
, *stmp
;
706 /* Send streams to the corresponding thread. */
707 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
710 health_code_update();
712 /* Sending the stream to the thread. */
713 ret
= send_stream_to_thread(stream
, ctx
);
716 * If we are unable to send the stream to the thread, there is
717 * a big problem so just stop everything.
728 * Flush channel's streams using the given key to retrieve the channel.
730 * Return 0 on success else an LTTng error code.
732 static int flush_channel(uint64_t chan_key
)
735 struct lttng_consumer_channel
*channel
;
736 struct lttng_consumer_stream
*stream
;
738 struct lttng_ht_iter iter
;
740 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
743 channel
= consumer_find_channel(chan_key
);
745 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
746 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
750 ht
= consumer_data
.stream_per_chan_id_ht
;
752 /* For each stream of the channel id, flush it. */
753 cds_lfht_for_each_entry_duplicate(ht
->ht
,
754 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
755 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
757 health_code_update();
759 pthread_mutex_lock(&stream
->lock
);
760 if (!stream
->quiescent
) {
761 ustctl_flush_buffer(stream
->ustream
, 0);
762 stream
->quiescent
= true;
764 pthread_mutex_unlock(&stream
->lock
);
772 * Clear quiescent state from channel's streams using the given key to
773 * retrieve the channel.
775 * Return 0 on success else an LTTng error code.
777 static int clear_quiescent_channel(uint64_t chan_key
)
780 struct lttng_consumer_channel
*channel
;
781 struct lttng_consumer_stream
*stream
;
783 struct lttng_ht_iter iter
;
785 DBG("UST consumer clear quiescent channel key %" PRIu64
, chan_key
);
788 channel
= consumer_find_channel(chan_key
);
790 ERR("UST consumer clear quiescent channel %" PRIu64
" not found", chan_key
);
791 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
795 ht
= consumer_data
.stream_per_chan_id_ht
;
797 /* For each stream of the channel id, clear quiescent state. */
798 cds_lfht_for_each_entry_duplicate(ht
->ht
,
799 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
800 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
802 health_code_update();
804 pthread_mutex_lock(&stream
->lock
);
805 stream
->quiescent
= false;
806 pthread_mutex_unlock(&stream
->lock
);
814 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
815 * RCU read side lock MUST be acquired before calling this function.
817 * Return 0 on success else an LTTng error code.
819 static int close_metadata(uint64_t chan_key
)
822 struct lttng_consumer_channel
*channel
;
824 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
826 channel
= consumer_find_channel(chan_key
);
829 * This is possible if the metadata thread has issue a delete because
830 * the endpoint point of the stream hung up. There is no way the
831 * session daemon can know about it thus use a DBG instead of an actual
834 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
835 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
839 pthread_mutex_lock(&consumer_data
.lock
);
840 pthread_mutex_lock(&channel
->lock
);
842 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
846 lttng_ustconsumer_close_metadata(channel
);
849 pthread_mutex_unlock(&channel
->lock
);
850 pthread_mutex_unlock(&consumer_data
.lock
);
856 * RCU read side lock MUST be acquired before calling this function.
858 * Return 0 on success else an LTTng error code.
860 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
863 struct lttng_consumer_channel
*metadata
;
865 DBG("UST consumer setup metadata key %" PRIu64
, key
);
867 metadata
= consumer_find_channel(key
);
869 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
870 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
875 * In no monitor mode, the metadata channel has no stream(s) so skip the
876 * ownership transfer to the metadata thread.
878 if (!metadata
->monitor
) {
879 DBG("Metadata channel in no monitor");
885 * Send metadata stream to relayd if one available. Availability is
886 * known if the stream is still in the list of the channel.
888 if (cds_list_empty(&metadata
->streams
.head
)) {
889 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
890 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
891 goto error_no_stream
;
894 /* Send metadata stream to relayd if needed. */
895 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
896 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
899 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
902 ret
= consumer_send_relayd_streams_sent(
903 metadata
->metadata_stream
->net_seq_idx
);
905 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
911 * Ownership of metadata stream is passed along. Freeing is handled by
914 ret
= send_streams_to_thread(metadata
, ctx
);
917 * If we are unable to send the stream to the thread, there is
918 * a big problem so just stop everything.
920 ret
= LTTCOMM_CONSUMERD_FATAL
;
921 goto send_streams_error
;
923 /* List MUST be empty after or else it could be reused. */
924 assert(cds_list_empty(&metadata
->streams
.head
));
931 * Delete metadata channel on error. At this point, the metadata stream can
932 * NOT be monitored by the metadata thread thus having the guarantee that
933 * the stream is still in the local stream list of the channel. This call
934 * will make sure to clean that list.
936 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
937 cds_list_del(&metadata
->metadata_stream
->send_node
);
938 metadata
->metadata_stream
= NULL
;
946 * Snapshot the whole metadata.
948 * Returns 0 on success, < 0 on error
950 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
951 struct lttng_consumer_local_data
*ctx
)
954 struct lttng_consumer_channel
*metadata_channel
;
955 struct lttng_consumer_stream
*metadata_stream
;
960 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
965 metadata_channel
= consumer_find_channel(key
);
966 if (!metadata_channel
) {
967 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
972 assert(!metadata_channel
->monitor
);
974 health_code_update();
977 * Ask the sessiond if we have new metadata waiting and update the
978 * consumer metadata cache.
980 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
985 health_code_update();
988 * The metadata stream is NOT created in no monitor mode when the channel
989 * is created on a sessiond ask channel command.
991 ret
= create_ust_streams(metadata_channel
, ctx
);
996 metadata_stream
= metadata_channel
->metadata_stream
;
997 assert(metadata_stream
);
999 if (relayd_id
!= (uint64_t) -1ULL) {
1000 metadata_stream
->net_seq_idx
= relayd_id
;
1001 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
1006 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
1007 metadata_stream
->chan
->tracefile_size
,
1008 metadata_stream
->tracefile_count_current
,
1009 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
1013 metadata_stream
->out_fd
= ret
;
1014 metadata_stream
->tracefile_size_current
= 0;
1018 health_code_update();
1020 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
1028 * Clean up the stream completly because the next snapshot will use a new
1031 consumer_stream_destroy(metadata_stream
, NULL
);
1032 cds_list_del(&metadata_stream
->send_node
);
1033 metadata_channel
->metadata_stream
= NULL
;
1041 * Take a snapshot of all the stream of a channel.
1043 * Returns 0 on success, < 0 on error
1045 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
1046 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
1049 unsigned use_relayd
= 0;
1050 unsigned long consumed_pos
, produced_pos
;
1051 struct lttng_consumer_channel
*channel
;
1052 struct lttng_consumer_stream
*stream
;
1059 if (relayd_id
!= (uint64_t) -1ULL) {
1063 channel
= consumer_find_channel(key
);
1065 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
1069 assert(!channel
->monitor
);
1070 DBG("UST consumer snapshot channel %" PRIu64
, key
);
1072 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
1073 health_code_update();
1075 /* Lock stream because we are about to change its state. */
1076 pthread_mutex_lock(&stream
->lock
);
1077 stream
->net_seq_idx
= relayd_id
;
1080 ret
= consumer_send_relayd_stream(stream
, path
);
1085 ret
= utils_create_stream_file(path
, stream
->name
,
1086 stream
->chan
->tracefile_size
,
1087 stream
->tracefile_count_current
,
1088 stream
->uid
, stream
->gid
, NULL
);
1092 stream
->out_fd
= ret
;
1093 stream
->tracefile_size_current
= 0;
1095 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
1096 stream
->name
, stream
->key
);
1100 * If tracing is active, we want to perform a "full" buffer flush.
1101 * Else, if quiescent, it has already been done by the prior stop.
1103 if (!stream
->quiescent
) {
1104 ustctl_flush_buffer(stream
->ustream
, 0);
1107 ret
= lttng_ustconsumer_take_snapshot(stream
);
1109 ERR("Taking UST snapshot");
1113 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
1115 ERR("Produced UST snapshot position");
1119 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
1121 ERR("Consumerd UST snapshot position");
1126 * The original value is sent back if max stream size is larger than
1127 * the possible size of the snapshot. Also, we assume that the session
1128 * daemon should never send a maximum stream size that is lower than
1131 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
1132 produced_pos
, nb_packets_per_stream
,
1133 stream
->max_sb_size
);
1135 while (consumed_pos
< produced_pos
) {
1137 unsigned long len
, padded_len
;
1139 health_code_update();
1141 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1143 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1145 if (ret
!= -EAGAIN
) {
1146 PERROR("ustctl_get_subbuf snapshot");
1147 goto error_close_stream
;
1149 DBG("UST consumer get subbuf failed. Skipping it.");
1150 consumed_pos
+= stream
->max_sb_size
;
1151 stream
->chan
->lost_packets
++;
1155 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1157 ERR("Snapshot ustctl_get_subbuf_size");
1158 goto error_put_subbuf
;
1161 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1163 ERR("Snapshot ustctl_get_padded_subbuf_size");
1164 goto error_put_subbuf
;
1167 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1168 padded_len
- len
, NULL
);
1170 if (read_len
!= len
) {
1172 goto error_put_subbuf
;
1175 if (read_len
!= padded_len
) {
1177 goto error_put_subbuf
;
1181 ret
= ustctl_put_subbuf(stream
->ustream
);
1183 ERR("Snapshot ustctl_put_subbuf");
1184 goto error_close_stream
;
1186 consumed_pos
+= stream
->max_sb_size
;
1189 /* Simply close the stream so we can use it on the next snapshot. */
1190 consumer_stream_close(stream
);
1191 pthread_mutex_unlock(&stream
->lock
);
1198 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1199 ERR("Snapshot ustctl_put_subbuf");
1202 consumer_stream_close(stream
);
1204 pthread_mutex_unlock(&stream
->lock
);
1211 * Receive the metadata updates from the sessiond. Supports receiving
1212 * overlapping metadata, but is needs to always belong to a contiguous
1213 * range starting from 0.
1214 * Be careful about the locks held when calling this function: it needs
1215 * the metadata cache flush to concurrently progress in order to
1218 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1219 uint64_t len
, uint64_t version
,
1220 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
1222 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1225 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1227 metadata_str
= zmalloc(len
* sizeof(char));
1228 if (!metadata_str
) {
1229 PERROR("zmalloc metadata string");
1230 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1234 health_code_update();
1236 /* Receive metadata string. */
1237 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1239 /* Session daemon is dead so return gracefully. */
1244 health_code_update();
1246 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1247 ret
= consumer_metadata_cache_write(channel
, offset
, len
, version
,
1250 /* Unable to handle metadata. Notify session daemon. */
1251 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1253 * Skip metadata flush on write error since the offset and len might
1254 * not have been updated which could create an infinite loop below when
1255 * waiting for the metadata cache to be flushed.
1257 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1260 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1265 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1266 DBG("Waiting for metadata to be flushed");
1268 health_code_update();
1270 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1280 * Receive command from session daemon and process it.
1282 * Return 1 on success else a negative value or 0.
1284 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1285 int sock
, struct pollfd
*consumer_sockpoll
)
1288 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1289 struct lttcomm_consumer_msg msg
;
1290 struct lttng_consumer_channel
*channel
= NULL
;
1292 health_code_update();
1294 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1295 if (ret
!= sizeof(msg
)) {
1296 DBG("Consumer received unexpected message size %zd (expects %zu)",
1299 * The ret value might 0 meaning an orderly shutdown but this is ok
1300 * since the caller handles this.
1303 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1309 health_code_update();
1312 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1314 health_code_update();
1316 /* relayd needs RCU read-side lock */
1319 switch (msg
.cmd_type
) {
1320 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1322 /* Session daemon status message are handled in the following call. */
1323 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1324 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1325 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1326 msg
.u
.relayd_sock
.relayd_session_id
);
1329 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1331 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1332 struct consumer_relayd_sock_pair
*relayd
;
1334 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1336 /* Get relayd reference if exists. */
1337 relayd
= consumer_find_relayd(index
);
1338 if (relayd
== NULL
) {
1339 DBG("Unable to find relayd %" PRIu64
, index
);
1340 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1344 * Each relayd socket pair has a refcount of stream attached to it
1345 * which tells if the relayd is still active or not depending on the
1348 * This will set the destroy flag of the relayd object and destroy it
1349 * if the refcount reaches zero when called.
1351 * The destroy can happen either here or when a stream fd hangs up.
1354 consumer_flag_relayd_for_destroy(relayd
);
1357 goto end_msg_sessiond
;
1359 case LTTNG_CONSUMER_UPDATE_STREAM
:
1364 case LTTNG_CONSUMER_DATA_PENDING
:
1366 int ret
, is_data_pending
;
1367 uint64_t id
= msg
.u
.data_pending
.session_id
;
1369 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1371 is_data_pending
= consumer_data_pending(id
);
1373 /* Send back returned value to session daemon */
1374 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1375 sizeof(is_data_pending
));
1377 DBG("Error when sending the data pending ret code: %d", ret
);
1382 * No need to send back a status message since the data pending
1383 * returned value is the response.
1387 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1390 struct ustctl_consumer_channel_attr attr
;
1392 /* Create a plain object and reserve a channel key. */
1393 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1394 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1395 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1396 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1397 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1398 msg
.u
.ask_channel
.tracefile_size
,
1399 msg
.u
.ask_channel
.tracefile_count
,
1400 msg
.u
.ask_channel
.session_id_per_pid
,
1401 msg
.u
.ask_channel
.monitor
,
1402 msg
.u
.ask_channel
.live_timer_interval
,
1403 msg
.u
.ask_channel
.root_shm_path
,
1404 msg
.u
.ask_channel
.shm_path
);
1406 goto end_channel_error
;
1410 * Assign UST application UID to the channel. This value is ignored for
1411 * per PID buffers. This is specific to UST thus setting this after the
1414 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1416 /* Build channel attributes from received message. */
1417 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1418 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1419 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1420 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1421 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1422 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1423 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1424 attr
.blocking_timeout
= msg
.u
.ask_channel
.blocking_timeout
;
1426 /* Match channel buffer type to the UST abi. */
1427 switch (msg
.u
.ask_channel
.output
) {
1428 case LTTNG_EVENT_MMAP
:
1430 attr
.output
= LTTNG_UST_MMAP
;
1434 /* Translate and save channel type. */
1435 switch (msg
.u
.ask_channel
.type
) {
1436 case LTTNG_UST_CHAN_PER_CPU
:
1437 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1438 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1440 * Set refcount to 1 for owner. Below, we will
1441 * pass ownership to the
1442 * consumer_thread_channel_poll() thread.
1444 channel
->refcount
= 1;
1446 case LTTNG_UST_CHAN_METADATA
:
1447 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1448 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1455 health_code_update();
1457 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1459 goto end_channel_error
;
1462 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1463 ret
= consumer_metadata_cache_allocate(channel
);
1465 ERR("Allocating metadata cache");
1466 goto end_channel_error
;
1468 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1469 attr
.switch_timer_interval
= 0;
1471 int monitor_start_ret
;
1473 consumer_timer_live_start(channel
,
1474 msg
.u
.ask_channel
.live_timer_interval
);
1475 monitor_start_ret
= consumer_timer_monitor_start(
1477 msg
.u
.ask_channel
.monitor_timer_interval
);
1478 if (monitor_start_ret
< 0) {
1479 ERR("Starting channel monitoring timer failed");
1480 goto end_channel_error
;
1484 health_code_update();
1487 * Add the channel to the internal state AFTER all streams were created
1488 * and successfully sent to session daemon. This way, all streams must
1489 * be ready before this channel is visible to the threads.
1490 * If add_channel succeeds, ownership of the channel is
1491 * passed to consumer_thread_channel_poll().
1493 ret
= add_channel(channel
, ctx
);
1495 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1496 if (channel
->switch_timer_enabled
== 1) {
1497 consumer_timer_switch_stop(channel
);
1499 consumer_metadata_cache_destroy(channel
);
1501 if (channel
->live_timer_enabled
== 1) {
1502 consumer_timer_live_stop(channel
);
1504 if (channel
->monitor_timer_enabled
== 1) {
1505 consumer_timer_monitor_stop(channel
);
1507 goto end_channel_error
;
1510 health_code_update();
1513 * Channel and streams are now created. Inform the session daemon that
1514 * everything went well and should wait to receive the channel and
1515 * streams with ustctl API.
1517 ret
= consumer_send_status_channel(sock
, channel
);
1520 * There is probably a problem on the socket.
1527 case LTTNG_CONSUMER_GET_CHANNEL
:
1529 int ret
, relayd_err
= 0;
1530 uint64_t key
= msg
.u
.get_channel
.key
;
1531 struct lttng_consumer_channel
*channel
;
1533 channel
= consumer_find_channel(key
);
1535 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1536 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1537 goto end_msg_sessiond
;
1540 health_code_update();
1542 /* Send everything to sessiond. */
1543 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1547 * We were unable to send to the relayd the stream so avoid
1548 * sending back a fatal error to the thread since this is OK
1549 * and the consumer can continue its work. The above call
1550 * has sent the error status message to the sessiond.
1555 * The communicaton was broken hence there is a bad state between
1556 * the consumer and sessiond so stop everything.
1561 health_code_update();
1564 * In no monitor mode, the streams ownership is kept inside the channel
1565 * so don't send them to the data thread.
1567 if (!channel
->monitor
) {
1568 goto end_msg_sessiond
;
1571 ret
= send_streams_to_thread(channel
, ctx
);
1574 * If we are unable to send the stream to the thread, there is
1575 * a big problem so just stop everything.
1579 /* List MUST be empty after or else it could be reused. */
1580 assert(cds_list_empty(&channel
->streams
.head
));
1581 goto end_msg_sessiond
;
1583 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1585 uint64_t key
= msg
.u
.destroy_channel
.key
;
1588 * Only called if streams have not been sent to stream
1589 * manager thread. However, channel has been sent to
1590 * channel manager thread.
1592 notify_thread_del_channel(ctx
, key
);
1593 goto end_msg_sessiond
;
1595 case LTTNG_CONSUMER_CLOSE_METADATA
:
1599 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1604 goto end_msg_sessiond
;
1606 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1610 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1615 goto end_msg_sessiond
;
1617 case LTTNG_CONSUMER_CLEAR_QUIESCENT_CHANNEL
:
1621 ret
= clear_quiescent_channel(
1622 msg
.u
.clear_quiescent_channel
.key
);
1627 goto end_msg_sessiond
;
1629 case LTTNG_CONSUMER_PUSH_METADATA
:
1632 uint64_t len
= msg
.u
.push_metadata
.len
;
1633 uint64_t key
= msg
.u
.push_metadata
.key
;
1634 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1635 uint64_t version
= msg
.u
.push_metadata
.version
;
1636 struct lttng_consumer_channel
*channel
;
1638 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1641 channel
= consumer_find_channel(key
);
1644 * This is possible if the metadata creation on the consumer side
1645 * is in flight vis-a-vis a concurrent push metadata from the
1646 * session daemon. Simply return that the channel failed and the
1647 * session daemon will handle that message correctly considering
1648 * that this race is acceptable thus the DBG() statement here.
1650 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1651 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1652 goto end_msg_sessiond
;
1655 health_code_update();
1659 * There is nothing to receive. We have simply
1660 * checked whether the channel can be found.
1662 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1663 goto end_msg_sessiond
;
1666 /* Tell session daemon we are ready to receive the metadata. */
1667 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1669 /* Somehow, the session daemon is not responding anymore. */
1673 health_code_update();
1675 /* Wait for more data. */
1676 health_poll_entry();
1677 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1683 health_code_update();
1685 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1686 len
, version
, channel
, 0, 1);
1688 /* error receiving from sessiond */
1692 goto end_msg_sessiond
;
1695 case LTTNG_CONSUMER_SETUP_METADATA
:
1699 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1703 goto end_msg_sessiond
;
1705 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1707 if (msg
.u
.snapshot_channel
.metadata
) {
1708 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1709 msg
.u
.snapshot_channel
.pathname
,
1710 msg
.u
.snapshot_channel
.relayd_id
,
1713 ERR("Snapshot metadata failed");
1714 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1717 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1718 msg
.u
.snapshot_channel
.pathname
,
1719 msg
.u
.snapshot_channel
.relayd_id
,
1720 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1723 ERR("Snapshot channel failed");
1724 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1728 health_code_update();
1729 ret
= consumer_send_status_msg(sock
, ret_code
);
1731 /* Somehow, the session daemon is not responding anymore. */
1734 health_code_update();
1737 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
1740 uint64_t discarded_events
;
1741 struct lttng_ht_iter iter
;
1742 struct lttng_ht
*ht
;
1743 struct lttng_consumer_stream
*stream
;
1744 uint64_t id
= msg
.u
.discarded_events
.session_id
;
1745 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
1747 DBG("UST consumer discarded events command for session id %"
1750 pthread_mutex_lock(&consumer_data
.lock
);
1752 ht
= consumer_data
.stream_list_ht
;
1755 * We only need a reference to the channel, but they are not
1756 * directly indexed, so we just use the first matching stream
1757 * to extract the information we need, we default to 0 if not
1758 * found (no events are dropped if the channel is not yet in
1761 discarded_events
= 0;
1762 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1763 ht
->hash_fct(&id
, lttng_ht_seed
),
1765 &iter
.iter
, stream
, node_session_id
.node
) {
1766 if (stream
->chan
->key
== key
) {
1767 discarded_events
= stream
->chan
->discarded_events
;
1771 pthread_mutex_unlock(&consumer_data
.lock
);
1774 DBG("UST consumer discarded events command for session id %"
1775 PRIu64
", channel key %" PRIu64
, id
, key
);
1777 health_code_update();
1779 /* Send back returned value to session daemon */
1780 ret
= lttcomm_send_unix_sock(sock
, &discarded_events
, sizeof(discarded_events
));
1782 PERROR("send discarded events");
1788 case LTTNG_CONSUMER_LOST_PACKETS
:
1791 uint64_t lost_packets
;
1792 struct lttng_ht_iter iter
;
1793 struct lttng_ht
*ht
;
1794 struct lttng_consumer_stream
*stream
;
1795 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1796 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1798 DBG("UST consumer lost packets command for session id %"
1801 pthread_mutex_lock(&consumer_data
.lock
);
1803 ht
= consumer_data
.stream_list_ht
;
1806 * We only need a reference to the channel, but they are not
1807 * directly indexed, so we just use the first matching stream
1808 * to extract the information we need, we default to 0 if not
1809 * found (no packets lost if the channel is not yet in use).
1812 cds_lfht_for_each_entry_duplicate(ht
->ht
,
1813 ht
->hash_fct(&id
, lttng_ht_seed
),
1815 &iter
.iter
, stream
, node_session_id
.node
) {
1816 if (stream
->chan
->key
== key
) {
1817 lost_packets
= stream
->chan
->lost_packets
;
1821 pthread_mutex_unlock(&consumer_data
.lock
);
1824 DBG("UST consumer lost packets command for session id %"
1825 PRIu64
", channel key %" PRIu64
, id
, key
);
1827 health_code_update();
1829 /* Send back returned value to session daemon */
1830 ret
= lttcomm_send_unix_sock(sock
, &lost_packets
,
1831 sizeof(lost_packets
));
1833 PERROR("send lost packets");
1839 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1841 int channel_monitor_pipe
;
1843 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1844 /* Successfully received the command's type. */
1845 ret
= consumer_send_status_msg(sock
, ret_code
);
1850 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1852 if (ret
!= sizeof(channel_monitor_pipe
)) {
1853 ERR("Failed to receive channel monitor pipe");
1857 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1858 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1859 channel_monitor_pipe
);
1863 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1864 /* Set the pipe as non-blocking. */
1865 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1867 PERROR("fcntl get flags of the channel monitoring pipe");
1872 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1873 flags
| O_NONBLOCK
);
1875 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1878 DBG("Channel monitor pipe set as non-blocking");
1880 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1882 goto end_msg_sessiond
;
1891 health_code_update();
1894 * Return 1 to indicate success since the 0 value can be a socket
1895 * shutdown during the recv() or send() call.
1901 * The returned value here is not useful since either way we'll return 1 to
1902 * the caller because the session daemon socket management is done
1903 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1905 ret
= consumer_send_status_msg(sock
, ret_code
);
1911 health_code_update();
1917 * Free channel here since no one has a reference to it. We don't
1918 * free after that because a stream can store this pointer.
1920 destroy_channel(channel
);
1922 /* We have to send a status channel message indicating an error. */
1923 ret
= consumer_send_status_channel(sock
, NULL
);
1925 /* Stop everything if session daemon can not be notified. */
1930 health_code_update();
1935 /* This will issue a consumer stop. */
1940 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1941 * compiled out, we isolate it in this library.
1943 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1947 assert(stream
->ustream
);
1949 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1953 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1954 * compiled out, we isolate it in this library.
1956 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1959 assert(stream
->ustream
);
1961 return ustctl_get_mmap_base(stream
->ustream
);
1965 * Take a snapshot for a specific stream.
1967 * Returns 0 on success, < 0 on error
1969 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1972 assert(stream
->ustream
);
1974 return ustctl_snapshot(stream
->ustream
);
1978 * Sample consumed and produced positions for a specific stream.
1980 * Returns 0 on success, < 0 on error.
1982 int lttng_ustconsumer_sample_snapshot_positions(
1983 struct lttng_consumer_stream
*stream
)
1986 assert(stream
->ustream
);
1988 return ustctl_snapshot_sample_positions(stream
->ustream
);
1992 * Get the produced position
1994 * Returns 0 on success, < 0 on error
1996 int lttng_ustconsumer_get_produced_snapshot(
1997 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2000 assert(stream
->ustream
);
2003 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
2007 * Get the consumed position
2009 * Returns 0 on success, < 0 on error
2011 int lttng_ustconsumer_get_consumed_snapshot(
2012 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
2015 assert(stream
->ustream
);
2018 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
2021 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
2025 assert(stream
->ustream
);
2027 ustctl_flush_buffer(stream
->ustream
, producer
);
2030 int lttng_ustconsumer_get_current_timestamp(
2031 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
2034 assert(stream
->ustream
);
2037 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
2040 int lttng_ustconsumer_get_sequence_number(
2041 struct lttng_consumer_stream
*stream
, uint64_t *seq
)
2044 assert(stream
->ustream
);
2047 return ustctl_get_sequence_number(stream
->ustream
, seq
);
2051 * Called when the stream signals the consumer that it has hung up.
2053 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
2056 assert(stream
->ustream
);
2058 pthread_mutex_lock(&stream
->lock
);
2059 if (!stream
->quiescent
) {
2060 ustctl_flush_buffer(stream
->ustream
, 0);
2061 stream
->quiescent
= true;
2063 pthread_mutex_unlock(&stream
->lock
);
2064 stream
->hangup_flush_done
= 1;
2067 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
2072 assert(chan
->uchan
);
2074 if (chan
->switch_timer_enabled
== 1) {
2075 consumer_timer_switch_stop(chan
);
2077 for (i
= 0; i
< chan
->nr_stream_fds
; i
++) {
2080 ret
= close(chan
->stream_fds
[i
]);
2084 if (chan
->shm_path
[0]) {
2085 char shm_path
[PATH_MAX
];
2087 ret
= get_stream_shm_path(shm_path
, chan
->shm_path
, i
);
2089 ERR("Cannot get stream shm path");
2091 ret
= run_as_unlink(shm_path
, chan
->uid
, chan
->gid
);
2093 PERROR("unlink %s", shm_path
);
2099 void lttng_ustconsumer_free_channel(struct lttng_consumer_channel
*chan
)
2102 assert(chan
->uchan
);
2104 consumer_metadata_cache_destroy(chan
);
2105 ustctl_destroy_channel(chan
->uchan
);
2106 /* Try to rmdir all directories under shm_path root. */
2107 if (chan
->root_shm_path
[0]) {
2108 (void) run_as_rmdir_recursive(chan
->root_shm_path
,
2109 chan
->uid
, chan
->gid
);
2111 free(chan
->stream_fds
);
2114 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
2117 assert(stream
->ustream
);
2119 if (stream
->chan
->switch_timer_enabled
== 1) {
2120 consumer_timer_switch_stop(stream
->chan
);
2122 ustctl_destroy_stream(stream
->ustream
);
2125 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
2128 assert(stream
->ustream
);
2130 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
2133 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
2136 assert(stream
->ustream
);
2138 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
2142 * Populate index values of a UST stream. Values are set in big endian order.
2144 * Return 0 on success or else a negative value.
2146 static int get_index_values(struct ctf_packet_index
*index
,
2147 struct ustctl_consumer_stream
*ustream
)
2151 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
2153 PERROR("ustctl_get_timestamp_begin");
2156 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
2158 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
2160 PERROR("ustctl_get_timestamp_end");
2163 index
->timestamp_end
= htobe64(index
->timestamp_end
);
2165 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
2167 PERROR("ustctl_get_events_discarded");
2170 index
->events_discarded
= htobe64(index
->events_discarded
);
2172 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
2174 PERROR("ustctl_get_content_size");
2177 index
->content_size
= htobe64(index
->content_size
);
2179 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
2181 PERROR("ustctl_get_packet_size");
2184 index
->packet_size
= htobe64(index
->packet_size
);
2186 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
2188 PERROR("ustctl_get_stream_id");
2191 index
->stream_id
= htobe64(index
->stream_id
);
2193 ret
= ustctl_get_instance_id(ustream
, &index
->stream_instance_id
);
2195 PERROR("ustctl_get_instance_id");
2198 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
2200 ret
= ustctl_get_sequence_number(ustream
, &index
->packet_seq_num
);
2202 PERROR("ustctl_get_sequence_number");
2205 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
2212 void metadata_stream_reset_cache(struct lttng_consumer_stream
*stream
,
2213 struct consumer_metadata_cache
*cache
)
2215 DBG("Metadata stream update to version %" PRIu64
,
2217 stream
->ust_metadata_pushed
= 0;
2218 stream
->metadata_version
= cache
->version
;
2219 stream
->reset_metadata_flag
= 1;
2223 * Check if the version of the metadata stream and metadata cache match.
2224 * If the cache got updated, reset the metadata stream.
2225 * The stream lock and metadata cache lock MUST be held.
2226 * Return 0 on success, a negative value on error.
2229 int metadata_stream_check_version(struct lttng_consumer_stream
*stream
)
2232 struct consumer_metadata_cache
*cache
= stream
->chan
->metadata_cache
;
2234 if (cache
->version
== stream
->metadata_version
) {
2237 metadata_stream_reset_cache(stream
, cache
);
2244 * Write up to one packet from the metadata cache to the channel.
2246 * Returns the number of bytes pushed in the cache, or a negative value
2250 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
2255 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
2256 ret
= metadata_stream_check_version(stream
);
2260 if (stream
->chan
->metadata_cache
->max_offset
2261 == stream
->ust_metadata_pushed
) {
2266 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
2267 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
2268 stream
->chan
->metadata_cache
->max_offset
2269 - stream
->ust_metadata_pushed
);
2270 assert(write_len
!= 0);
2271 if (write_len
< 0) {
2272 ERR("Writing one metadata packet");
2276 stream
->ust_metadata_pushed
+= write_len
;
2278 assert(stream
->chan
->metadata_cache
->max_offset
>=
2279 stream
->ust_metadata_pushed
);
2283 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
2289 * Sync metadata meaning request them to the session daemon and snapshot to the
2290 * metadata thread can consumer them.
2292 * Metadata stream lock is held here, but we need to release it when
2293 * interacting with sessiond, else we cause a deadlock with live
2294 * awaiting on metadata to be pushed out.
2296 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
2297 * is empty or a negative value on error.
2299 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
2300 struct lttng_consumer_stream
*metadata
)
2308 pthread_mutex_unlock(&metadata
->lock
);
2310 * Request metadata from the sessiond, but don't wait for the flush
2311 * because we locked the metadata thread.
2313 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
2314 pthread_mutex_lock(&metadata
->lock
);
2319 ret
= commit_one_metadata_packet(metadata
);
2322 } else if (ret
> 0) {
2326 ustctl_flush_buffer(metadata
->ustream
, 1);
2327 ret
= ustctl_snapshot(metadata
->ustream
);
2329 if (errno
!= EAGAIN
) {
2330 ERR("Sync metadata, taking UST snapshot");
2333 DBG("No new metadata when syncing them.");
2334 /* No new metadata, exit. */
2340 * After this flush, we still need to extract metadata.
2351 * Return 0 on success else a negative value.
2353 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
2354 struct lttng_consumer_local_data
*ctx
)
2357 struct ustctl_consumer_stream
*ustream
;
2362 ustream
= stream
->ustream
;
2365 * First, we are going to check if there is a new subbuffer available
2366 * before reading the stream wait_fd.
2368 /* Get the next subbuffer */
2369 ret
= ustctl_get_next_subbuf(ustream
);
2371 /* No more data found, flag the stream. */
2372 stream
->has_data
= 0;
2377 ret
= ustctl_put_subbuf(ustream
);
2380 /* This stream still has data. Flag it and wake up the data thread. */
2381 stream
->has_data
= 1;
2383 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
2386 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
2387 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2392 /* The wake up pipe has been notified. */
2393 ctx
->has_wakeup
= 1;
2402 int update_stream_stats(struct lttng_consumer_stream
*stream
)
2405 uint64_t seq
, discarded
;
2407 ret
= ustctl_get_sequence_number(stream
->ustream
, &seq
);
2409 PERROR("ustctl_get_sequence_number");
2413 * Start the sequence when we extract the first packet in case we don't
2414 * start at 0 (for example if a consumer is not connected to the
2415 * session immediately after the beginning).
2417 if (stream
->last_sequence_number
== -1ULL) {
2418 stream
->last_sequence_number
= seq
;
2419 } else if (seq
> stream
->last_sequence_number
) {
2420 stream
->chan
->lost_packets
+= seq
-
2421 stream
->last_sequence_number
- 1;
2423 /* seq <= last_sequence_number */
2424 ERR("Sequence number inconsistent : prev = %" PRIu64
2425 ", current = %" PRIu64
,
2426 stream
->last_sequence_number
, seq
);
2430 stream
->last_sequence_number
= seq
;
2432 ret
= ustctl_get_events_discarded(stream
->ustream
, &discarded
);
2434 PERROR("kernctl_get_events_discarded");
2437 if (discarded
< stream
->last_discarded_events
) {
2439 * Overflow has occurred. We assume only one wrap-around
2442 stream
->chan
->discarded_events
+=
2443 (1ULL << (CAA_BITS_PER_LONG
- 1)) -
2444 stream
->last_discarded_events
+ discarded
;
2446 stream
->chan
->discarded_events
+= discarded
-
2447 stream
->last_discarded_events
;
2449 stream
->last_discarded_events
= discarded
;
2457 * Read subbuffer from the given stream.
2459 * Stream lock MUST be acquired.
2461 * Return 0 on success else a negative value.
2463 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
2464 struct lttng_consumer_local_data
*ctx
)
2466 unsigned long len
, subbuf_size
, padding
;
2467 int err
, write_index
= 1;
2469 struct ustctl_consumer_stream
*ustream
;
2470 struct ctf_packet_index index
;
2473 assert(stream
->ustream
);
2476 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
2479 /* Ease our life for what's next. */
2480 ustream
= stream
->ustream
;
2483 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
2484 * error if we cannot read this one byte (read returns 0), or if the error
2485 * is EAGAIN or EWOULDBLOCK.
2487 * This is only done when the stream is monitored by a thread, before the
2488 * flush is done after a hangup and if the stream is not flagged with data
2489 * since there might be nothing to consume in the wait fd but still have
2490 * data available flagged by the consumer wake up pipe.
2492 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
2496 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
2497 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
2504 /* Get the next subbuffer */
2505 err
= ustctl_get_next_subbuf(ustream
);
2508 * Populate metadata info if the existing info has
2509 * already been read.
2511 if (stream
->metadata_flag
) {
2512 ret
= commit_one_metadata_packet(stream
);
2516 ustctl_flush_buffer(stream
->ustream
, 1);
2520 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
2522 * This is a debug message even for single-threaded consumer,
2523 * because poll() have more relaxed criterions than get subbuf,
2524 * so get_subbuf may fail for short race windows where poll()
2525 * would issue wakeups.
2527 DBG("Reserving sub buffer failed (everything is normal, "
2528 "it is due to concurrency) [ret: %d]", err
);
2531 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
2533 if (!stream
->metadata_flag
) {
2534 index
.offset
= htobe64(stream
->out_fd_offset
);
2535 ret
= get_index_values(&index
, ustream
);
2537 err
= ustctl_put_subbuf(ustream
);
2542 /* Update the stream's sequence and discarded events count. */
2543 ret
= update_stream_stats(stream
);
2545 PERROR("kernctl_get_events_discarded");
2546 err
= ustctl_put_subbuf(ustream
);
2554 /* Get the full padded subbuffer size */
2555 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2558 /* Get subbuffer data size (without padding) */
2559 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2562 /* Make sure we don't get a subbuffer size bigger than the padded */
2563 assert(len
>= subbuf_size
);
2565 padding
= len
- subbuf_size
;
2566 /* write the subbuffer to the tracefile */
2567 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2569 * The mmap operation should write subbuf_size amount of data when network
2570 * streaming or the full padding (len) size when we are _not_ streaming.
2572 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2573 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2575 * Display the error but continue processing to try to release the
2576 * subbuffer. This is a DBG statement since any unexpected kill or
2577 * signal, the application gets unregistered, relayd gets closed or
2578 * anything that affects the buffer lifetime will trigger this error.
2579 * So, for the sake of the user, don't print this error since it can
2580 * happen and it is OK with the code flow.
2582 DBG("Error writing to tracefile "
2583 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2584 ret
, len
, subbuf_size
);
2587 err
= ustctl_put_next_subbuf(ustream
);
2591 * This will consumer the byte on the wait_fd if and only if there is not
2592 * next subbuffer to be acquired.
2594 if (!stream
->metadata_flag
) {
2595 ret
= notify_if_more_data(stream
, ctx
);
2601 /* Write index if needed. */
2606 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2608 * In live, block until all the metadata is sent.
2610 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2611 assert(!stream
->missed_metadata_flush
);
2612 stream
->waiting_on_metadata
= true;
2613 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2615 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2617 pthread_mutex_lock(&stream
->metadata_timer_lock
);
2618 stream
->waiting_on_metadata
= false;
2619 if (stream
->missed_metadata_flush
) {
2620 stream
->missed_metadata_flush
= false;
2621 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2622 (void) consumer_flush_ust_index(stream
);
2624 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
2632 assert(!stream
->metadata_flag
);
2633 err
= consumer_stream_write_index(stream
, &index
);
2643 * Called when a stream is created.
2645 * Return 0 on success or else a negative value.
2647 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2653 /* Don't create anything if this is set for streaming. */
2654 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2655 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2656 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2657 stream
->uid
, stream
->gid
, NULL
);
2661 stream
->out_fd
= ret
;
2662 stream
->tracefile_size_current
= 0;
2664 if (!stream
->metadata_flag
) {
2665 struct lttng_index_file
*index_file
;
2667 index_file
= lttng_index_file_create(stream
->chan
->pathname
,
2668 stream
->name
, stream
->uid
, stream
->gid
,
2669 stream
->chan
->tracefile_size
,
2670 stream
->tracefile_count_current
,
2671 CTF_INDEX_MAJOR
, CTF_INDEX_MINOR
);
2675 assert(!stream
->index_file
);
2676 stream
->index_file
= index_file
;
2686 * Check if data is still being extracted from the buffers for a specific
2687 * stream. Consumer data lock MUST be acquired before calling this function
2688 * and the stream lock.
2690 * Return 1 if the traced data are still getting read else 0 meaning that the
2691 * data is available for trace viewer reading.
2693 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2698 assert(stream
->ustream
);
2700 DBG("UST consumer checking data pending");
2702 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2707 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2708 uint64_t contiguous
, pushed
;
2710 /* Ease our life a bit. */
2711 contiguous
= stream
->chan
->metadata_cache
->max_offset
;
2712 pushed
= stream
->ust_metadata_pushed
;
2715 * We can simply check whether all contiguously available data
2716 * has been pushed to the ring buffer, since the push operation
2717 * is performed within get_next_subbuf(), and because both
2718 * get_next_subbuf() and put_next_subbuf() are issued atomically
2719 * thanks to the stream lock within
2720 * lttng_ustconsumer_read_subbuffer(). This basically means that
2721 * whetnever ust_metadata_pushed is incremented, the associated
2722 * metadata has been consumed from the metadata stream.
2724 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2725 contiguous
, pushed
);
2726 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2727 if ((contiguous
!= pushed
) ||
2728 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2729 ret
= 1; /* Data is pending */
2733 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2736 * There is still data so let's put back this
2739 ret
= ustctl_put_subbuf(stream
->ustream
);
2741 ret
= 1; /* Data is pending */
2746 /* Data is NOT pending so ready to be read. */
2754 * Stop a given metadata channel timer if enabled and close the wait fd which
2755 * is the poll pipe of the metadata stream.
2757 * This MUST be called with the metadata channel acquired.
2759 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2764 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2766 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2768 if (metadata
->switch_timer_enabled
== 1) {
2769 consumer_timer_switch_stop(metadata
);
2772 if (!metadata
->metadata_stream
) {
2777 * Closing write side so the thread monitoring the stream wakes up if any
2778 * and clean the metadata stream.
2780 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2781 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2783 PERROR("closing metadata pipe write side");
2785 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2793 * Close every metadata stream wait fd of the metadata hash table. This
2794 * function MUST be used very carefully so not to run into a race between the
2795 * metadata thread handling streams and this function closing their wait fd.
2797 * For UST, this is used when the session daemon hangs up. Its the metadata
2798 * producer so calling this is safe because we are assured that no state change
2799 * can occur in the metadata thread for the streams in the hash table.
2801 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2803 struct lttng_ht_iter iter
;
2804 struct lttng_consumer_stream
*stream
;
2806 assert(metadata_ht
);
2807 assert(metadata_ht
->ht
);
2809 DBG("UST consumer closing all metadata streams");
2812 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2815 health_code_update();
2817 pthread_mutex_lock(&stream
->chan
->lock
);
2818 lttng_ustconsumer_close_metadata(stream
->chan
);
2819 pthread_mutex_unlock(&stream
->chan
->lock
);
2825 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2829 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2831 ERR("Unable to close wakeup fd");
2836 * Please refer to consumer-timer.c before adding any lock within this
2837 * function or any of its callees. Timers have a very strict locking
2838 * semantic with respect to teardown. Failure to respect this semantic
2839 * introduces deadlocks.
2841 * DON'T hold the metadata lock when calling this function, else this
2842 * can cause deadlock involving consumer awaiting for metadata to be
2843 * pushed out due to concurrent interaction with the session daemon.
2845 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2846 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2848 struct lttcomm_metadata_request_msg request
;
2849 struct lttcomm_consumer_msg msg
;
2850 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2851 uint64_t len
, key
, offset
, version
;
2855 assert(channel
->metadata_cache
);
2857 memset(&request
, 0, sizeof(request
));
2859 /* send the metadata request to sessiond */
2860 switch (consumer_data
.type
) {
2861 case LTTNG_CONSUMER64_UST
:
2862 request
.bits_per_long
= 64;
2864 case LTTNG_CONSUMER32_UST
:
2865 request
.bits_per_long
= 32;
2868 request
.bits_per_long
= 0;
2872 request
.session_id
= channel
->session_id
;
2873 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2875 * Request the application UID here so the metadata of that application can
2876 * be sent back. The channel UID corresponds to the user UID of the session
2877 * used for the rights on the stream file(s).
2879 request
.uid
= channel
->ust_app_uid
;
2880 request
.key
= channel
->key
;
2882 DBG("Sending metadata request to sessiond, session id %" PRIu64
2883 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2884 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2887 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2889 health_code_update();
2891 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2894 ERR("Asking metadata to sessiond");
2898 health_code_update();
2900 /* Receive the metadata from sessiond */
2901 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2903 if (ret
!= sizeof(msg
)) {
2904 DBG("Consumer received unexpected message size %d (expects %zu)",
2906 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2908 * The ret value might 0 meaning an orderly shutdown but this is ok
2909 * since the caller handles this.
2914 health_code_update();
2916 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2917 /* No registry found */
2918 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2922 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2923 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2928 len
= msg
.u
.push_metadata
.len
;
2929 key
= msg
.u
.push_metadata
.key
;
2930 offset
= msg
.u
.push_metadata
.target_offset
;
2931 version
= msg
.u
.push_metadata
.version
;
2933 assert(key
== channel
->key
);
2935 DBG("No new metadata to receive for key %" PRIu64
, key
);
2938 health_code_update();
2940 /* Tell session daemon we are ready to receive the metadata. */
2941 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2942 LTTCOMM_CONSUMERD_SUCCESS
);
2943 if (ret
< 0 || len
== 0) {
2945 * Somehow, the session daemon is not responding anymore or there is
2946 * nothing to receive.
2951 health_code_update();
2953 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2954 key
, offset
, len
, version
, channel
, timer
, wait
);
2957 * Only send the status msg if the sessiond is alive meaning a positive
2960 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2965 health_code_update();
2967 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2972 * Return the ustctl call for the get stream id.
2974 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2975 uint64_t *stream_id
)
2980 return ustctl_get_stream_id(stream
->ustream
, stream_id
);