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.
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-metadata-cache.h>
43 #include <common/consumer-stream.h>
44 #include <common/consumer-timer.h>
45 #include <common/utils.h>
46 #include <common/index/index.h>
48 #include "ust-consumer.h"
50 extern struct lttng_consumer_global_data consumer_data
;
51 extern int consumer_poll_timeout
;
52 extern volatile int consumer_quit
;
55 * Free channel object and all streams associated with it. This MUST be used
56 * only and only if the channel has _NEVER_ been added to the global channel
59 static void destroy_channel(struct lttng_consumer_channel
*channel
)
61 struct lttng_consumer_stream
*stream
, *stmp
;
65 DBG("UST consumer cleaning stream list");
67 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
72 cds_list_del(&stream
->send_node
);
73 ustctl_destroy_stream(stream
->ustream
);
78 * If a channel is available meaning that was created before the streams
82 lttng_ustconsumer_del_channel(channel
);
88 * Add channel to internal consumer state.
90 * Returns 0 on success or else a negative value.
92 static int add_channel(struct lttng_consumer_channel
*channel
,
93 struct lttng_consumer_local_data
*ctx
)
100 if (ctx
->on_recv_channel
!= NULL
) {
101 ret
= ctx
->on_recv_channel(channel
);
103 ret
= consumer_add_channel(channel
, ctx
);
104 } else if (ret
< 0) {
105 /* Most likely an ENOMEM. */
106 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
110 ret
= consumer_add_channel(channel
, ctx
);
113 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
120 * Allocate and return a consumer channel object.
122 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
123 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
124 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
125 uint64_t tracefile_size
, uint64_t tracefile_count
,
126 uint64_t session_id_per_pid
, unsigned int monitor
,
127 unsigned int live_timer_interval
,
128 const char *shm_path
)
133 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
134 gid
, relayd_id
, output
, tracefile_size
,
135 tracefile_count
, session_id_per_pid
, monitor
,
136 live_timer_interval
, shm_path
);
140 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
141 * error value if applicable is set in it else it is kept untouched.
143 * Return NULL on error else the newly allocated stream object.
145 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
146 struct lttng_consumer_channel
*channel
,
147 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
150 struct lttng_consumer_stream
*stream
= NULL
;
155 stream
= consumer_allocate_stream(channel
->key
,
157 LTTNG_CONSUMER_ACTIVE_STREAM
,
167 if (stream
== NULL
) {
171 * We could not find the channel. Can happen if cpu hotplug
172 * happens while tearing down.
174 DBG3("Could not find channel");
179 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
185 stream
->chan
= channel
;
189 *_alloc_ret
= alloc_ret
;
195 * Send the given stream pointer to the corresponding thread.
197 * Returns 0 on success else a negative value.
199 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
200 struct lttng_consumer_local_data
*ctx
)
203 struct lttng_pipe
*stream_pipe
;
205 /* Get the right pipe where the stream will be sent. */
206 if (stream
->metadata_flag
) {
207 ret
= consumer_add_metadata_stream(stream
);
209 ERR("Consumer add metadata stream %" PRIu64
" failed.",
213 stream_pipe
= ctx
->consumer_metadata_pipe
;
215 ret
= consumer_add_data_stream(stream
);
217 ERR("Consumer add stream %" PRIu64
" failed.",
221 stream_pipe
= ctx
->consumer_data_pipe
;
225 * From this point on, the stream's ownership has been moved away from
226 * the channel and becomes globally visible.
228 stream
->globally_visible
= 1;
230 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
232 ERR("Consumer write %s stream to pipe %d",
233 stream
->metadata_flag
? "metadata" : "data",
234 lttng_pipe_get_writefd(stream_pipe
));
235 if (stream
->metadata_flag
) {
236 consumer_del_stream_for_metadata(stream
);
238 consumer_del_stream_for_data(stream
);
246 * Create streams for the given channel using liblttng-ust-ctl.
248 * Return 0 on success else a negative value.
250 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
251 struct lttng_consumer_local_data
*ctx
)
254 struct ustctl_consumer_stream
*ustream
;
255 struct lttng_consumer_stream
*stream
;
261 * While a stream is available from ustctl. When NULL is returned, we've
262 * reached the end of the possible stream for the channel.
264 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
266 int ust_metadata_pipe
[2];
268 health_code_update();
270 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
271 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
273 ERR("Create ust metadata poll pipe");
276 wait_fd
= ust_metadata_pipe
[0];
278 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
281 /* Allocate consumer stream object. */
282 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
286 stream
->ustream
= ustream
;
288 * Store it so we can save multiple function calls afterwards since
289 * this value is used heavily in the stream threads. This is UST
290 * specific so this is why it's done after allocation.
292 stream
->wait_fd
= wait_fd
;
295 * Increment channel refcount since the channel reference has now been
296 * assigned in the allocation process above.
298 if (stream
->chan
->monitor
) {
299 uatomic_inc(&stream
->chan
->refcount
);
303 * Order is important this is why a list is used. On error, the caller
304 * should clean this list.
306 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
308 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
309 &stream
->max_sb_size
);
311 ERR("ustctl_get_max_subbuf_size failed for stream %s",
316 /* Do actions once stream has been received. */
317 if (ctx
->on_recv_stream
) {
318 ret
= ctx
->on_recv_stream(stream
);
324 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
325 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
327 /* Set next CPU stream. */
328 channel
->streams
.count
= ++cpu
;
330 /* Keep stream reference when creating metadata. */
331 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
332 channel
->metadata_stream
= stream
;
333 stream
->ust_metadata_poll_pipe
[0] = ust_metadata_pipe
[0];
334 stream
->ust_metadata_poll_pipe
[1] = ust_metadata_pipe
[1];
346 * Create an UST channel with the given attributes and send it to the session
347 * daemon using the ust ctl API.
349 * Return 0 on success or else a negative value.
351 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
352 struct ustctl_consumer_channel
**chanp
)
355 struct ustctl_consumer_channel
*channel
;
360 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
361 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
362 "switch_timer_interval: %u, read_timer_interval: %u, "
363 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
364 attr
->num_subbuf
, attr
->switch_timer_interval
,
365 attr
->read_timer_interval
, attr
->output
, attr
->type
);
367 channel
= ustctl_create_channel(attr
);
382 * Send a single given stream to the session daemon using the sock.
384 * Return 0 on success else a negative value.
386 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
393 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
395 /* Send stream to session daemon. */
396 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
406 * Send channel to sessiond.
408 * Return 0 on success or else a negative value.
410 static int send_sessiond_channel(int sock
,
411 struct lttng_consumer_channel
*channel
,
412 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
414 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
415 struct lttng_consumer_stream
*stream
;
416 uint64_t net_seq_idx
= -1ULL;
422 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
424 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
425 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
427 health_code_update();
429 /* Try to send the stream to the relayd if one is available. */
430 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
433 * Flag that the relayd was the problem here probably due to a
434 * communicaton error on the socket.
439 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
441 if (net_seq_idx
== -1ULL) {
442 net_seq_idx
= stream
->net_seq_idx
;
447 /* Inform sessiond that we are about to send channel and streams. */
448 ret
= consumer_send_status_msg(sock
, ret_code
);
449 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
451 * Either the session daemon is not responding or the relayd died so we
457 /* Send channel to sessiond. */
458 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
463 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
468 /* The channel was sent successfully to the sessiond at this point. */
469 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
471 health_code_update();
473 /* Send stream to session daemon. */
474 ret
= send_sessiond_stream(sock
, stream
);
480 /* Tell sessiond there is no more stream. */
481 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
486 DBG("UST consumer NULL stream sent to sessiond");
491 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
498 * Creates a channel and streams and add the channel it to the channel internal
499 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
502 * Return 0 on success or else, a negative value is returned and the channel
503 * MUST be destroyed by consumer_del_channel().
505 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
506 struct lttng_consumer_channel
*channel
,
507 struct ustctl_consumer_channel_attr
*attr
)
516 * This value is still used by the kernel consumer since for the kernel,
517 * the stream ownership is not IN the consumer so we need to have the
518 * number of left stream that needs to be initialized so we can know when
519 * to delete the channel (see consumer.c).
521 * As for the user space tracer now, the consumer creates and sends the
522 * stream to the session daemon which only sends them to the application
523 * once every stream of a channel is received making this value useless
524 * because we they will be added to the poll thread before the application
525 * receives them. This ensures that a stream can not hang up during
526 * initilization of a channel.
528 channel
->nb_init_stream_left
= 0;
530 /* The reply msg status is handled in the following call. */
531 ret
= create_ust_channel(attr
, &channel
->uchan
);
536 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
539 * For the snapshots (no monitor), we create the metadata streams
540 * on demand, not during the channel creation.
542 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
547 /* Open all streams for this channel. */
548 ret
= create_ust_streams(channel
, ctx
);
558 * Send all stream of a channel to the right thread handling it.
560 * On error, return a negative value else 0 on success.
562 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
563 struct lttng_consumer_local_data
*ctx
)
566 struct lttng_consumer_stream
*stream
, *stmp
;
571 /* Send streams to the corresponding thread. */
572 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
575 health_code_update();
577 /* Sending the stream to the thread. */
578 ret
= send_stream_to_thread(stream
, ctx
);
581 * If we are unable to send the stream to the thread, there is
582 * a big problem so just stop everything.
584 /* Remove node from the channel stream list. */
585 cds_list_del(&stream
->send_node
);
589 /* Remove node from the channel stream list. */
590 cds_list_del(&stream
->send_node
);
599 * Flush channel's streams using the given key to retrieve the channel.
601 * Return 0 on success else an LTTng error code.
603 static int flush_channel(uint64_t chan_key
)
606 struct lttng_consumer_channel
*channel
;
607 struct lttng_consumer_stream
*stream
;
609 struct lttng_ht_iter iter
;
611 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
614 channel
= consumer_find_channel(chan_key
);
616 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
617 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
621 ht
= consumer_data
.stream_per_chan_id_ht
;
623 /* For each stream of the channel id, flush it. */
624 cds_lfht_for_each_entry_duplicate(ht
->ht
,
625 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
626 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
628 health_code_update();
630 ustctl_flush_buffer(stream
->ustream
, 1);
638 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
639 * RCU read side lock MUST be acquired before calling this function.
641 * Return 0 on success else an LTTng error code.
643 static int close_metadata(uint64_t chan_key
)
646 struct lttng_consumer_channel
*channel
;
648 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
650 channel
= consumer_find_channel(chan_key
);
653 * This is possible if the metadata thread has issue a delete because
654 * the endpoint point of the stream hung up. There is no way the
655 * session daemon can know about it thus use a DBG instead of an actual
658 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
659 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
663 pthread_mutex_lock(&consumer_data
.lock
);
664 pthread_mutex_lock(&channel
->lock
);
666 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
670 lttng_ustconsumer_close_metadata(channel
);
673 pthread_mutex_unlock(&channel
->lock
);
674 pthread_mutex_unlock(&consumer_data
.lock
);
680 * RCU read side lock MUST be acquired before calling this function.
682 * Return 0 on success else an LTTng error code.
684 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
687 struct lttng_consumer_channel
*metadata
;
689 DBG("UST consumer setup metadata key %" PRIu64
, key
);
691 metadata
= consumer_find_channel(key
);
693 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
694 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
699 * In no monitor mode, the metadata channel has no stream(s) so skip the
700 * ownership transfer to the metadata thread.
702 if (!metadata
->monitor
) {
703 DBG("Metadata channel in no monitor");
709 * Send metadata stream to relayd if one available. Availability is
710 * known if the stream is still in the list of the channel.
712 if (cds_list_empty(&metadata
->streams
.head
)) {
713 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
714 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
715 goto error_no_stream
;
718 /* Send metadata stream to relayd if needed. */
719 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
720 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
723 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
726 ret
= consumer_send_relayd_streams_sent(
727 metadata
->metadata_stream
->net_seq_idx
);
729 ret
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
734 ret
= send_streams_to_thread(metadata
, ctx
);
737 * If we are unable to send the stream to the thread, there is
738 * a big problem so just stop everything.
740 ret
= LTTCOMM_CONSUMERD_FATAL
;
743 /* List MUST be empty after or else it could be reused. */
744 assert(cds_list_empty(&metadata
->streams
.head
));
751 * Delete metadata channel on error. At this point, the metadata stream can
752 * NOT be monitored by the metadata thread thus having the guarantee that
753 * the stream is still in the local stream list of the channel. This call
754 * will make sure to clean that list.
756 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
757 cds_list_del(&metadata
->metadata_stream
->send_node
);
758 metadata
->metadata_stream
= NULL
;
765 * Snapshot the whole metadata.
767 * Returns 0 on success, < 0 on error
769 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
770 struct lttng_consumer_local_data
*ctx
)
773 struct lttng_consumer_channel
*metadata_channel
;
774 struct lttng_consumer_stream
*metadata_stream
;
779 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
784 metadata_channel
= consumer_find_channel(key
);
785 if (!metadata_channel
) {
786 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
791 assert(!metadata_channel
->monitor
);
793 health_code_update();
796 * Ask the sessiond if we have new metadata waiting and update the
797 * consumer metadata cache.
799 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
804 health_code_update();
807 * The metadata stream is NOT created in no monitor mode when the channel
808 * is created on a sessiond ask channel command.
810 ret
= create_ust_streams(metadata_channel
, ctx
);
815 metadata_stream
= metadata_channel
->metadata_stream
;
816 assert(metadata_stream
);
818 if (relayd_id
!= (uint64_t) -1ULL) {
819 metadata_stream
->net_seq_idx
= relayd_id
;
820 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
825 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
826 metadata_stream
->chan
->tracefile_size
,
827 metadata_stream
->tracefile_count_current
,
828 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
832 metadata_stream
->out_fd
= ret
;
833 metadata_stream
->tracefile_size_current
= 0;
837 health_code_update();
839 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
847 * Clean up the stream completly because the next snapshot will use a new
850 consumer_stream_destroy(metadata_stream
, NULL
);
851 cds_list_del(&metadata_stream
->send_node
);
852 metadata_channel
->metadata_stream
= NULL
;
860 * Take a snapshot of all the stream of a channel.
862 * Returns 0 on success, < 0 on error
864 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
865 uint64_t nb_packets_per_stream
, struct lttng_consumer_local_data
*ctx
)
868 unsigned use_relayd
= 0;
869 unsigned long consumed_pos
, produced_pos
;
870 struct lttng_consumer_channel
*channel
;
871 struct lttng_consumer_stream
*stream
;
878 if (relayd_id
!= (uint64_t) -1ULL) {
882 channel
= consumer_find_channel(key
);
884 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
888 assert(!channel
->monitor
);
889 DBG("UST consumer snapshot channel %" PRIu64
, key
);
891 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
893 health_code_update();
895 /* Lock stream because we are about to change its state. */
896 pthread_mutex_lock(&stream
->lock
);
897 stream
->net_seq_idx
= relayd_id
;
900 ret
= consumer_send_relayd_stream(stream
, path
);
905 ret
= utils_create_stream_file(path
, stream
->name
,
906 stream
->chan
->tracefile_size
,
907 stream
->tracefile_count_current
,
908 stream
->uid
, stream
->gid
, NULL
);
912 stream
->out_fd
= ret
;
913 stream
->tracefile_size_current
= 0;
915 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
916 stream
->name
, stream
->key
);
918 if (relayd_id
!= -1ULL) {
919 ret
= consumer_send_relayd_streams_sent(relayd_id
);
925 ustctl_flush_buffer(stream
->ustream
, 1);
927 ret
= lttng_ustconsumer_take_snapshot(stream
);
929 ERR("Taking UST snapshot");
933 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
935 ERR("Produced UST snapshot position");
939 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
941 ERR("Consumerd UST snapshot position");
946 * The original value is sent back if max stream size is larger than
947 * the possible size of the snapshot. Also, we assume that the session
948 * daemon should never send a maximum stream size that is lower than
951 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
952 produced_pos
, nb_packets_per_stream
,
953 stream
->max_sb_size
);
955 while (consumed_pos
< produced_pos
) {
957 unsigned long len
, padded_len
;
959 health_code_update();
961 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
963 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
965 if (ret
!= -EAGAIN
) {
966 PERROR("ustctl_get_subbuf snapshot");
967 goto error_close_stream
;
969 DBG("UST consumer get subbuf failed. Skipping it.");
970 consumed_pos
+= stream
->max_sb_size
;
974 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
976 ERR("Snapshot ustctl_get_subbuf_size");
977 goto error_put_subbuf
;
980 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
982 ERR("Snapshot ustctl_get_padded_subbuf_size");
983 goto error_put_subbuf
;
986 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
987 padded_len
- len
, NULL
);
989 if (read_len
!= len
) {
991 goto error_put_subbuf
;
994 if (read_len
!= padded_len
) {
996 goto error_put_subbuf
;
1000 ret
= ustctl_put_subbuf(stream
->ustream
);
1002 ERR("Snapshot ustctl_put_subbuf");
1003 goto error_close_stream
;
1005 consumed_pos
+= stream
->max_sb_size
;
1008 /* Simply close the stream so we can use it on the next snapshot. */
1009 consumer_stream_close(stream
);
1010 pthread_mutex_unlock(&stream
->lock
);
1017 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1018 ERR("Snapshot ustctl_put_subbuf");
1021 consumer_stream_close(stream
);
1023 pthread_mutex_unlock(&stream
->lock
);
1030 * Receive the metadata updates from the sessiond.
1032 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1033 uint64_t len
, struct lttng_consumer_channel
*channel
,
1034 int timer
, int wait
)
1036 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1039 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1041 metadata_str
= zmalloc(len
* sizeof(char));
1042 if (!metadata_str
) {
1043 PERROR("zmalloc metadata string");
1044 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1048 health_code_update();
1050 /* Receive metadata string. */
1051 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1053 /* Session daemon is dead so return gracefully. */
1058 health_code_update();
1060 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1061 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1063 /* Unable to handle metadata. Notify session daemon. */
1064 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1066 * Skip metadata flush on write error since the offset and len might
1067 * not have been updated which could create an infinite loop below when
1068 * waiting for the metadata cache to be flushed.
1070 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1073 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1078 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1079 DBG("Waiting for metadata to be flushed");
1081 health_code_update();
1083 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1093 * Receive command from session daemon and process it.
1095 * Return 1 on success else a negative value or 0.
1097 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1098 int sock
, struct pollfd
*consumer_sockpoll
)
1101 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1102 struct lttcomm_consumer_msg msg
;
1103 struct lttng_consumer_channel
*channel
= NULL
;
1105 health_code_update();
1107 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1108 if (ret
!= sizeof(msg
)) {
1109 DBG("Consumer received unexpected message size %zd (expects %zu)",
1112 * The ret value might 0 meaning an orderly shutdown but this is ok
1113 * since the caller handles this.
1116 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1122 health_code_update();
1125 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
1127 health_code_update();
1129 /* relayd needs RCU read-side lock */
1132 switch (msg
.cmd_type
) {
1133 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1135 /* Session daemon status message are handled in the following call. */
1136 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1137 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1138 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1139 msg
.u
.relayd_sock
.relayd_session_id
);
1142 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1144 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1145 struct consumer_relayd_sock_pair
*relayd
;
1147 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1149 /* Get relayd reference if exists. */
1150 relayd
= consumer_find_relayd(index
);
1151 if (relayd
== NULL
) {
1152 DBG("Unable to find relayd %" PRIu64
, index
);
1153 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
1157 * Each relayd socket pair has a refcount of stream attached to it
1158 * which tells if the relayd is still active or not depending on the
1161 * This will set the destroy flag of the relayd object and destroy it
1162 * if the refcount reaches zero when called.
1164 * The destroy can happen either here or when a stream fd hangs up.
1167 consumer_flag_relayd_for_destroy(relayd
);
1170 goto end_msg_sessiond
;
1172 case LTTNG_CONSUMER_UPDATE_STREAM
:
1177 case LTTNG_CONSUMER_DATA_PENDING
:
1179 int ret
, is_data_pending
;
1180 uint64_t id
= msg
.u
.data_pending
.session_id
;
1182 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1184 is_data_pending
= consumer_data_pending(id
);
1186 /* Send back returned value to session daemon */
1187 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1188 sizeof(is_data_pending
));
1190 DBG("Error when sending the data pending ret code: %d", ret
);
1195 * No need to send back a status message since the data pending
1196 * returned value is the response.
1200 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1203 struct ustctl_consumer_channel_attr attr
;
1205 /* Create a plain object and reserve a channel key. */
1206 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1207 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1208 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1209 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1210 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1211 msg
.u
.ask_channel
.tracefile_size
,
1212 msg
.u
.ask_channel
.tracefile_count
,
1213 msg
.u
.ask_channel
.session_id_per_pid
,
1214 msg
.u
.ask_channel
.monitor
,
1215 msg
.u
.ask_channel
.live_timer_interval
,
1216 msg
.u
.ask_channel
.shm_path
);
1218 goto end_channel_error
;
1222 * Assign UST application UID to the channel. This value is ignored for
1223 * per PID buffers. This is specific to UST thus setting this after the
1226 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1228 /* Build channel attributes from received message. */
1229 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1230 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1231 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1232 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1233 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1234 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1235 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1236 strncpy(attr
.shm_path
, channel
->shm_path
,
1237 sizeof(attr
.shm_path
));
1238 attr
.shm_path
[sizeof(attr
.shm_path
) - 1] = '\0';
1240 /* Match channel buffer type to the UST abi. */
1241 switch (msg
.u
.ask_channel
.output
) {
1242 case LTTNG_EVENT_MMAP
:
1244 attr
.output
= LTTNG_UST_MMAP
;
1248 /* Translate and save channel type. */
1249 switch (msg
.u
.ask_channel
.type
) {
1250 case LTTNG_UST_CHAN_PER_CPU
:
1251 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1252 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1254 * Set refcount to 1 for owner. Below, we will
1255 * pass ownership to the
1256 * consumer_thread_channel_poll() thread.
1258 channel
->refcount
= 1;
1260 case LTTNG_UST_CHAN_METADATA
:
1261 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1262 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1269 health_code_update();
1271 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1273 goto end_channel_error
;
1276 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1277 ret
= consumer_metadata_cache_allocate(channel
);
1279 ERR("Allocating metadata cache");
1280 goto end_channel_error
;
1282 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1283 attr
.switch_timer_interval
= 0;
1285 consumer_timer_live_start(channel
,
1286 msg
.u
.ask_channel
.live_timer_interval
);
1289 health_code_update();
1292 * Add the channel to the internal state AFTER all streams were created
1293 * and successfully sent to session daemon. This way, all streams must
1294 * be ready before this channel is visible to the threads.
1295 * If add_channel succeeds, ownership of the channel is
1296 * passed to consumer_thread_channel_poll().
1298 ret
= add_channel(channel
, ctx
);
1300 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1301 if (channel
->switch_timer_enabled
== 1) {
1302 consumer_timer_switch_stop(channel
);
1304 consumer_metadata_cache_destroy(channel
);
1306 if (channel
->live_timer_enabled
== 1) {
1307 consumer_timer_live_stop(channel
);
1309 goto end_channel_error
;
1312 health_code_update();
1315 * Channel and streams are now created. Inform the session daemon that
1316 * everything went well and should wait to receive the channel and
1317 * streams with ustctl API.
1319 ret
= consumer_send_status_channel(sock
, channel
);
1322 * There is probably a problem on the socket.
1329 case LTTNG_CONSUMER_GET_CHANNEL
:
1331 int ret
, relayd_err
= 0;
1332 uint64_t key
= msg
.u
.get_channel
.key
;
1333 struct lttng_consumer_channel
*channel
;
1335 channel
= consumer_find_channel(key
);
1337 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1338 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
1339 goto end_msg_sessiond
;
1342 health_code_update();
1344 /* Send everything to sessiond. */
1345 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1349 * We were unable to send to the relayd the stream so avoid
1350 * sending back a fatal error to the thread since this is OK
1351 * and the consumer can continue its work. The above call
1352 * has sent the error status message to the sessiond.
1357 * The communicaton was broken hence there is a bad state between
1358 * the consumer and sessiond so stop everything.
1363 health_code_update();
1366 * In no monitor mode, the streams ownership is kept inside the channel
1367 * so don't send them to the data thread.
1369 if (!channel
->monitor
) {
1370 goto end_msg_sessiond
;
1373 ret
= send_streams_to_thread(channel
, ctx
);
1376 * If we are unable to send the stream to the thread, there is
1377 * a big problem so just stop everything.
1381 /* List MUST be empty after or else it could be reused. */
1382 assert(cds_list_empty(&channel
->streams
.head
));
1383 goto end_msg_sessiond
;
1385 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1387 uint64_t key
= msg
.u
.destroy_channel
.key
;
1390 * Only called if streams have not been sent to stream
1391 * manager thread. However, channel has been sent to
1392 * channel manager thread.
1394 notify_thread_del_channel(ctx
, key
);
1395 goto end_msg_sessiond
;
1397 case LTTNG_CONSUMER_CLOSE_METADATA
:
1401 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1406 goto end_msg_sessiond
;
1408 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1412 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1417 goto end_msg_sessiond
;
1419 case LTTNG_CONSUMER_PUSH_METADATA
:
1422 uint64_t len
= msg
.u
.push_metadata
.len
;
1423 uint64_t key
= msg
.u
.push_metadata
.key
;
1424 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1425 struct lttng_consumer_channel
*channel
;
1427 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1430 channel
= consumer_find_channel(key
);
1433 * This is possible if the metadata creation on the consumer side
1434 * is in flight vis-a-vis a concurrent push metadata from the
1435 * session daemon. Simply return that the channel failed and the
1436 * session daemon will handle that message correctly considering
1437 * that this race is acceptable thus the DBG() statement here.
1439 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1440 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1441 goto end_msg_sessiond
;
1444 health_code_update();
1446 /* Tell session daemon we are ready to receive the metadata. */
1447 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1449 /* Somehow, the session daemon is not responding anymore. */
1453 health_code_update();
1455 /* Wait for more data. */
1456 health_poll_entry();
1457 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1463 health_code_update();
1465 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1466 len
, channel
, 0, 1);
1468 /* error receiving from sessiond */
1472 goto end_msg_sessiond
;
1475 case LTTNG_CONSUMER_SETUP_METADATA
:
1479 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1483 goto end_msg_sessiond
;
1485 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1487 if (msg
.u
.snapshot_channel
.metadata
) {
1488 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1489 msg
.u
.snapshot_channel
.pathname
,
1490 msg
.u
.snapshot_channel
.relayd_id
,
1493 ERR("Snapshot metadata failed");
1494 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1497 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1498 msg
.u
.snapshot_channel
.pathname
,
1499 msg
.u
.snapshot_channel
.relayd_id
,
1500 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
1503 ERR("Snapshot channel failed");
1504 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1508 health_code_update();
1509 ret
= consumer_send_status_msg(sock
, ret_code
);
1511 /* Somehow, the session daemon is not responding anymore. */
1514 health_code_update();
1524 health_code_update();
1527 * Return 1 to indicate success since the 0 value can be a socket
1528 * shutdown during the recv() or send() call.
1534 * The returned value here is not useful since either way we'll return 1 to
1535 * the caller because the session daemon socket management is done
1536 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1538 ret
= consumer_send_status_msg(sock
, ret_code
);
1544 health_code_update();
1550 * Free channel here since no one has a reference to it. We don't
1551 * free after that because a stream can store this pointer.
1553 destroy_channel(channel
);
1555 /* We have to send a status channel message indicating an error. */
1556 ret
= consumer_send_status_channel(sock
, NULL
);
1558 /* Stop everything if session daemon can not be notified. */
1563 health_code_update();
1568 /* This will issue a consumer stop. */
1573 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1574 * compiled out, we isolate it in this library.
1576 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1580 assert(stream
->ustream
);
1582 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1586 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1587 * compiled out, we isolate it in this library.
1589 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1592 assert(stream
->ustream
);
1594 return ustctl_get_mmap_base(stream
->ustream
);
1598 * Take a snapshot for a specific fd
1600 * Returns 0 on success, < 0 on error
1602 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1605 assert(stream
->ustream
);
1607 return ustctl_snapshot(stream
->ustream
);
1611 * Get the produced position
1613 * Returns 0 on success, < 0 on error
1615 int lttng_ustconsumer_get_produced_snapshot(
1616 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1619 assert(stream
->ustream
);
1622 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1626 * Get the consumed position
1628 * Returns 0 on success, < 0 on error
1630 int lttng_ustconsumer_get_consumed_snapshot(
1631 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1634 assert(stream
->ustream
);
1637 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1640 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1644 assert(stream
->ustream
);
1646 ustctl_flush_buffer(stream
->ustream
, producer
);
1649 int lttng_ustconsumer_get_current_timestamp(
1650 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1653 assert(stream
->ustream
);
1656 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1660 * Called when the stream signal the consumer that it has hang up.
1662 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1665 assert(stream
->ustream
);
1667 ustctl_flush_buffer(stream
->ustream
, 0);
1668 stream
->hangup_flush_done
= 1;
1671 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1674 assert(chan
->uchan
);
1676 if (chan
->switch_timer_enabled
== 1) {
1677 consumer_timer_switch_stop(chan
);
1679 consumer_metadata_cache_destroy(chan
);
1680 ustctl_destroy_channel(chan
->uchan
);
1683 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1686 assert(stream
->ustream
);
1688 if (stream
->chan
->switch_timer_enabled
== 1) {
1689 consumer_timer_switch_stop(stream
->chan
);
1691 ustctl_destroy_stream(stream
->ustream
);
1694 int lttng_ustconsumer_get_wakeup_fd(struct lttng_consumer_stream
*stream
)
1697 assert(stream
->ustream
);
1699 return ustctl_stream_get_wakeup_fd(stream
->ustream
);
1702 int lttng_ustconsumer_close_wakeup_fd(struct lttng_consumer_stream
*stream
)
1705 assert(stream
->ustream
);
1707 return ustctl_stream_close_wakeup_fd(stream
->ustream
);
1711 * Populate index values of a UST stream. Values are set in big endian order.
1713 * Return 0 on success or else a negative value.
1715 static int get_index_values(struct ctf_packet_index
*index
,
1716 struct ustctl_consumer_stream
*ustream
)
1720 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1722 PERROR("ustctl_get_timestamp_begin");
1725 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1727 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1729 PERROR("ustctl_get_timestamp_end");
1732 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1734 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1736 PERROR("ustctl_get_events_discarded");
1739 index
->events_discarded
= htobe64(index
->events_discarded
);
1741 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1743 PERROR("ustctl_get_content_size");
1746 index
->content_size
= htobe64(index
->content_size
);
1748 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1750 PERROR("ustctl_get_packet_size");
1753 index
->packet_size
= htobe64(index
->packet_size
);
1755 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1757 PERROR("ustctl_get_stream_id");
1760 index
->stream_id
= htobe64(index
->stream_id
);
1767 * Write up to one packet from the metadata cache to the channel.
1769 * Returns the number of bytes pushed in the cache, or a negative value
1773 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1778 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1779 if (stream
->chan
->metadata_cache
->contiguous
1780 == stream
->ust_metadata_pushed
) {
1785 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1786 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1787 stream
->chan
->metadata_cache
->contiguous
1788 - stream
->ust_metadata_pushed
);
1789 assert(write_len
!= 0);
1790 if (write_len
< 0) {
1791 ERR("Writing one metadata packet");
1795 stream
->ust_metadata_pushed
+= write_len
;
1797 assert(stream
->chan
->metadata_cache
->contiguous
>=
1798 stream
->ust_metadata_pushed
);
1802 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1808 * Sync metadata meaning request them to the session daemon and snapshot to the
1809 * metadata thread can consumer them.
1811 * Metadata stream lock MUST be acquired.
1813 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1814 * is empty or a negative value on error.
1816 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1817 struct lttng_consumer_stream
*metadata
)
1826 * Request metadata from the sessiond, but don't wait for the flush
1827 * because we locked the metadata thread.
1829 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1834 ret
= commit_one_metadata_packet(metadata
);
1837 } else if (ret
> 0) {
1841 ustctl_flush_buffer(metadata
->ustream
, 1);
1842 ret
= ustctl_snapshot(metadata
->ustream
);
1844 if (errno
!= EAGAIN
) {
1845 ERR("Sync metadata, taking UST snapshot");
1848 DBG("No new metadata when syncing them.");
1849 /* No new metadata, exit. */
1855 * After this flush, we still need to extract metadata.
1866 * Return 0 on success else a negative value.
1868 static int notify_if_more_data(struct lttng_consumer_stream
*stream
,
1869 struct lttng_consumer_local_data
*ctx
)
1872 struct ustctl_consumer_stream
*ustream
;
1877 ustream
= stream
->ustream
;
1880 * First, we are going to check if there is a new subbuffer available
1881 * before reading the stream wait_fd.
1883 /* Get the next subbuffer */
1884 ret
= ustctl_get_next_subbuf(ustream
);
1886 /* No more data found, flag the stream. */
1887 stream
->has_data
= 0;
1892 ret
= ustctl_put_subbuf(ustream
);
1895 /* This stream still has data. Flag it and wake up the data thread. */
1896 stream
->has_data
= 1;
1898 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !ctx
->has_wakeup
) {
1901 writelen
= lttng_pipe_write(ctx
->consumer_wakeup_pipe
, "!", 1);
1902 if (writelen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1907 /* The wake up pipe has been notified. */
1908 ctx
->has_wakeup
= 1;
1917 * Read subbuffer from the given stream.
1919 * Stream lock MUST be acquired.
1921 * Return 0 on success else a negative value.
1923 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1924 struct lttng_consumer_local_data
*ctx
)
1926 unsigned long len
, subbuf_size
, padding
;
1927 int err
, write_index
= 1;
1929 struct ustctl_consumer_stream
*ustream
;
1930 struct ctf_packet_index index
;
1933 assert(stream
->ustream
);
1936 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1939 /* Ease our life for what's next. */
1940 ustream
= stream
->ustream
;
1943 * We can consume the 1 byte written into the wait_fd by UST. Don't trigger
1944 * error if we cannot read this one byte (read returns 0), or if the error
1945 * is EAGAIN or EWOULDBLOCK.
1947 * This is only done when the stream is monitored by a thread, before the
1948 * flush is done after a hangup and if the stream is not flagged with data
1949 * since there might be nothing to consume in the wait fd but still have
1950 * data available flagged by the consumer wake up pipe.
1952 if (stream
->monitor
&& !stream
->hangup_flush_done
&& !stream
->has_data
) {
1956 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
1957 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1964 /* Get the next subbuffer */
1965 err
= ustctl_get_next_subbuf(ustream
);
1968 * Populate metadata info if the existing info has
1969 * already been read.
1971 if (stream
->metadata_flag
) {
1972 ret
= commit_one_metadata_packet(stream
);
1976 ustctl_flush_buffer(stream
->ustream
, 1);
1980 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1982 * This is a debug message even for single-threaded consumer,
1983 * because poll() have more relaxed criterions than get subbuf,
1984 * so get_subbuf may fail for short race windows where poll()
1985 * would issue wakeups.
1987 DBG("Reserving sub buffer failed (everything is normal, "
1988 "it is due to concurrency) [ret: %d]", err
);
1991 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1993 if (!stream
->metadata_flag
) {
1994 index
.offset
= htobe64(stream
->out_fd_offset
);
1995 ret
= get_index_values(&index
, ustream
);
2003 /* Get the full padded subbuffer size */
2004 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
2007 /* Get subbuffer data size (without padding) */
2008 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
2011 /* Make sure we don't get a subbuffer size bigger than the padded */
2012 assert(len
>= subbuf_size
);
2014 padding
= len
- subbuf_size
;
2015 /* write the subbuffer to the tracefile */
2016 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
2018 * The mmap operation should write subbuf_size amount of data when network
2019 * streaming or the full padding (len) size when we are _not_ streaming.
2021 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
2022 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
2024 * Display the error but continue processing to try to release the
2025 * subbuffer. This is a DBG statement since any unexpected kill or
2026 * signal, the application gets unregistered, relayd gets closed or
2027 * anything that affects the buffer lifetime will trigger this error.
2028 * So, for the sake of the user, don't print this error since it can
2029 * happen and it is OK with the code flow.
2031 DBG("Error writing to tracefile "
2032 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2033 ret
, len
, subbuf_size
);
2036 err
= ustctl_put_next_subbuf(ustream
);
2040 * This will consumer the byte on the wait_fd if and only if there is not
2041 * next subbuffer to be acquired.
2043 if (!stream
->metadata_flag
) {
2044 ret
= notify_if_more_data(stream
, ctx
);
2050 /* Write index if needed. */
2055 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2057 * In live, block until all the metadata is sent.
2059 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2065 assert(!stream
->metadata_flag
);
2066 err
= consumer_stream_write_index(stream
, &index
);
2076 * Called when a stream is created.
2078 * Return 0 on success or else a negative value.
2080 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2086 /* Don't create anything if this is set for streaming. */
2087 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2088 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2089 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2090 stream
->uid
, stream
->gid
, NULL
);
2094 stream
->out_fd
= ret
;
2095 stream
->tracefile_size_current
= 0;
2097 if (!stream
->metadata_flag
) {
2098 ret
= index_create_file(stream
->chan
->pathname
,
2099 stream
->name
, stream
->uid
, stream
->gid
,
2100 stream
->chan
->tracefile_size
,
2101 stream
->tracefile_count_current
);
2105 stream
->index_fd
= ret
;
2115 * Check if data is still being extracted from the buffers for a specific
2116 * stream. Consumer data lock MUST be acquired before calling this function
2117 * and the stream lock.
2119 * Return 1 if the traced data are still getting read else 0 meaning that the
2120 * data is available for trace viewer reading.
2122 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2127 assert(stream
->ustream
);
2129 DBG("UST consumer checking data pending");
2131 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2136 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2137 uint64_t contiguous
, pushed
;
2139 /* Ease our life a bit. */
2140 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
2141 pushed
= stream
->ust_metadata_pushed
;
2144 * We can simply check whether all contiguously available data
2145 * has been pushed to the ring buffer, since the push operation
2146 * is performed within get_next_subbuf(), and because both
2147 * get_next_subbuf() and put_next_subbuf() are issued atomically
2148 * thanks to the stream lock within
2149 * lttng_ustconsumer_read_subbuffer(). This basically means that
2150 * whetnever ust_metadata_pushed is incremented, the associated
2151 * metadata has been consumed from the metadata stream.
2153 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2154 contiguous
, pushed
);
2155 assert(((int64_t) (contiguous
- pushed
)) >= 0);
2156 if ((contiguous
!= pushed
) ||
2157 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2158 ret
= 1; /* Data is pending */
2162 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2165 * There is still data so let's put back this
2168 ret
= ustctl_put_subbuf(stream
->ustream
);
2170 ret
= 1; /* Data is pending */
2175 /* Data is NOT pending so ready to be read. */
2183 * Stop a given metadata channel timer if enabled and close the wait fd which
2184 * is the poll pipe of the metadata stream.
2186 * This MUST be called with the metadata channel acquired.
2188 void lttng_ustconsumer_close_metadata(struct lttng_consumer_channel
*metadata
)
2193 assert(metadata
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
2195 DBG("Closing metadata channel key %" PRIu64
, metadata
->key
);
2197 if (metadata
->switch_timer_enabled
== 1) {
2198 consumer_timer_switch_stop(metadata
);
2201 if (!metadata
->metadata_stream
) {
2206 * Closing write side so the thread monitoring the stream wakes up if any
2207 * and clean the metadata stream.
2209 if (metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] >= 0) {
2210 ret
= close(metadata
->metadata_stream
->ust_metadata_poll_pipe
[1]);
2212 PERROR("closing metadata pipe write side");
2214 metadata
->metadata_stream
->ust_metadata_poll_pipe
[1] = -1;
2222 * Close every metadata stream wait fd of the metadata hash table. This
2223 * function MUST be used very carefully so not to run into a race between the
2224 * metadata thread handling streams and this function closing their wait fd.
2226 * For UST, this is used when the session daemon hangs up. Its the metadata
2227 * producer so calling this is safe because we are assured that no state change
2228 * can occur in the metadata thread for the streams in the hash table.
2230 void lttng_ustconsumer_close_all_metadata(struct lttng_ht
*metadata_ht
)
2232 struct lttng_ht_iter iter
;
2233 struct lttng_consumer_stream
*stream
;
2235 assert(metadata_ht
);
2236 assert(metadata_ht
->ht
);
2238 DBG("UST consumer closing all metadata streams");
2241 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2244 health_code_update();
2246 pthread_mutex_lock(&stream
->chan
->lock
);
2247 lttng_ustconsumer_close_metadata(stream
->chan
);
2248 pthread_mutex_unlock(&stream
->chan
->lock
);
2254 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2258 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2260 ERR("Unable to close wakeup fd");
2265 * Please refer to consumer-timer.c before adding any lock within this
2266 * function or any of its callees. Timers have a very strict locking
2267 * semantic with respect to teardown. Failure to respect this semantic
2268 * introduces deadlocks.
2270 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2271 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2273 struct lttcomm_metadata_request_msg request
;
2274 struct lttcomm_consumer_msg msg
;
2275 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2276 uint64_t len
, key
, offset
;
2280 assert(channel
->metadata_cache
);
2282 memset(&request
, 0, sizeof(request
));
2284 /* send the metadata request to sessiond */
2285 switch (consumer_data
.type
) {
2286 case LTTNG_CONSUMER64_UST
:
2287 request
.bits_per_long
= 64;
2289 case LTTNG_CONSUMER32_UST
:
2290 request
.bits_per_long
= 32;
2293 request
.bits_per_long
= 0;
2297 request
.session_id
= channel
->session_id
;
2298 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2300 * Request the application UID here so the metadata of that application can
2301 * be sent back. The channel UID corresponds to the user UID of the session
2302 * used for the rights on the stream file(s).
2304 request
.uid
= channel
->ust_app_uid
;
2305 request
.key
= channel
->key
;
2307 DBG("Sending metadata request to sessiond, session id %" PRIu64
2308 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2309 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2312 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2314 health_code_update();
2316 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2319 ERR("Asking metadata to sessiond");
2323 health_code_update();
2325 /* Receive the metadata from sessiond */
2326 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2328 if (ret
!= sizeof(msg
)) {
2329 DBG("Consumer received unexpected message size %d (expects %zu)",
2331 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2333 * The ret value might 0 meaning an orderly shutdown but this is ok
2334 * since the caller handles this.
2339 health_code_update();
2341 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2342 /* No registry found */
2343 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2347 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2348 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2353 len
= msg
.u
.push_metadata
.len
;
2354 key
= msg
.u
.push_metadata
.key
;
2355 offset
= msg
.u
.push_metadata
.target_offset
;
2357 assert(key
== channel
->key
);
2359 DBG("No new metadata to receive for key %" PRIu64
, key
);
2362 health_code_update();
2364 /* Tell session daemon we are ready to receive the metadata. */
2365 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2366 LTTCOMM_CONSUMERD_SUCCESS
);
2367 if (ret
< 0 || len
== 0) {
2369 * Somehow, the session daemon is not responding anymore or there is
2370 * nothing to receive.
2375 health_code_update();
2377 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2378 key
, offset
, len
, channel
, timer
, wait
);
2381 * Only send the status msg if the sessiond is alive meaning a positive
2384 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2389 health_code_update();
2391 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);
2396 * Return the ustctl call for the get stream id.
2398 int lttng_ustconsumer_get_stream_id(struct lttng_consumer_stream
*stream
,
2399 uint64_t *stream_id
)
2404 return ustctl_get_stream_id(stream
->ustream
, stream_id
);