2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License, version 2 only,
7 * as published by the Free Software Foundation.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License along
15 * with this program; if not, write to the Free Software Foundation, Inc.,
16 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #include <lttng/ust-ctl.h>
27 #include <sys/socket.h>
29 #include <sys/types.h>
32 #include <urcu/list.h>
35 #include <common/common.h>
36 #include <common/sessiond-comm/sessiond-comm.h>
37 #include <common/relayd/relayd.h>
38 #include <common/compat/fcntl.h>
39 #include <common/consumer-metadata-cache.h>
40 #include <common/consumer-stream.h>
41 #include <common/consumer-timer.h>
42 #include <common/utils.h>
44 #include "ust-consumer.h"
46 extern struct lttng_consumer_global_data consumer_data
;
47 extern int consumer_poll_timeout
;
48 extern volatile int consumer_quit
;
51 * Free channel object and all streams associated with it. This MUST be used
52 * only and only if the channel has _NEVER_ been added to the global channel
55 static void destroy_channel(struct lttng_consumer_channel
*channel
)
57 struct lttng_consumer_stream
*stream
, *stmp
;
61 DBG("UST consumer cleaning stream list");
63 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
65 cds_list_del(&stream
->send_node
);
66 ustctl_destroy_stream(stream
->ustream
);
71 * If a channel is available meaning that was created before the streams
75 lttng_ustconsumer_del_channel(channel
);
81 * Add channel to internal consumer state.
83 * Returns 0 on success or else a negative value.
85 static int add_channel(struct lttng_consumer_channel
*channel
,
86 struct lttng_consumer_local_data
*ctx
)
93 if (ctx
->on_recv_channel
!= NULL
) {
94 ret
= ctx
->on_recv_channel(channel
);
96 ret
= consumer_add_channel(channel
, ctx
);
98 /* Most likely an ENOMEM. */
99 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
103 ret
= consumer_add_channel(channel
, ctx
);
106 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
113 * Allocate and return a consumer channel object.
115 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
116 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
117 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
118 uint64_t tracefile_size
, uint64_t tracefile_count
,
119 uint64_t session_id_per_pid
, unsigned int monitor
)
124 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
125 gid
, relayd_id
, output
, tracefile_size
,
126 tracefile_count
, session_id_per_pid
, monitor
);
130 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
131 * error value if applicable is set in it else it is kept untouched.
133 * Return NULL on error else the newly allocated stream object.
135 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
136 struct lttng_consumer_channel
*channel
,
137 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
140 struct lttng_consumer_stream
*stream
= NULL
;
145 stream
= consumer_allocate_stream(channel
->key
,
147 LTTNG_CONSUMER_ACTIVE_STREAM
,
157 if (stream
== NULL
) {
161 * We could not find the channel. Can happen if cpu hotplug
162 * happens while tearing down.
164 DBG3("Could not find channel");
169 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
175 stream
->chan
= channel
;
179 *_alloc_ret
= alloc_ret
;
185 * Send the given stream pointer to the corresponding thread.
187 * Returns 0 on success else a negative value.
189 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
190 struct lttng_consumer_local_data
*ctx
)
193 struct lttng_pipe
*stream_pipe
;
195 /* Get the right pipe where the stream will be sent. */
196 if (stream
->metadata_flag
) {
197 stream_pipe
= ctx
->consumer_metadata_pipe
;
199 stream_pipe
= ctx
->consumer_data_pipe
;
202 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
204 ERR("Consumer write %s stream to pipe %d",
205 stream
->metadata_flag
? "metadata" : "data",
206 lttng_pipe_get_writefd(stream_pipe
));
213 * Create streams for the given channel using liblttng-ust-ctl.
215 * Return 0 on success else a negative value.
217 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
218 struct lttng_consumer_local_data
*ctx
)
221 struct ustctl_consumer_stream
*ustream
;
222 struct lttng_consumer_stream
*stream
;
228 * While a stream is available from ustctl. When NULL is returned, we've
229 * reached the end of the possible stream for the channel.
231 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
233 int ust_metadata_pipe
[2];
235 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
236 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
238 ERR("Create ust metadata poll pipe");
241 wait_fd
= ust_metadata_pipe
[0];
243 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
246 /* Allocate consumer stream object. */
247 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
251 stream
->ustream
= ustream
;
253 * Store it so we can save multiple function calls afterwards since
254 * this value is used heavily in the stream threads. This is UST
255 * specific so this is why it's done after allocation.
257 stream
->wait_fd
= wait_fd
;
260 * Increment channel refcount since the channel reference has now been
261 * assigned in the allocation process above.
263 if (stream
->chan
->monitor
) {
264 uatomic_inc(&stream
->chan
->refcount
);
268 * Order is important this is why a list is used. On error, the caller
269 * should clean this list.
271 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
273 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
274 &stream
->max_sb_size
);
276 ERR("ustctl_get_max_subbuf_size failed for stream %s",
281 /* Do actions once stream has been received. */
282 if (ctx
->on_recv_stream
) {
283 ret
= ctx
->on_recv_stream(stream
);
289 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
290 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
292 /* Set next CPU stream. */
293 channel
->streams
.count
= ++cpu
;
295 /* Keep stream reference when creating metadata. */
296 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
297 channel
->metadata_stream
= stream
;
298 stream
->ust_metadata_poll_pipe
[0] = ust_metadata_pipe
[0];
299 stream
->ust_metadata_poll_pipe
[1] = ust_metadata_pipe
[1];
311 * Create an UST channel with the given attributes and send it to the session
312 * daemon using the ust ctl API.
314 * Return 0 on success or else a negative value.
316 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
317 struct ustctl_consumer_channel
**chanp
)
320 struct ustctl_consumer_channel
*channel
;
325 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
326 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
327 "switch_timer_interval: %u, read_timer_interval: %u, "
328 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
329 attr
->num_subbuf
, attr
->switch_timer_interval
,
330 attr
->read_timer_interval
, attr
->output
, attr
->type
);
332 channel
= ustctl_create_channel(attr
);
347 * Send a single given stream to the session daemon using the sock.
349 * Return 0 on success else a negative value.
351 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
358 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
360 /* Send stream to session daemon. */
361 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
371 * Send channel to sessiond.
373 * Return 0 on success or else a negative value.
375 static int send_sessiond_channel(int sock
,
376 struct lttng_consumer_channel
*channel
,
377 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
379 int ret
, ret_code
= LTTNG_OK
;
380 struct lttng_consumer_stream
*stream
;
386 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
388 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
389 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
390 /* Try to send the stream to the relayd if one is available. */
391 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
394 * Flag that the relayd was the problem here probably due to a
395 * communicaton error on the socket.
400 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
405 /* Inform sessiond that we are about to send channel and streams. */
406 ret
= consumer_send_status_msg(sock
, ret_code
);
407 if (ret
< 0 || ret_code
!= LTTNG_OK
) {
409 * Either the session daemon is not responding or the relayd died so we
415 /* Send channel to sessiond. */
416 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
421 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
426 /* The channel was sent successfully to the sessiond at this point. */
427 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
428 /* Send stream to session daemon. */
429 ret
= send_sessiond_stream(sock
, stream
);
435 /* Tell sessiond there is no more stream. */
436 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
441 DBG("UST consumer NULL stream sent to sessiond");
446 if (ret_code
!= LTTNG_OK
) {
453 * Creates a channel and streams and add the channel it to the channel internal
454 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
457 * Return 0 on success or else, a negative value is returned and the channel
458 * MUST be destroyed by consumer_del_channel().
460 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
461 struct lttng_consumer_channel
*channel
,
462 struct ustctl_consumer_channel_attr
*attr
)
471 * This value is still used by the kernel consumer since for the kernel,
472 * the stream ownership is not IN the consumer so we need to have the
473 * number of left stream that needs to be initialized so we can know when
474 * to delete the channel (see consumer.c).
476 * As for the user space tracer now, the consumer creates and sends the
477 * stream to the session daemon which only sends them to the application
478 * once every stream of a channel is received making this value useless
479 * because we they will be added to the poll thread before the application
480 * receives them. This ensures that a stream can not hang up during
481 * initilization of a channel.
483 channel
->nb_init_stream_left
= 0;
485 /* The reply msg status is handled in the following call. */
486 ret
= create_ust_channel(attr
, &channel
->uchan
);
491 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
494 * For the snapshots (no monitor), we create the metadata streams
495 * on demand, not during the channel creation.
497 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
502 /* Open all streams for this channel. */
503 ret
= create_ust_streams(channel
, ctx
);
513 * Send all stream of a channel to the right thread handling it.
515 * On error, return a negative value else 0 on success.
517 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
518 struct lttng_consumer_local_data
*ctx
)
521 struct lttng_consumer_stream
*stream
, *stmp
;
526 /* Send streams to the corresponding thread. */
527 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
529 /* Sending the stream to the thread. */
530 ret
= send_stream_to_thread(stream
, ctx
);
533 * If we are unable to send the stream to the thread, there is
534 * a big problem so just stop everything.
539 /* Remove node from the channel stream list. */
540 cds_list_del(&stream
->send_node
);
543 * From this point on, the stream's ownership has been moved away from
544 * the channel and becomes globally visible.
546 stream
->globally_visible
= 1;
554 * Write metadata to the given channel using ustctl to convert the string to
556 * Called only from consumer_metadata_cache_write.
557 * The metadata cache lock MUST be acquired to write in the cache.
559 * Return 0 on success else a negative value.
561 int lttng_ustconsumer_push_metadata(struct lttng_consumer_channel
*metadata
,
562 const char *metadata_str
, uint64_t target_offset
, uint64_t len
)
567 assert(metadata_str
);
569 DBG("UST consumer writing metadata to channel %s", metadata
->name
);
571 if (!metadata
->metadata_stream
) {
576 assert(target_offset
<= metadata
->metadata_cache
->max_offset
);
577 ret
= ustctl_write_metadata_to_channel(metadata
->uchan
,
578 metadata_str
+ target_offset
, len
);
580 ERR("ustctl write metadata fail with ret %d, len %" PRIu64
, ret
, len
);
584 ustctl_flush_buffer(metadata
->metadata_stream
->ustream
, 1);
591 * Flush channel's streams using the given key to retrieve the channel.
593 * Return 0 on success else an LTTng error code.
595 static int flush_channel(uint64_t chan_key
)
598 struct lttng_consumer_channel
*channel
;
599 struct lttng_consumer_stream
*stream
;
601 struct lttng_ht_iter iter
;
603 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
606 channel
= consumer_find_channel(chan_key
);
608 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
609 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
613 ht
= consumer_data
.stream_per_chan_id_ht
;
615 /* For each stream of the channel id, flush it. */
616 cds_lfht_for_each_entry_duplicate(ht
->ht
,
617 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
618 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
619 ustctl_flush_buffer(stream
->ustream
, 1);
627 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
628 * RCU read side lock MUST be acquired before calling this function.
630 * Return 0 on success else an LTTng error code.
632 static int close_metadata(uint64_t chan_key
)
635 struct lttng_consumer_channel
*channel
;
637 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
639 channel
= consumer_find_channel(chan_key
);
642 * This is possible if the metadata thread has issue a delete because
643 * the endpoint point of the stream hung up. There is no way the
644 * session daemon can know about it thus use a DBG instead of an actual
647 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
648 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
652 pthread_mutex_lock(&consumer_data
.lock
);
653 pthread_mutex_lock(&channel
->lock
);
655 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
659 if (channel
->switch_timer_enabled
== 1) {
660 DBG("Deleting timer on metadata channel");
661 consumer_timer_switch_stop(channel
);
664 if (channel
->metadata_stream
) {
665 ret
= ustctl_stream_close_wakeup_fd(channel
->metadata_stream
->ustream
);
667 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret
);
668 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
671 if (channel
->monitor
) {
672 /* close the read-side in consumer_del_metadata_stream */
673 ret
= close(channel
->metadata_stream
->ust_metadata_poll_pipe
[1]);
675 PERROR("Close UST metadata write-side poll pipe");
681 pthread_mutex_unlock(&channel
->lock
);
682 pthread_mutex_unlock(&consumer_data
.lock
);
688 * RCU read side lock MUST be acquired before calling this function.
690 * Return 0 on success else an LTTng error code.
692 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
695 struct lttng_consumer_channel
*metadata
;
697 DBG("UST consumer setup metadata key %" PRIu64
, key
);
699 metadata
= consumer_find_channel(key
);
701 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
702 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
707 * In no monitor mode, the metadata channel has no stream(s) so skip the
708 * ownership transfer to the metadata thread.
710 if (!metadata
->monitor
) {
711 DBG("Metadata channel in no monitor");
717 * Send metadata stream to relayd if one available. Availability is
718 * known if the stream is still in the list of the channel.
720 if (cds_list_empty(&metadata
->streams
.head
)) {
721 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
722 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
723 goto error_no_stream
;
726 /* Send metadata stream to relayd if needed. */
727 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
728 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
731 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
736 ret
= send_streams_to_thread(metadata
, ctx
);
739 * If we are unable to send the stream to the thread, there is
740 * a big problem so just stop everything.
742 ret
= LTTCOMM_CONSUMERD_FATAL
;
745 /* List MUST be empty after or else it could be reused. */
746 assert(cds_list_empty(&metadata
->streams
.head
));
753 * Delete metadata channel on error. At this point, the metadata stream can
754 * NOT be monitored by the metadata thread thus having the guarantee that
755 * the stream is still in the local stream list of the channel. This call
756 * will make sure to clean that list.
758 cds_list_del(&metadata
->metadata_stream
->send_node
);
759 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
766 * Snapshot the whole metadata.
768 * Returns 0 on success, < 0 on error
770 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
771 struct lttng_consumer_local_data
*ctx
)
774 struct lttng_consumer_channel
*metadata_channel
;
775 struct lttng_consumer_stream
*metadata_stream
;
780 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
785 metadata_channel
= consumer_find_channel(key
);
786 if (!metadata_channel
) {
787 ERR("UST snapshot metadata channel not found for key %lu", key
);
791 assert(!metadata_channel
->monitor
);
794 * Ask the sessiond if we have new metadata waiting and update the
795 * consumer metadata cache.
797 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
);
803 * The metadata stream is NOT created in no monitor mode when the channel
804 * is created on a sessiond ask channel command.
806 ret
= create_ust_streams(metadata_channel
, ctx
);
811 metadata_stream
= metadata_channel
->metadata_stream
;
812 assert(metadata_stream
);
814 if (relayd_id
!= (uint64_t) -1ULL) {
815 metadata_stream
->net_seq_idx
= relayd_id
;
816 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
821 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
822 metadata_stream
->chan
->tracefile_size
,
823 metadata_stream
->tracefile_count_current
,
824 metadata_stream
->uid
, metadata_stream
->gid
);
828 metadata_stream
->out_fd
= ret
;
829 metadata_stream
->tracefile_size_current
= 0;
832 pthread_mutex_lock(&metadata_channel
->metadata_cache
->lock
);
835 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
842 pthread_mutex_unlock(&metadata_channel
->metadata_cache
->lock
);
846 * Clean up the stream completly because the next snapshot will use a new
849 cds_list_del(&metadata_stream
->send_node
);
850 consumer_stream_destroy(metadata_stream
, NULL
);
851 metadata_channel
->metadata_stream
= NULL
;
859 * Take a snapshot of all the stream of a channel.
861 * Returns 0 on success, < 0 on error
863 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
864 uint64_t max_stream_size
, struct lttng_consumer_local_data
*ctx
)
867 unsigned use_relayd
= 0;
868 unsigned long consumed_pos
, produced_pos
;
869 struct lttng_consumer_channel
*channel
;
870 struct lttng_consumer_stream
*stream
;
877 if (relayd_id
!= (uint64_t) -1ULL) {
881 channel
= consumer_find_channel(key
);
883 ERR("UST snapshot channel not found for key %lu", key
);
887 assert(!channel
->monitor
);
888 DBG("UST consumer snapshot channel %lu", key
);
890 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
891 /* Lock stream because we are about to change its state. */
892 pthread_mutex_lock(&stream
->lock
);
893 stream
->net_seq_idx
= relayd_id
;
896 ret
= consumer_send_relayd_stream(stream
, path
);
901 ret
= utils_create_stream_file(path
, stream
->name
,
902 stream
->chan
->tracefile_size
,
903 stream
->tracefile_count_current
,
904 stream
->uid
, stream
->gid
);
908 stream
->out_fd
= ret
;
909 stream
->tracefile_size_current
= 0;
911 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
912 stream
->name
, stream
->key
);
915 ustctl_flush_buffer(stream
->ustream
, 1);
917 ret
= lttng_ustconsumer_take_snapshot(stream
);
919 ERR("Taking UST snapshot");
923 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
925 ERR("Produced UST snapshot position");
929 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
931 ERR("Consumerd UST snapshot position");
936 * The original value is sent back if max stream size is larger than
937 * the possible size of the snapshot. Also, we asume that the session
938 * daemon should never send a maximum stream size that is lower than
941 consumed_pos
= consumer_get_consumed_maxsize(consumed_pos
,
942 produced_pos
, max_stream_size
);
944 while (consumed_pos
< produced_pos
) {
946 unsigned long len
, padded_len
;
948 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
950 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
952 if (ret
!= -EAGAIN
) {
953 PERROR("ustctl_get_subbuf snapshot");
954 goto error_close_stream
;
956 DBG("UST consumer get subbuf failed. Skipping it.");
957 consumed_pos
+= stream
->max_sb_size
;
961 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
963 ERR("Snapshot ustctl_get_subbuf_size");
964 goto error_put_subbuf
;
967 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
969 ERR("Snapshot ustctl_get_padded_subbuf_size");
970 goto error_put_subbuf
;
973 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
976 if (read_len
!= len
) {
978 goto error_put_subbuf
;
981 if (read_len
!= padded_len
) {
983 goto error_put_subbuf
;
987 ret
= ustctl_put_subbuf(stream
->ustream
);
989 ERR("Snapshot ustctl_put_subbuf");
990 goto error_close_stream
;
992 consumed_pos
+= stream
->max_sb_size
;
995 /* Simply close the stream so we can use it on the next snapshot. */
996 consumer_stream_close(stream
);
997 pthread_mutex_unlock(&stream
->lock
);
1004 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1005 ERR("Snapshot ustctl_put_subbuf");
1008 consumer_stream_close(stream
);
1010 pthread_mutex_unlock(&stream
->lock
);
1017 * Receive the metadata updates from the sessiond.
1019 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1020 uint64_t len
, struct lttng_consumer_channel
*channel
)
1022 int ret
, ret_code
= LTTNG_OK
;
1025 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1027 metadata_str
= zmalloc(len
* sizeof(char));
1028 if (!metadata_str
) {
1029 PERROR("zmalloc metadata string");
1030 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1034 /* Receive metadata string. */
1035 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1037 /* Session daemon is dead so return gracefully. */
1042 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1043 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1045 /* Unable to handle metadata. Notify session daemon. */
1046 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1048 * Skip metadata flush on write error since the offset and len might
1049 * not have been updated which could create an infinite loop below when
1050 * waiting for the metadata cache to be flushed.
1052 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1055 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1057 while (consumer_metadata_cache_flushed(channel
, offset
+ len
)) {
1058 DBG("Waiting for metadata to be flushed");
1059 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1069 * Receive command from session daemon and process it.
1071 * Return 1 on success else a negative value or 0.
1073 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1074 int sock
, struct pollfd
*consumer_sockpoll
)
1077 enum lttng_error_code ret_code
= LTTNG_OK
;
1078 struct lttcomm_consumer_msg msg
;
1079 struct lttng_consumer_channel
*channel
= NULL
;
1081 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1082 if (ret
!= sizeof(msg
)) {
1083 DBG("Consumer received unexpected message size %zd (expects %zu)",
1086 * The ret value might 0 meaning an orderly shutdown but this is ok
1087 * since the caller handles this.
1090 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1095 if (msg
.cmd_type
== LTTNG_CONSUMER_STOP
) {
1097 * Notify the session daemon that the command is completed.
1099 * On transport layer error, the function call will print an error
1100 * message so handling the returned code is a bit useless since we
1101 * return an error code anyway.
1103 (void) consumer_send_status_msg(sock
, ret_code
);
1107 /* relayd needs RCU read-side lock */
1110 switch (msg
.cmd_type
) {
1111 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1113 /* Session daemon status message are handled in the following call. */
1114 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1115 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1116 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
);
1119 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1121 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1122 struct consumer_relayd_sock_pair
*relayd
;
1124 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1126 /* Get relayd reference if exists. */
1127 relayd
= consumer_find_relayd(index
);
1128 if (relayd
== NULL
) {
1129 DBG("Unable to find relayd %" PRIu64
, index
);
1130 ret_code
= LTTNG_ERR_NO_CONSUMER
;
1134 * Each relayd socket pair has a refcount of stream attached to it
1135 * which tells if the relayd is still active or not depending on the
1138 * This will set the destroy flag of the relayd object and destroy it
1139 * if the refcount reaches zero when called.
1141 * The destroy can happen either here or when a stream fd hangs up.
1144 consumer_flag_relayd_for_destroy(relayd
);
1147 goto end_msg_sessiond
;
1149 case LTTNG_CONSUMER_UPDATE_STREAM
:
1154 case LTTNG_CONSUMER_DATA_PENDING
:
1156 int ret
, is_data_pending
;
1157 uint64_t id
= msg
.u
.data_pending
.session_id
;
1159 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1161 is_data_pending
= consumer_data_pending(id
);
1163 /* Send back returned value to session daemon */
1164 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1165 sizeof(is_data_pending
));
1167 DBG("Error when sending the data pending ret code: %d", ret
);
1172 * No need to send back a status message since the data pending
1173 * returned value is the response.
1177 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1180 struct ustctl_consumer_channel_attr attr
;
1182 /* Create a plain object and reserve a channel key. */
1183 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1184 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1185 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1186 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1187 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1188 msg
.u
.ask_channel
.tracefile_size
,
1189 msg
.u
.ask_channel
.tracefile_count
,
1190 msg
.u
.ask_channel
.session_id_per_pid
,
1191 msg
.u
.ask_channel
.monitor
);
1193 goto end_channel_error
;
1196 /* Build channel attributes from received message. */
1197 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1198 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1199 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1200 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1201 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1202 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1203 attr
.output
= msg
.u
.ask_channel
.output
;
1204 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1206 /* Translate and save channel type. */
1207 switch (msg
.u
.ask_channel
.type
) {
1208 case LTTNG_UST_CHAN_PER_CPU
:
1209 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1210 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1212 * Set refcount to 1 for owner. Below, we will
1213 * pass ownership to the
1214 * consumer_thread_channel_poll() thread.
1216 channel
->refcount
= 1;
1218 case LTTNG_UST_CHAN_METADATA
:
1219 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1220 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1227 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1229 goto end_channel_error
;
1232 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1233 ret
= consumer_metadata_cache_allocate(channel
);
1235 ERR("Allocating metadata cache");
1236 goto end_channel_error
;
1238 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1239 attr
.switch_timer_interval
= 0;
1243 * Add the channel to the internal state AFTER all streams were created
1244 * and successfully sent to session daemon. This way, all streams must
1245 * be ready before this channel is visible to the threads.
1246 * If add_channel succeeds, ownership of the channel is
1247 * passed to consumer_thread_channel_poll().
1249 ret
= add_channel(channel
, ctx
);
1251 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1252 if (channel
->switch_timer_enabled
== 1) {
1253 consumer_timer_switch_stop(channel
);
1255 consumer_metadata_cache_destroy(channel
);
1257 goto end_channel_error
;
1261 * Channel and streams are now created. Inform the session daemon that
1262 * everything went well and should wait to receive the channel and
1263 * streams with ustctl API.
1265 ret
= consumer_send_status_channel(sock
, channel
);
1268 * There is probably a problem on the socket.
1275 case LTTNG_CONSUMER_GET_CHANNEL
:
1277 int ret
, relayd_err
= 0;
1278 uint64_t key
= msg
.u
.get_channel
.key
;
1279 struct lttng_consumer_channel
*channel
;
1281 channel
= consumer_find_channel(key
);
1283 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1284 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1285 goto end_msg_sessiond
;
1288 /* Send everything to sessiond. */
1289 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1293 * We were unable to send to the relayd the stream so avoid
1294 * sending back a fatal error to the thread since this is OK
1295 * and the consumer can continue its work. The above call
1296 * has sent the error status message to the sessiond.
1301 * The communicaton was broken hence there is a bad state between
1302 * the consumer and sessiond so stop everything.
1308 * In no monitor mode, the streams ownership is kept inside the channel
1309 * so don't send them to the data thread.
1311 if (!channel
->monitor
) {
1312 goto end_msg_sessiond
;
1315 ret
= send_streams_to_thread(channel
, ctx
);
1318 * If we are unable to send the stream to the thread, there is
1319 * a big problem so just stop everything.
1323 /* List MUST be empty after or else it could be reused. */
1324 assert(cds_list_empty(&channel
->streams
.head
));
1325 goto end_msg_sessiond
;
1327 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1329 uint64_t key
= msg
.u
.destroy_channel
.key
;
1332 * Only called if streams have not been sent to stream
1333 * manager thread. However, channel has been sent to
1334 * channel manager thread.
1336 notify_thread_del_channel(ctx
, key
);
1337 goto end_msg_sessiond
;
1339 case LTTNG_CONSUMER_CLOSE_METADATA
:
1343 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1348 goto end_msg_sessiond
;
1350 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1354 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1359 goto end_msg_sessiond
;
1361 case LTTNG_CONSUMER_PUSH_METADATA
:
1364 uint64_t len
= msg
.u
.push_metadata
.len
;
1365 uint64_t key
= msg
.u
.push_metadata
.key
;
1366 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1367 struct lttng_consumer_channel
*channel
;
1369 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1372 channel
= consumer_find_channel(key
);
1374 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
1375 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1376 goto end_msg_sessiond
;
1379 /* Tell session daemon we are ready to receive the metadata. */
1380 ret
= consumer_send_status_msg(sock
, LTTNG_OK
);
1382 /* Somehow, the session daemon is not responding anymore. */
1386 /* Wait for more data. */
1387 if (lttng_consumer_poll_socket(consumer_sockpoll
) < 0) {
1391 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1394 /* error receiving from sessiond */
1398 goto end_msg_sessiond
;
1401 case LTTNG_CONSUMER_SETUP_METADATA
:
1405 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1409 goto end_msg_sessiond
;
1411 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1413 if (msg
.u
.snapshot_channel
.metadata
) {
1414 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1415 msg
.u
.snapshot_channel
.pathname
,
1416 msg
.u
.snapshot_channel
.relayd_id
,
1419 ERR("Snapshot metadata failed");
1420 ret_code
= LTTNG_ERR_UST_META_FAIL
;
1423 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1424 msg
.u
.snapshot_channel
.pathname
,
1425 msg
.u
.snapshot_channel
.relayd_id
,
1426 msg
.u
.snapshot_channel
.max_stream_size
,
1429 ERR("Snapshot channel failed");
1430 ret_code
= LTTNG_ERR_UST_CHAN_FAIL
;
1434 ret
= consumer_send_status_msg(sock
, ret_code
);
1436 /* Somehow, the session daemon is not responding anymore. */
1449 * Return 1 to indicate success since the 0 value can be a socket
1450 * shutdown during the recv() or send() call.
1456 * The returned value here is not useful since either way we'll return 1 to
1457 * the caller because the session daemon socket management is done
1458 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1460 ret
= consumer_send_status_msg(sock
, ret_code
);
1469 * Free channel here since no one has a reference to it. We don't
1470 * free after that because a stream can store this pointer.
1472 destroy_channel(channel
);
1474 /* We have to send a status channel message indicating an error. */
1475 ret
= consumer_send_status_channel(sock
, NULL
);
1477 /* Stop everything if session daemon can not be notified. */
1484 /* This will issue a consumer stop. */
1489 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1490 * compiled out, we isolate it in this library.
1492 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1496 assert(stream
->ustream
);
1498 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1502 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1503 * compiled out, we isolate it in this library.
1505 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1508 assert(stream
->ustream
);
1510 return ustctl_get_mmap_base(stream
->ustream
);
1514 * Take a snapshot for a specific fd
1516 * Returns 0 on success, < 0 on error
1518 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1521 assert(stream
->ustream
);
1523 return ustctl_snapshot(stream
->ustream
);
1527 * Get the produced position
1529 * Returns 0 on success, < 0 on error
1531 int lttng_ustconsumer_get_produced_snapshot(
1532 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1535 assert(stream
->ustream
);
1538 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1542 * Get the consumed position
1544 * Returns 0 on success, < 0 on error
1546 int lttng_ustconsumer_get_consumed_snapshot(
1547 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1550 assert(stream
->ustream
);
1553 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1557 * Called when the stream signal the consumer that it has hang up.
1559 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1562 assert(stream
->ustream
);
1564 ustctl_flush_buffer(stream
->ustream
, 0);
1565 stream
->hangup_flush_done
= 1;
1568 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1571 assert(chan
->uchan
);
1573 if (chan
->switch_timer_enabled
== 1) {
1574 consumer_timer_switch_stop(chan
);
1576 consumer_metadata_cache_destroy(chan
);
1577 ustctl_destroy_channel(chan
->uchan
);
1580 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1583 assert(stream
->ustream
);
1585 if (stream
->chan
->switch_timer_enabled
== 1) {
1586 consumer_timer_switch_stop(stream
->chan
);
1588 ustctl_destroy_stream(stream
->ustream
);
1591 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1592 struct lttng_consumer_local_data
*ctx
)
1594 unsigned long len
, subbuf_size
, padding
;
1598 struct ustctl_consumer_stream
*ustream
;
1601 assert(stream
->ustream
);
1604 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1607 /* Ease our life for what's next. */
1608 ustream
= stream
->ustream
;
1610 /* We can consume the 1 byte written into the wait_fd by UST */
1611 if (stream
->monitor
&& !stream
->hangup_flush_done
) {
1615 readlen
= read(stream
->wait_fd
, &dummy
, 1);
1616 } while (readlen
== -1 && errno
== EINTR
);
1617 if (readlen
== -1 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1624 /* Get the next subbuffer */
1625 err
= ustctl_get_next_subbuf(ustream
);
1628 * Populate metadata info if the existing info has
1629 * already been read.
1631 if (stream
->metadata_flag
) {
1634 if (stream
->chan
->metadata_cache
->contiguous
1635 == stream
->ust_metadata_pushed
) {
1640 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1641 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1642 stream
->chan
->metadata_cache
->contiguous
1643 - stream
->ust_metadata_pushed
);
1644 assert(write_len
!= 0);
1645 if (write_len
< 0) {
1646 ERR("Writing one metadata packet");
1650 stream
->ust_metadata_pushed
+= write_len
;
1651 ustctl_flush_buffer(stream
->ustream
, 1);
1655 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1657 * This is a debug message even for single-threaded consumer,
1658 * because poll() have more relaxed criterions than get subbuf,
1659 * so get_subbuf may fail for short race windows where poll()
1660 * would issue wakeups.
1662 DBG("Reserving sub buffer failed (everything is normal, "
1663 "it is due to concurrency) [ret: %d]", err
);
1666 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1667 /* Get the full padded subbuffer size */
1668 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1671 /* Get subbuffer data size (without padding) */
1672 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
1675 /* Make sure we don't get a subbuffer size bigger than the padded */
1676 assert(len
>= subbuf_size
);
1678 padding
= len
- subbuf_size
;
1679 /* write the subbuffer to the tracefile */
1680 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
);
1682 * The mmap operation should write subbuf_size amount of data when network
1683 * streaming or the full padding (len) size when we are _not_ streaming.
1685 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1686 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1688 * Display the error but continue processing to try to release the
1689 * subbuffer. This is a DBG statement since any unexpected kill or
1690 * signal, the application gets unregistered, relayd gets closed or
1691 * anything that affects the buffer lifetime will trigger this error.
1692 * So, for the sake of the user, don't print this error since it can
1693 * happen and it is OK with the code flow.
1695 DBG("Error writing to tracefile "
1696 "(ret: %ld != len: %lu != subbuf_size: %lu)",
1697 ret
, len
, subbuf_size
);
1699 err
= ustctl_put_next_subbuf(ustream
);
1707 * Called when a stream is created.
1709 * Return 0 on success or else a negative value.
1711 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
1717 /* Don't create anything if this is set for streaming. */
1718 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
1719 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
1720 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
1721 stream
->uid
, stream
->gid
);
1725 stream
->out_fd
= ret
;
1726 stream
->tracefile_size_current
= 0;
1735 * Check if data is still being extracted from the buffers for a specific
1736 * stream. Consumer data lock MUST be acquired before calling this function
1737 * and the stream lock.
1739 * Return 1 if the traced data are still getting read else 0 meaning that the
1740 * data is available for trace viewer reading.
1742 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
1747 assert(stream
->ustream
);
1749 DBG("UST consumer checking data pending");
1751 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
1756 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
1758 * We can simply check whether all contiguously available data
1759 * has been pushed to the ring buffer, since the push operation
1760 * is performed within get_next_subbuf(), and because both
1761 * get_next_subbuf() and put_next_subbuf() are issued atomically
1762 * thanks to the stream lock within
1763 * lttng_ustconsumer_read_subbuffer(). This basically means that
1764 * whetnever ust_metadata_pushed is incremented, the associated
1765 * metadata has been consumed from the metadata stream.
1767 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
1768 stream
->chan
->metadata_cache
->contiguous
,
1769 stream
->ust_metadata_pushed
);
1770 if (stream
->chan
->metadata_cache
->contiguous
1771 != stream
->ust_metadata_pushed
) {
1772 ret
= 1; /* Data is pending */
1776 ret
= ustctl_get_next_subbuf(stream
->ustream
);
1779 * There is still data so let's put back this
1782 ret
= ustctl_put_subbuf(stream
->ustream
);
1784 ret
= 1; /* Data is pending */
1789 /* Data is NOT pending so ready to be read. */
1797 * Close every metadata stream wait fd of the metadata hash table. This
1798 * function MUST be used very carefully so not to run into a race between the
1799 * metadata thread handling streams and this function closing their wait fd.
1801 * For UST, this is used when the session daemon hangs up. Its the metadata
1802 * producer so calling this is safe because we are assured that no state change
1803 * can occur in the metadata thread for the streams in the hash table.
1805 void lttng_ustconsumer_close_metadata(struct lttng_ht
*metadata_ht
)
1808 struct lttng_ht_iter iter
;
1809 struct lttng_consumer_stream
*stream
;
1811 assert(metadata_ht
);
1812 assert(metadata_ht
->ht
);
1814 DBG("UST consumer closing all metadata streams");
1817 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
1819 int fd
= stream
->wait_fd
;
1822 * Whatever happens here we have to continue to try to close every
1823 * streams. Let's report at least the error on failure.
1825 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1827 ERR("Unable to close metadata stream fd %d ret %d", fd
, ret
);
1829 DBG("Metadata wait fd %d closed", fd
);
1834 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
1838 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
1840 ERR("Unable to close wakeup fd");
1844 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
1845 struct lttng_consumer_channel
*channel
)
1847 struct lttcomm_metadata_request_msg request
;
1848 struct lttcomm_consumer_msg msg
;
1849 enum lttng_error_code ret_code
= LTTNG_OK
;
1850 uint64_t len
, key
, offset
;
1854 assert(channel
->metadata_cache
);
1856 /* send the metadata request to sessiond */
1857 switch (consumer_data
.type
) {
1858 case LTTNG_CONSUMER64_UST
:
1859 request
.bits_per_long
= 64;
1861 case LTTNG_CONSUMER32_UST
:
1862 request
.bits_per_long
= 32;
1865 request
.bits_per_long
= 0;
1869 request
.session_id
= channel
->session_id
;
1870 request
.session_id_per_pid
= channel
->session_id_per_pid
;
1871 request
.uid
= channel
->uid
;
1872 request
.key
= channel
->key
;
1873 DBG("Sending metadata request to sessiond, session id %" PRIu64
1874 ", per-pid %" PRIu64
,
1875 channel
->session_id
,
1876 channel
->session_id_per_pid
);
1878 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
1879 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
1882 ERR("Asking metadata to sessiond");
1886 /* Receive the metadata from sessiond */
1887 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
1889 if (ret
!= sizeof(msg
)) {
1890 DBG("Consumer received unexpected message size %d (expects %zu)",
1892 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1894 * The ret value might 0 meaning an orderly shutdown but this is ok
1895 * since the caller handles this.
1900 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
1901 /* No registry found */
1902 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1906 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
1907 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
1912 len
= msg
.u
.push_metadata
.len
;
1913 key
= msg
.u
.push_metadata
.key
;
1914 offset
= msg
.u
.push_metadata
.target_offset
;
1916 assert(key
== channel
->key
);
1918 DBG("No new metadata to receive for key %" PRIu64
, key
);
1921 /* Tell session daemon we are ready to receive the metadata. */
1922 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
1924 if (ret
< 0 || len
== 0) {
1926 * Somehow, the session daemon is not responding anymore or there is
1927 * nothing to receive.
1932 ret_code
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
1933 key
, offset
, len
, channel
);
1934 if (ret_code
>= 0) {
1936 * Only send the status msg if the sessiond is alive meaning a positive
1939 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret_code
);
1944 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);