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 <bin/lttng-consumerd/health-consumerd.h>
36 #include <common/common.h>
37 #include <common/sessiond-comm/sessiond-comm.h>
38 #include <common/relayd/relayd.h>
39 #include <common/compat/fcntl.h>
40 #include <common/consumer-metadata-cache.h>
41 #include <common/consumer-stream.h>
42 #include <common/consumer-timer.h>
43 #include <common/utils.h>
44 #include <common/index/index.h>
46 #include "ust-consumer.h"
48 extern struct lttng_consumer_global_data consumer_data
;
49 extern int consumer_poll_timeout
;
50 extern volatile int consumer_quit
;
53 * Free channel object and all streams associated with it. This MUST be used
54 * only and only if the channel has _NEVER_ been added to the global channel
57 static void destroy_channel(struct lttng_consumer_channel
*channel
)
59 struct lttng_consumer_stream
*stream
, *stmp
;
63 DBG("UST consumer cleaning stream list");
65 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
70 cds_list_del(&stream
->send_node
);
71 ustctl_destroy_stream(stream
->ustream
);
76 * If a channel is available meaning that was created before the streams
80 lttng_ustconsumer_del_channel(channel
);
86 * Add channel to internal consumer state.
88 * Returns 0 on success or else a negative value.
90 static int add_channel(struct lttng_consumer_channel
*channel
,
91 struct lttng_consumer_local_data
*ctx
)
98 if (ctx
->on_recv_channel
!= NULL
) {
99 ret
= ctx
->on_recv_channel(channel
);
101 ret
= consumer_add_channel(channel
, ctx
);
102 } else if (ret
< 0) {
103 /* Most likely an ENOMEM. */
104 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
108 ret
= consumer_add_channel(channel
, ctx
);
111 DBG("UST consumer channel added (key: %" PRIu64
")", channel
->key
);
118 * Allocate and return a consumer channel object.
120 static struct lttng_consumer_channel
*allocate_channel(uint64_t session_id
,
121 const char *pathname
, const char *name
, uid_t uid
, gid_t gid
,
122 uint64_t relayd_id
, uint64_t key
, enum lttng_event_output output
,
123 uint64_t tracefile_size
, uint64_t tracefile_count
,
124 uint64_t session_id_per_pid
, unsigned int monitor
,
125 unsigned int live_timer_interval
)
130 return consumer_allocate_channel(key
, session_id
, pathname
, name
, uid
,
131 gid
, relayd_id
, output
, tracefile_size
,
132 tracefile_count
, session_id_per_pid
, monitor
, live_timer_interval
);
136 * Allocate and return a consumer stream object. If _alloc_ret is not NULL, the
137 * error value if applicable is set in it else it is kept untouched.
139 * Return NULL on error else the newly allocated stream object.
141 static struct lttng_consumer_stream
*allocate_stream(int cpu
, int key
,
142 struct lttng_consumer_channel
*channel
,
143 struct lttng_consumer_local_data
*ctx
, int *_alloc_ret
)
146 struct lttng_consumer_stream
*stream
= NULL
;
151 stream
= consumer_allocate_stream(channel
->key
,
153 LTTNG_CONSUMER_ACTIVE_STREAM
,
163 if (stream
== NULL
) {
167 * We could not find the channel. Can happen if cpu hotplug
168 * happens while tearing down.
170 DBG3("Could not find channel");
175 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
181 stream
->chan
= channel
;
185 *_alloc_ret
= alloc_ret
;
191 * Send the given stream pointer to the corresponding thread.
193 * Returns 0 on success else a negative value.
195 static int send_stream_to_thread(struct lttng_consumer_stream
*stream
,
196 struct lttng_consumer_local_data
*ctx
)
199 struct lttng_pipe
*stream_pipe
;
201 /* Get the right pipe where the stream will be sent. */
202 if (stream
->metadata_flag
) {
203 ret
= consumer_add_metadata_stream(stream
);
205 ERR("Consumer add metadata stream %" PRIu64
" failed.",
209 stream_pipe
= ctx
->consumer_metadata_pipe
;
211 ret
= consumer_add_data_stream(stream
);
213 ERR("Consumer add stream %" PRIu64
" failed.",
217 stream_pipe
= ctx
->consumer_data_pipe
;
221 * From this point on, the stream's ownership has been moved away from
222 * the channel and becomes globally visible.
224 stream
->globally_visible
= 1;
226 ret
= lttng_pipe_write(stream_pipe
, &stream
, sizeof(stream
));
228 ERR("Consumer write %s stream to pipe %d",
229 stream
->metadata_flag
? "metadata" : "data",
230 lttng_pipe_get_writefd(stream_pipe
));
231 if (stream
->metadata_flag
) {
232 consumer_del_stream_for_metadata(stream
);
234 consumer_del_stream_for_data(stream
);
242 * Create streams for the given channel using liblttng-ust-ctl.
244 * Return 0 on success else a negative value.
246 static int create_ust_streams(struct lttng_consumer_channel
*channel
,
247 struct lttng_consumer_local_data
*ctx
)
250 struct ustctl_consumer_stream
*ustream
;
251 struct lttng_consumer_stream
*stream
;
257 * While a stream is available from ustctl. When NULL is returned, we've
258 * reached the end of the possible stream for the channel.
260 while ((ustream
= ustctl_create_stream(channel
->uchan
, cpu
))) {
262 int ust_metadata_pipe
[2];
264 health_code_update();
266 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& channel
->monitor
) {
267 ret
= utils_create_pipe_cloexec_nonblock(ust_metadata_pipe
);
269 ERR("Create ust metadata poll pipe");
272 wait_fd
= ust_metadata_pipe
[0];
274 wait_fd
= ustctl_stream_get_wait_fd(ustream
);
277 /* Allocate consumer stream object. */
278 stream
= allocate_stream(cpu
, wait_fd
, channel
, ctx
, &ret
);
282 stream
->ustream
= ustream
;
284 * Store it so we can save multiple function calls afterwards since
285 * this value is used heavily in the stream threads. This is UST
286 * specific so this is why it's done after allocation.
288 stream
->wait_fd
= wait_fd
;
291 * Increment channel refcount since the channel reference has now been
292 * assigned in the allocation process above.
294 if (stream
->chan
->monitor
) {
295 uatomic_inc(&stream
->chan
->refcount
);
299 * Order is important this is why a list is used. On error, the caller
300 * should clean this list.
302 cds_list_add_tail(&stream
->send_node
, &channel
->streams
.head
);
304 ret
= ustctl_get_max_subbuf_size(stream
->ustream
,
305 &stream
->max_sb_size
);
307 ERR("ustctl_get_max_subbuf_size failed for stream %s",
312 /* Do actions once stream has been received. */
313 if (ctx
->on_recv_stream
) {
314 ret
= ctx
->on_recv_stream(stream
);
320 DBG("UST consumer add stream %s (key: %" PRIu64
") with relayd id %" PRIu64
,
321 stream
->name
, stream
->key
, stream
->relayd_stream_id
);
323 /* Set next CPU stream. */
324 channel
->streams
.count
= ++cpu
;
326 /* Keep stream reference when creating metadata. */
327 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
328 channel
->metadata_stream
= stream
;
329 stream
->ust_metadata_poll_pipe
[0] = ust_metadata_pipe
[0];
330 stream
->ust_metadata_poll_pipe
[1] = ust_metadata_pipe
[1];
342 * Create an UST channel with the given attributes and send it to the session
343 * daemon using the ust ctl API.
345 * Return 0 on success or else a negative value.
347 static int create_ust_channel(struct ustctl_consumer_channel_attr
*attr
,
348 struct ustctl_consumer_channel
**chanp
)
351 struct ustctl_consumer_channel
*channel
;
356 DBG3("Creating channel to ustctl with attr: [overwrite: %d, "
357 "subbuf_size: %" PRIu64
", num_subbuf: %" PRIu64
", "
358 "switch_timer_interval: %u, read_timer_interval: %u, "
359 "output: %d, type: %d", attr
->overwrite
, attr
->subbuf_size
,
360 attr
->num_subbuf
, attr
->switch_timer_interval
,
361 attr
->read_timer_interval
, attr
->output
, attr
->type
);
363 channel
= ustctl_create_channel(attr
);
378 * Send a single given stream to the session daemon using the sock.
380 * Return 0 on success else a negative value.
382 static int send_sessiond_stream(int sock
, struct lttng_consumer_stream
*stream
)
389 DBG("UST consumer sending stream %" PRIu64
" to sessiond", stream
->key
);
391 /* Send stream to session daemon. */
392 ret
= ustctl_send_stream_to_sessiond(sock
, stream
->ustream
);
402 * Send channel to sessiond.
404 * Return 0 on success or else a negative value.
406 static int send_sessiond_channel(int sock
,
407 struct lttng_consumer_channel
*channel
,
408 struct lttng_consumer_local_data
*ctx
, int *relayd_error
)
410 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
411 struct lttng_consumer_stream
*stream
;
412 uint64_t net_seq_idx
= -1ULL;
418 DBG("UST consumer sending channel %s to sessiond", channel
->name
);
420 if (channel
->relayd_id
!= (uint64_t) -1ULL) {
421 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
423 health_code_update();
425 /* Try to send the stream to the relayd if one is available. */
426 ret
= consumer_send_relayd_stream(stream
, stream
->chan
->pathname
);
429 * Flag that the relayd was the problem here probably due to a
430 * communicaton error on the socket.
435 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
437 if (net_seq_idx
== -1ULL) {
438 net_seq_idx
= stream
->net_seq_idx
;
441 ret
= consumer_send_relayd_streams_sent(net_seq_idx
);
444 * Flag that the relayd was the problem here probably due to a
445 * communicaton error on the socket.
450 ret_code
= LTTNG_ERR_RELAYD_CONNECT_FAIL
;
454 /* Inform sessiond that we are about to send channel and streams. */
455 ret
= consumer_send_status_msg(sock
, ret_code
);
456 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
458 * Either the session daemon is not responding or the relayd died so we
464 /* Send channel to sessiond. */
465 ret
= ustctl_send_channel_to_sessiond(sock
, channel
->uchan
);
470 ret
= ustctl_channel_close_wakeup_fd(channel
->uchan
);
475 /* The channel was sent successfully to the sessiond at this point. */
476 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
478 health_code_update();
480 /* Send stream to session daemon. */
481 ret
= send_sessiond_stream(sock
, stream
);
487 /* Tell sessiond there is no more stream. */
488 ret
= ustctl_send_stream_to_sessiond(sock
, NULL
);
493 DBG("UST consumer NULL stream sent to sessiond");
498 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
505 * Creates a channel and streams and add the channel it to the channel internal
506 * state. The created stream must ONLY be sent once the GET_CHANNEL command is
509 * Return 0 on success or else, a negative value is returned and the channel
510 * MUST be destroyed by consumer_del_channel().
512 static int ask_channel(struct lttng_consumer_local_data
*ctx
, int sock
,
513 struct lttng_consumer_channel
*channel
,
514 struct ustctl_consumer_channel_attr
*attr
)
523 * This value is still used by the kernel consumer since for the kernel,
524 * the stream ownership is not IN the consumer so we need to have the
525 * number of left stream that needs to be initialized so we can know when
526 * to delete the channel (see consumer.c).
528 * As for the user space tracer now, the consumer creates and sends the
529 * stream to the session daemon which only sends them to the application
530 * once every stream of a channel is received making this value useless
531 * because we they will be added to the poll thread before the application
532 * receives them. This ensures that a stream can not hang up during
533 * initilization of a channel.
535 channel
->nb_init_stream_left
= 0;
537 /* The reply msg status is handled in the following call. */
538 ret
= create_ust_channel(attr
, &channel
->uchan
);
543 channel
->wait_fd
= ustctl_channel_get_wait_fd(channel
->uchan
);
546 * For the snapshots (no monitor), we create the metadata streams
547 * on demand, not during the channel creation.
549 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
&& !channel
->monitor
) {
554 /* Open all streams for this channel. */
555 ret
= create_ust_streams(channel
, ctx
);
565 * Send all stream of a channel to the right thread handling it.
567 * On error, return a negative value else 0 on success.
569 static int send_streams_to_thread(struct lttng_consumer_channel
*channel
,
570 struct lttng_consumer_local_data
*ctx
)
573 struct lttng_consumer_stream
*stream
, *stmp
;
578 /* Send streams to the corresponding thread. */
579 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
582 health_code_update();
584 /* Sending the stream to the thread. */
585 ret
= send_stream_to_thread(stream
, ctx
);
588 * If we are unable to send the stream to the thread, there is
589 * a big problem so just stop everything.
591 /* Remove node from the channel stream list. */
592 cds_list_del(&stream
->send_node
);
596 /* Remove node from the channel stream list. */
597 cds_list_del(&stream
->send_node
);
606 * Flush channel's streams using the given key to retrieve the channel.
608 * Return 0 on success else an LTTng error code.
610 static int flush_channel(uint64_t chan_key
)
613 struct lttng_consumer_channel
*channel
;
614 struct lttng_consumer_stream
*stream
;
616 struct lttng_ht_iter iter
;
618 DBG("UST consumer flush channel key %" PRIu64
, chan_key
);
621 channel
= consumer_find_channel(chan_key
);
623 ERR("UST consumer flush channel %" PRIu64
" not found", chan_key
);
624 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
628 ht
= consumer_data
.stream_per_chan_id_ht
;
630 /* For each stream of the channel id, flush it. */
631 cds_lfht_for_each_entry_duplicate(ht
->ht
,
632 ht
->hash_fct(&channel
->key
, lttng_ht_seed
), ht
->match_fct
,
633 &channel
->key
, &iter
.iter
, stream
, node_channel_id
.node
) {
635 health_code_update();
637 ustctl_flush_buffer(stream
->ustream
, 1);
644 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
645 * RCU read side lock MUST be acquired before calling this function.
647 * NOTE: This function does NOT take any channel nor stream lock.
649 * Return 0 on success else LTTng error code.
651 static int _close_metadata(struct lttng_consumer_channel
*channel
)
653 int ret
= LTTCOMM_CONSUMERD_SUCCESS
;
656 assert(channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
);
658 if (channel
->switch_timer_enabled
== 1) {
659 DBG("Deleting timer on metadata channel");
660 consumer_timer_switch_stop(channel
);
663 if (channel
->metadata_stream
) {
664 ret
= ustctl_stream_close_wakeup_fd(channel
->metadata_stream
->ustream
);
666 ERR("UST consumer unable to close fd of metadata (ret: %d)", ret
);
667 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
670 if (channel
->monitor
) {
671 /* Close the read-side in consumer_del_metadata_stream */
672 ret
= close(channel
->metadata_stream
->ust_metadata_poll_pipe
[1]);
674 PERROR("Close UST metadata write-side poll pipe");
675 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
684 * Close metadata stream wakeup_fd using the given key to retrieve the channel.
685 * RCU read side lock MUST be acquired before calling this function.
687 * Return 0 on success else an LTTng error code.
689 static int close_metadata(uint64_t chan_key
)
692 struct lttng_consumer_channel
*channel
;
694 DBG("UST consumer close metadata key %" PRIu64
, chan_key
);
696 channel
= consumer_find_channel(chan_key
);
699 * This is possible if the metadata thread has issue a delete because
700 * the endpoint point of the stream hung up. There is no way the
701 * session daemon can know about it thus use a DBG instead of an actual
704 DBG("UST consumer close metadata %" PRIu64
" not found", chan_key
);
705 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
709 pthread_mutex_lock(&consumer_data
.lock
);
710 pthread_mutex_lock(&channel
->lock
);
712 if (cds_lfht_is_node_deleted(&channel
->node
.node
)) {
716 ret
= _close_metadata(channel
);
719 pthread_mutex_unlock(&channel
->lock
);
720 pthread_mutex_unlock(&consumer_data
.lock
);
726 * RCU read side lock MUST be acquired before calling this function.
728 * Return 0 on success else an LTTng error code.
730 static int setup_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t key
)
733 struct lttng_consumer_channel
*metadata
;
735 DBG("UST consumer setup metadata key %" PRIu64
, key
);
737 metadata
= consumer_find_channel(key
);
739 ERR("UST consumer push metadata %" PRIu64
" not found", key
);
740 ret
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
745 * In no monitor mode, the metadata channel has no stream(s) so skip the
746 * ownership transfer to the metadata thread.
748 if (!metadata
->monitor
) {
749 DBG("Metadata channel in no monitor");
755 * Send metadata stream to relayd if one available. Availability is
756 * known if the stream is still in the list of the channel.
758 if (cds_list_empty(&metadata
->streams
.head
)) {
759 ERR("Metadata channel key %" PRIu64
", no stream available.", key
);
760 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
761 goto error_no_stream
;
764 /* Send metadata stream to relayd if needed. */
765 if (metadata
->metadata_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
766 ret
= consumer_send_relayd_stream(metadata
->metadata_stream
,
769 ret
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
774 ret
= send_streams_to_thread(metadata
, ctx
);
777 * If we are unable to send the stream to the thread, there is
778 * a big problem so just stop everything.
780 ret
= LTTCOMM_CONSUMERD_FATAL
;
783 /* List MUST be empty after or else it could be reused. */
784 assert(cds_list_empty(&metadata
->streams
.head
));
791 * Delete metadata channel on error. At this point, the metadata stream can
792 * NOT be monitored by the metadata thread thus having the guarantee that
793 * the stream is still in the local stream list of the channel. This call
794 * will make sure to clean that list.
796 cds_list_del(&metadata
->metadata_stream
->send_node
);
797 consumer_stream_destroy(metadata
->metadata_stream
, NULL
);
804 * Snapshot the whole metadata.
806 * Returns 0 on success, < 0 on error
808 static int snapshot_metadata(uint64_t key
, char *path
, uint64_t relayd_id
,
809 struct lttng_consumer_local_data
*ctx
)
812 struct lttng_consumer_channel
*metadata_channel
;
813 struct lttng_consumer_stream
*metadata_stream
;
818 DBG("UST consumer snapshot metadata with key %" PRIu64
" at path %s",
823 metadata_channel
= consumer_find_channel(key
);
824 if (!metadata_channel
) {
825 ERR("UST snapshot metadata channel not found for key %" PRIu64
,
830 assert(!metadata_channel
->monitor
);
832 health_code_update();
835 * Ask the sessiond if we have new metadata waiting and update the
836 * consumer metadata cache.
838 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata_channel
, 0, 1);
843 health_code_update();
846 * The metadata stream is NOT created in no monitor mode when the channel
847 * is created on a sessiond ask channel command.
849 ret
= create_ust_streams(metadata_channel
, ctx
);
854 metadata_stream
= metadata_channel
->metadata_stream
;
855 assert(metadata_stream
);
857 if (relayd_id
!= (uint64_t) -1ULL) {
858 metadata_stream
->net_seq_idx
= relayd_id
;
859 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
864 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
865 metadata_stream
->chan
->tracefile_size
,
866 metadata_stream
->tracefile_count_current
,
867 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
871 metadata_stream
->out_fd
= ret
;
872 metadata_stream
->tracefile_size_current
= 0;
876 health_code_update();
878 ret
= lttng_consumer_read_subbuffer(metadata_stream
, ctx
);
886 * Clean up the stream completly because the next snapshot will use a new
889 cds_list_del(&metadata_stream
->send_node
);
890 consumer_stream_destroy(metadata_stream
, NULL
);
891 metadata_channel
->metadata_stream
= NULL
;
899 * Take a snapshot of all the stream of a channel.
901 * Returns 0 on success, < 0 on error
903 static int snapshot_channel(uint64_t key
, char *path
, uint64_t relayd_id
,
904 uint64_t max_stream_size
, struct lttng_consumer_local_data
*ctx
)
907 unsigned use_relayd
= 0;
908 unsigned long consumed_pos
, produced_pos
;
909 struct lttng_consumer_channel
*channel
;
910 struct lttng_consumer_stream
*stream
;
917 if (relayd_id
!= (uint64_t) -1ULL) {
921 channel
= consumer_find_channel(key
);
923 ERR("UST snapshot channel not found for key %" PRIu64
, key
);
927 assert(!channel
->monitor
);
928 DBG("UST consumer snapshot channel %" PRIu64
, key
);
930 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
932 health_code_update();
934 /* Lock stream because we are about to change its state. */
935 pthread_mutex_lock(&stream
->lock
);
936 stream
->net_seq_idx
= relayd_id
;
939 ret
= consumer_send_relayd_stream(stream
, path
);
944 ret
= utils_create_stream_file(path
, stream
->name
,
945 stream
->chan
->tracefile_size
,
946 stream
->tracefile_count_current
,
947 stream
->uid
, stream
->gid
, NULL
);
951 stream
->out_fd
= ret
;
952 stream
->tracefile_size_current
= 0;
954 DBG("UST consumer snapshot stream %s/%s (%" PRIu64
")", path
,
955 stream
->name
, stream
->key
);
957 if (relayd_id
!= -1ULL) {
958 ret
= consumer_send_relayd_streams_sent(relayd_id
);
964 ustctl_flush_buffer(stream
->ustream
, 1);
966 ret
= lttng_ustconsumer_take_snapshot(stream
);
968 ERR("Taking UST snapshot");
972 ret
= lttng_ustconsumer_get_produced_snapshot(stream
, &produced_pos
);
974 ERR("Produced UST snapshot position");
978 ret
= lttng_ustconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
980 ERR("Consumerd UST snapshot position");
985 * The original value is sent back if max stream size is larger than
986 * the possible size of the snapshot. Also, we asume that the session
987 * daemon should never send a maximum stream size that is lower than
990 consumed_pos
= consumer_get_consumed_maxsize(consumed_pos
,
991 produced_pos
, max_stream_size
);
993 while (consumed_pos
< produced_pos
) {
995 unsigned long len
, padded_len
;
997 health_code_update();
999 DBG("UST consumer taking snapshot at pos %lu", consumed_pos
);
1001 ret
= ustctl_get_subbuf(stream
->ustream
, &consumed_pos
);
1003 if (ret
!= -EAGAIN
) {
1004 PERROR("ustctl_get_subbuf snapshot");
1005 goto error_close_stream
;
1007 DBG("UST consumer get subbuf failed. Skipping it.");
1008 consumed_pos
+= stream
->max_sb_size
;
1012 ret
= ustctl_get_subbuf_size(stream
->ustream
, &len
);
1014 ERR("Snapshot ustctl_get_subbuf_size");
1015 goto error_put_subbuf
;
1018 ret
= ustctl_get_padded_subbuf_size(stream
->ustream
, &padded_len
);
1020 ERR("Snapshot ustctl_get_padded_subbuf_size");
1021 goto error_put_subbuf
;
1024 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
1025 padded_len
- len
, NULL
);
1027 if (read_len
!= len
) {
1029 goto error_put_subbuf
;
1032 if (read_len
!= padded_len
) {
1034 goto error_put_subbuf
;
1038 ret
= ustctl_put_subbuf(stream
->ustream
);
1040 ERR("Snapshot ustctl_put_subbuf");
1041 goto error_close_stream
;
1043 consumed_pos
+= stream
->max_sb_size
;
1046 /* Simply close the stream so we can use it on the next snapshot. */
1047 consumer_stream_close(stream
);
1048 pthread_mutex_unlock(&stream
->lock
);
1055 if (ustctl_put_subbuf(stream
->ustream
) < 0) {
1056 ERR("Snapshot ustctl_put_subbuf");
1059 consumer_stream_close(stream
);
1061 pthread_mutex_unlock(&stream
->lock
);
1068 * Receive the metadata updates from the sessiond.
1070 int lttng_ustconsumer_recv_metadata(int sock
, uint64_t key
, uint64_t offset
,
1071 uint64_t len
, struct lttng_consumer_channel
*channel
,
1072 int timer
, int wait
)
1074 int ret
, ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1077 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
, len
);
1079 metadata_str
= zmalloc(len
* sizeof(char));
1080 if (!metadata_str
) {
1081 PERROR("zmalloc metadata string");
1082 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
1086 health_code_update();
1088 /* Receive metadata string. */
1089 ret
= lttcomm_recv_unix_sock(sock
, metadata_str
, len
);
1091 /* Session daemon is dead so return gracefully. */
1096 health_code_update();
1098 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
1099 ret
= consumer_metadata_cache_write(channel
, offset
, len
, metadata_str
);
1101 /* Unable to handle metadata. Notify session daemon. */
1102 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
1104 * Skip metadata flush on write error since the offset and len might
1105 * not have been updated which could create an infinite loop below when
1106 * waiting for the metadata cache to be flushed.
1108 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1111 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
1116 while (consumer_metadata_cache_flushed(channel
, offset
+ len
, timer
)) {
1117 DBG("Waiting for metadata to be flushed");
1119 health_code_update();
1121 usleep(DEFAULT_METADATA_AVAILABILITY_WAIT_TIME
);
1131 * Receive command from session daemon and process it.
1133 * Return 1 on success else a negative value or 0.
1135 int lttng_ustconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1136 int sock
, struct pollfd
*consumer_sockpoll
)
1139 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1140 struct lttcomm_consumer_msg msg
;
1141 struct lttng_consumer_channel
*channel
= NULL
;
1143 health_code_update();
1145 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
1146 if (ret
!= sizeof(msg
)) {
1147 DBG("Consumer received unexpected message size %zd (expects %zu)",
1150 * The ret value might 0 meaning an orderly shutdown but this is ok
1151 * since the caller handles this.
1154 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
1160 health_code_update();
1162 if (msg
.cmd_type
== LTTNG_CONSUMER_STOP
) {
1164 * Notify the session daemon that the command is completed.
1166 * On transport layer error, the function call will print an error
1167 * message so handling the returned code is a bit useless since we
1168 * return an error code anyway.
1170 (void) consumer_send_status_msg(sock
, ret_code
);
1174 health_code_update();
1176 /* relayd needs RCU read-side lock */
1179 switch (msg
.cmd_type
) {
1180 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
1182 /* Session daemon status message are handled in the following call. */
1183 ret
= consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
1184 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
1185 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
1186 msg
.u
.relayd_sock
.relayd_session_id
);
1189 case LTTNG_CONSUMER_DESTROY_RELAYD
:
1191 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
1192 struct consumer_relayd_sock_pair
*relayd
;
1194 DBG("UST consumer destroying relayd %" PRIu64
, index
);
1196 /* Get relayd reference if exists. */
1197 relayd
= consumer_find_relayd(index
);
1198 if (relayd
== NULL
) {
1199 DBG("Unable to find relayd %" PRIu64
, index
);
1200 ret_code
= LTTNG_ERR_NO_CONSUMER
;
1204 * Each relayd socket pair has a refcount of stream attached to it
1205 * which tells if the relayd is still active or not depending on the
1208 * This will set the destroy flag of the relayd object and destroy it
1209 * if the refcount reaches zero when called.
1211 * The destroy can happen either here or when a stream fd hangs up.
1214 consumer_flag_relayd_for_destroy(relayd
);
1217 goto end_msg_sessiond
;
1219 case LTTNG_CONSUMER_UPDATE_STREAM
:
1224 case LTTNG_CONSUMER_DATA_PENDING
:
1226 int ret
, is_data_pending
;
1227 uint64_t id
= msg
.u
.data_pending
.session_id
;
1229 DBG("UST consumer data pending command for id %" PRIu64
, id
);
1231 is_data_pending
= consumer_data_pending(id
);
1233 /* Send back returned value to session daemon */
1234 ret
= lttcomm_send_unix_sock(sock
, &is_data_pending
,
1235 sizeof(is_data_pending
));
1237 DBG("Error when sending the data pending ret code: %d", ret
);
1242 * No need to send back a status message since the data pending
1243 * returned value is the response.
1247 case LTTNG_CONSUMER_ASK_CHANNEL_CREATION
:
1250 struct ustctl_consumer_channel_attr attr
;
1252 /* Create a plain object and reserve a channel key. */
1253 channel
= allocate_channel(msg
.u
.ask_channel
.session_id
,
1254 msg
.u
.ask_channel
.pathname
, msg
.u
.ask_channel
.name
,
1255 msg
.u
.ask_channel
.uid
, msg
.u
.ask_channel
.gid
,
1256 msg
.u
.ask_channel
.relayd_id
, msg
.u
.ask_channel
.key
,
1257 (enum lttng_event_output
) msg
.u
.ask_channel
.output
,
1258 msg
.u
.ask_channel
.tracefile_size
,
1259 msg
.u
.ask_channel
.tracefile_count
,
1260 msg
.u
.ask_channel
.session_id_per_pid
,
1261 msg
.u
.ask_channel
.monitor
,
1262 msg
.u
.ask_channel
.live_timer_interval
);
1264 goto end_channel_error
;
1268 * Assign UST application UID to the channel. This value is ignored for
1269 * per PID buffers. This is specific to UST thus setting this after the
1272 channel
->ust_app_uid
= msg
.u
.ask_channel
.ust_app_uid
;
1274 /* Build channel attributes from received message. */
1275 attr
.subbuf_size
= msg
.u
.ask_channel
.subbuf_size
;
1276 attr
.num_subbuf
= msg
.u
.ask_channel
.num_subbuf
;
1277 attr
.overwrite
= msg
.u
.ask_channel
.overwrite
;
1278 attr
.switch_timer_interval
= msg
.u
.ask_channel
.switch_timer_interval
;
1279 attr
.read_timer_interval
= msg
.u
.ask_channel
.read_timer_interval
;
1280 attr
.chan_id
= msg
.u
.ask_channel
.chan_id
;
1281 memcpy(attr
.uuid
, msg
.u
.ask_channel
.uuid
, sizeof(attr
.uuid
));
1283 /* Match channel buffer type to the UST abi. */
1284 switch (msg
.u
.ask_channel
.output
) {
1285 case LTTNG_EVENT_MMAP
:
1287 attr
.output
= LTTNG_UST_MMAP
;
1291 /* Translate and save channel type. */
1292 switch (msg
.u
.ask_channel
.type
) {
1293 case LTTNG_UST_CHAN_PER_CPU
:
1294 channel
->type
= CONSUMER_CHANNEL_TYPE_DATA
;
1295 attr
.type
= LTTNG_UST_CHAN_PER_CPU
;
1297 * Set refcount to 1 for owner. Below, we will
1298 * pass ownership to the
1299 * consumer_thread_channel_poll() thread.
1301 channel
->refcount
= 1;
1303 case LTTNG_UST_CHAN_METADATA
:
1304 channel
->type
= CONSUMER_CHANNEL_TYPE_METADATA
;
1305 attr
.type
= LTTNG_UST_CHAN_METADATA
;
1312 health_code_update();
1314 ret
= ask_channel(ctx
, sock
, channel
, &attr
);
1316 goto end_channel_error
;
1319 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1320 ret
= consumer_metadata_cache_allocate(channel
);
1322 ERR("Allocating metadata cache");
1323 goto end_channel_error
;
1325 consumer_timer_switch_start(channel
, attr
.switch_timer_interval
);
1326 attr
.switch_timer_interval
= 0;
1328 consumer_timer_live_start(channel
,
1329 msg
.u
.ask_channel
.live_timer_interval
);
1332 health_code_update();
1335 * Add the channel to the internal state AFTER all streams were created
1336 * and successfully sent to session daemon. This way, all streams must
1337 * be ready before this channel is visible to the threads.
1338 * If add_channel succeeds, ownership of the channel is
1339 * passed to consumer_thread_channel_poll().
1341 ret
= add_channel(channel
, ctx
);
1343 if (msg
.u
.ask_channel
.type
== LTTNG_UST_CHAN_METADATA
) {
1344 if (channel
->switch_timer_enabled
== 1) {
1345 consumer_timer_switch_stop(channel
);
1347 consumer_metadata_cache_destroy(channel
);
1349 if (channel
->live_timer_enabled
== 1) {
1350 consumer_timer_live_stop(channel
);
1352 goto end_channel_error
;
1355 health_code_update();
1358 * Channel and streams are now created. Inform the session daemon that
1359 * everything went well and should wait to receive the channel and
1360 * streams with ustctl API.
1362 ret
= consumer_send_status_channel(sock
, channel
);
1365 * There is probably a problem on the socket.
1372 case LTTNG_CONSUMER_GET_CHANNEL
:
1374 int ret
, relayd_err
= 0;
1375 uint64_t key
= msg
.u
.get_channel
.key
;
1376 struct lttng_consumer_channel
*channel
;
1378 channel
= consumer_find_channel(key
);
1380 ERR("UST consumer get channel key %" PRIu64
" not found", key
);
1381 ret_code
= LTTNG_ERR_UST_CHAN_NOT_FOUND
;
1382 goto end_msg_sessiond
;
1385 health_code_update();
1387 /* Send everything to sessiond. */
1388 ret
= send_sessiond_channel(sock
, channel
, ctx
, &relayd_err
);
1392 * We were unable to send to the relayd the stream so avoid
1393 * sending back a fatal error to the thread since this is OK
1394 * and the consumer can continue its work. The above call
1395 * has sent the error status message to the sessiond.
1400 * The communicaton was broken hence there is a bad state between
1401 * the consumer and sessiond so stop everything.
1406 health_code_update();
1409 * In no monitor mode, the streams ownership is kept inside the channel
1410 * so don't send them to the data thread.
1412 if (!channel
->monitor
) {
1413 goto end_msg_sessiond
;
1416 ret
= send_streams_to_thread(channel
, ctx
);
1419 * If we are unable to send the stream to the thread, there is
1420 * a big problem so just stop everything.
1424 /* List MUST be empty after or else it could be reused. */
1425 assert(cds_list_empty(&channel
->streams
.head
));
1426 goto end_msg_sessiond
;
1428 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
1430 uint64_t key
= msg
.u
.destroy_channel
.key
;
1433 * Only called if streams have not been sent to stream
1434 * manager thread. However, channel has been sent to
1435 * channel manager thread.
1437 notify_thread_del_channel(ctx
, key
);
1438 goto end_msg_sessiond
;
1440 case LTTNG_CONSUMER_CLOSE_METADATA
:
1444 ret
= close_metadata(msg
.u
.close_metadata
.key
);
1449 goto end_msg_sessiond
;
1451 case LTTNG_CONSUMER_FLUSH_CHANNEL
:
1455 ret
= flush_channel(msg
.u
.flush_channel
.key
);
1460 goto end_msg_sessiond
;
1462 case LTTNG_CONSUMER_PUSH_METADATA
:
1465 uint64_t len
= msg
.u
.push_metadata
.len
;
1466 uint64_t key
= msg
.u
.push_metadata
.key
;
1467 uint64_t offset
= msg
.u
.push_metadata
.target_offset
;
1468 struct lttng_consumer_channel
*channel
;
1470 DBG("UST consumer push metadata key %" PRIu64
" of len %" PRIu64
, key
,
1473 channel
= consumer_find_channel(key
);
1476 * This is possible if the metadata creation on the consumer side
1477 * is in flight vis-a-vis a concurrent push metadata from the
1478 * session daemon. Simply return that the channel failed and the
1479 * session daemon will handle that message correctly considering
1480 * that this race is acceptable thus the DBG() statement here.
1482 DBG("UST consumer push metadata %" PRIu64
" not found", key
);
1483 ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
1484 goto end_msg_sessiond
;
1487 health_code_update();
1489 /* Tell session daemon we are ready to receive the metadata. */
1490 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
1492 /* Somehow, the session daemon is not responding anymore. */
1496 health_code_update();
1498 /* Wait for more data. */
1499 health_poll_entry();
1500 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
1506 health_code_update();
1508 ret
= lttng_ustconsumer_recv_metadata(sock
, key
, offset
,
1509 len
, channel
, 0, 1);
1511 /* error receiving from sessiond */
1515 goto end_msg_sessiond
;
1518 case LTTNG_CONSUMER_SETUP_METADATA
:
1522 ret
= setup_metadata(ctx
, msg
.u
.setup_metadata
.key
);
1526 goto end_msg_sessiond
;
1528 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
1530 if (msg
.u
.snapshot_channel
.metadata
) {
1531 ret
= snapshot_metadata(msg
.u
.snapshot_channel
.key
,
1532 msg
.u
.snapshot_channel
.pathname
,
1533 msg
.u
.snapshot_channel
.relayd_id
,
1536 ERR("Snapshot metadata failed");
1537 ret_code
= LTTNG_ERR_UST_META_FAIL
;
1540 ret
= snapshot_channel(msg
.u
.snapshot_channel
.key
,
1541 msg
.u
.snapshot_channel
.pathname
,
1542 msg
.u
.snapshot_channel
.relayd_id
,
1543 msg
.u
.snapshot_channel
.max_stream_size
,
1546 ERR("Snapshot channel failed");
1547 ret_code
= LTTNG_ERR_UST_CHAN_FAIL
;
1551 health_code_update();
1552 ret
= consumer_send_status_msg(sock
, ret_code
);
1554 /* Somehow, the session daemon is not responding anymore. */
1557 health_code_update();
1567 health_code_update();
1570 * Return 1 to indicate success since the 0 value can be a socket
1571 * shutdown during the recv() or send() call.
1577 * The returned value here is not useful since either way we'll return 1 to
1578 * the caller because the session daemon socket management is done
1579 * elsewhere. Returning a negative code or 0 will shutdown the consumer.
1581 ret
= consumer_send_status_msg(sock
, ret_code
);
1587 health_code_update();
1593 * Free channel here since no one has a reference to it. We don't
1594 * free after that because a stream can store this pointer.
1596 destroy_channel(channel
);
1598 /* We have to send a status channel message indicating an error. */
1599 ret
= consumer_send_status_channel(sock
, NULL
);
1601 /* Stop everything if session daemon can not be notified. */
1606 health_code_update();
1611 /* This will issue a consumer stop. */
1616 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1617 * compiled out, we isolate it in this library.
1619 int lttng_ustctl_get_mmap_read_offset(struct lttng_consumer_stream
*stream
,
1623 assert(stream
->ustream
);
1625 return ustctl_get_mmap_read_offset(stream
->ustream
, off
);
1629 * Wrapper over the mmap() read offset from ust-ctl library. Since this can be
1630 * compiled out, we isolate it in this library.
1632 void *lttng_ustctl_get_mmap_base(struct lttng_consumer_stream
*stream
)
1635 assert(stream
->ustream
);
1637 return ustctl_get_mmap_base(stream
->ustream
);
1641 * Take a snapshot for a specific fd
1643 * Returns 0 on success, < 0 on error
1645 int lttng_ustconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1648 assert(stream
->ustream
);
1650 return ustctl_snapshot(stream
->ustream
);
1654 * Get the produced position
1656 * Returns 0 on success, < 0 on error
1658 int lttng_ustconsumer_get_produced_snapshot(
1659 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1662 assert(stream
->ustream
);
1665 return ustctl_snapshot_get_produced(stream
->ustream
, pos
);
1669 * Get the consumed position
1671 * Returns 0 on success, < 0 on error
1673 int lttng_ustconsumer_get_consumed_snapshot(
1674 struct lttng_consumer_stream
*stream
, unsigned long *pos
)
1677 assert(stream
->ustream
);
1680 return ustctl_snapshot_get_consumed(stream
->ustream
, pos
);
1683 void lttng_ustconsumer_flush_buffer(struct lttng_consumer_stream
*stream
,
1687 assert(stream
->ustream
);
1689 ustctl_flush_buffer(stream
->ustream
, producer
);
1692 int lttng_ustconsumer_get_current_timestamp(
1693 struct lttng_consumer_stream
*stream
, uint64_t *ts
)
1696 assert(stream
->ustream
);
1699 return ustctl_get_current_timestamp(stream
->ustream
, ts
);
1703 * Called when the stream signal the consumer that it has hang up.
1705 void lttng_ustconsumer_on_stream_hangup(struct lttng_consumer_stream
*stream
)
1708 assert(stream
->ustream
);
1710 ustctl_flush_buffer(stream
->ustream
, 0);
1711 stream
->hangup_flush_done
= 1;
1714 void lttng_ustconsumer_del_channel(struct lttng_consumer_channel
*chan
)
1717 assert(chan
->uchan
);
1719 if (chan
->switch_timer_enabled
== 1) {
1720 consumer_timer_switch_stop(chan
);
1722 consumer_metadata_cache_destroy(chan
);
1723 ustctl_destroy_channel(chan
->uchan
);
1726 void lttng_ustconsumer_del_stream(struct lttng_consumer_stream
*stream
)
1729 assert(stream
->ustream
);
1731 if (stream
->chan
->switch_timer_enabled
== 1) {
1732 consumer_timer_switch_stop(stream
->chan
);
1734 ustctl_destroy_stream(stream
->ustream
);
1738 * Populate index values of a UST stream. Values are set in big endian order.
1740 * Return 0 on success or else a negative value.
1742 static int get_index_values(struct ctf_packet_index
*index
,
1743 struct ustctl_consumer_stream
*ustream
)
1747 ret
= ustctl_get_timestamp_begin(ustream
, &index
->timestamp_begin
);
1749 PERROR("ustctl_get_timestamp_begin");
1752 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1754 ret
= ustctl_get_timestamp_end(ustream
, &index
->timestamp_end
);
1756 PERROR("ustctl_get_timestamp_end");
1759 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1761 ret
= ustctl_get_events_discarded(ustream
, &index
->events_discarded
);
1763 PERROR("ustctl_get_events_discarded");
1766 index
->events_discarded
= htobe64(index
->events_discarded
);
1768 ret
= ustctl_get_content_size(ustream
, &index
->content_size
);
1770 PERROR("ustctl_get_content_size");
1773 index
->content_size
= htobe64(index
->content_size
);
1775 ret
= ustctl_get_packet_size(ustream
, &index
->packet_size
);
1777 PERROR("ustctl_get_packet_size");
1780 index
->packet_size
= htobe64(index
->packet_size
);
1782 ret
= ustctl_get_stream_id(ustream
, &index
->stream_id
);
1784 PERROR("ustctl_get_stream_id");
1787 index
->stream_id
= htobe64(index
->stream_id
);
1794 * Write up to one packet from the metadata cache to the channel.
1796 * Returns the number of bytes pushed in the cache, or a negative value
1800 int commit_one_metadata_packet(struct lttng_consumer_stream
*stream
)
1805 pthread_mutex_lock(&stream
->chan
->metadata_cache
->lock
);
1806 if (stream
->chan
->metadata_cache
->contiguous
1807 == stream
->ust_metadata_pushed
) {
1812 write_len
= ustctl_write_one_packet_to_channel(stream
->chan
->uchan
,
1813 &stream
->chan
->metadata_cache
->data
[stream
->ust_metadata_pushed
],
1814 stream
->chan
->metadata_cache
->contiguous
1815 - stream
->ust_metadata_pushed
);
1816 assert(write_len
!= 0);
1817 if (write_len
< 0) {
1818 ERR("Writing one metadata packet");
1822 stream
->ust_metadata_pushed
+= write_len
;
1824 assert(stream
->chan
->metadata_cache
->contiguous
>=
1825 stream
->ust_metadata_pushed
);
1829 pthread_mutex_unlock(&stream
->chan
->metadata_cache
->lock
);
1835 * Sync metadata meaning request them to the session daemon and snapshot to the
1836 * metadata thread can consumer them.
1838 * Metadata stream lock MUST be acquired.
1840 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1841 * is empty or a negative value on error.
1843 int lttng_ustconsumer_sync_metadata(struct lttng_consumer_local_data
*ctx
,
1844 struct lttng_consumer_stream
*metadata
)
1853 * Request metadata from the sessiond, but don't wait for the flush
1854 * because we locked the metadata thread.
1856 ret
= lttng_ustconsumer_request_metadata(ctx
, metadata
->chan
, 0, 0);
1861 ret
= commit_one_metadata_packet(metadata
);
1864 } else if (ret
> 0) {
1868 ustctl_flush_buffer(metadata
->ustream
, 1);
1869 ret
= ustctl_snapshot(metadata
->ustream
);
1871 if (errno
!= EAGAIN
) {
1872 ERR("Sync metadata, taking UST snapshot");
1875 DBG("No new metadata when syncing them.");
1876 /* No new metadata, exit. */
1882 * After this flush, we still need to extract metadata.
1893 * Read subbuffer from the given stream.
1895 * Stream lock MUST be acquired.
1897 * Return 0 on success else a negative value.
1899 int lttng_ustconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1900 struct lttng_consumer_local_data
*ctx
)
1902 unsigned long len
, subbuf_size
, padding
;
1903 int err
, write_index
= 1;
1906 struct ustctl_consumer_stream
*ustream
;
1907 struct ctf_packet_index index
;
1910 assert(stream
->ustream
);
1913 DBG("In UST read_subbuffer (wait_fd: %d, name: %s)", stream
->wait_fd
,
1916 /* Ease our life for what's next. */
1917 ustream
= stream
->ustream
;
1920 * We can consume the 1 byte written into the wait_fd by UST.
1921 * Don't trigger error if we cannot read this one byte (read
1922 * returns 0), or if the error is EAGAIN or EWOULDBLOCK.
1924 if (stream
->monitor
&& !stream
->hangup_flush_done
) {
1927 readlen
= lttng_read(stream
->wait_fd
, &dummy
, 1);
1928 if (readlen
< 0 && errno
!= EAGAIN
&& errno
!= EWOULDBLOCK
) {
1935 /* Get the next subbuffer */
1936 err
= ustctl_get_next_subbuf(ustream
);
1939 * Populate metadata info if the existing info has
1940 * already been read.
1942 if (stream
->metadata_flag
) {
1943 ret
= commit_one_metadata_packet(stream
);
1947 ustctl_flush_buffer(stream
->ustream
, 1);
1951 ret
= err
; /* ustctl_get_next_subbuf returns negative, caller expect positive. */
1953 * This is a debug message even for single-threaded consumer,
1954 * because poll() have more relaxed criterions than get subbuf,
1955 * so get_subbuf may fail for short race windows where poll()
1956 * would issue wakeups.
1958 DBG("Reserving sub buffer failed (everything is normal, "
1959 "it is due to concurrency) [ret: %d]", err
);
1962 assert(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1964 if (!stream
->metadata_flag
) {
1965 index
.offset
= htobe64(stream
->out_fd_offset
);
1966 ret
= get_index_values(&index
, ustream
);
1974 /* Get the full padded subbuffer size */
1975 err
= ustctl_get_padded_subbuf_size(ustream
, &len
);
1978 /* Get subbuffer data size (without padding) */
1979 err
= ustctl_get_subbuf_size(ustream
, &subbuf_size
);
1982 /* Make sure we don't get a subbuffer size bigger than the padded */
1983 assert(len
>= subbuf_size
);
1985 padding
= len
- subbuf_size
;
1986 /* write the subbuffer to the tracefile */
1987 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
, padding
, &index
);
1989 * The mmap operation should write subbuf_size amount of data when network
1990 * streaming or the full padding (len) size when we are _not_ streaming.
1992 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1993 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1995 * Display the error but continue processing to try to release the
1996 * subbuffer. This is a DBG statement since any unexpected kill or
1997 * signal, the application gets unregistered, relayd gets closed or
1998 * anything that affects the buffer lifetime will trigger this error.
1999 * So, for the sake of the user, don't print this error since it can
2000 * happen and it is OK with the code flow.
2002 DBG("Error writing to tracefile "
2003 "(ret: %ld != len: %lu != subbuf_size: %lu)",
2004 ret
, len
, subbuf_size
);
2007 err
= ustctl_put_next_subbuf(ustream
);
2010 /* Write index if needed. */
2015 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
2017 * In live, block until all the metadata is sent.
2019 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
2025 assert(!stream
->metadata_flag
);
2026 err
= consumer_stream_write_index(stream
, &index
);
2036 * Called when a stream is created.
2038 * Return 0 on success or else a negative value.
2040 int lttng_ustconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
2046 /* Don't create anything if this is set for streaming. */
2047 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
2048 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
2049 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
2050 stream
->uid
, stream
->gid
, NULL
);
2054 stream
->out_fd
= ret
;
2055 stream
->tracefile_size_current
= 0;
2057 if (!stream
->metadata_flag
) {
2058 ret
= index_create_file(stream
->chan
->pathname
,
2059 stream
->name
, stream
->uid
, stream
->gid
,
2060 stream
->chan
->tracefile_size
,
2061 stream
->tracefile_count_current
);
2065 stream
->index_fd
= ret
;
2075 * Check if data is still being extracted from the buffers for a specific
2076 * stream. Consumer data lock MUST be acquired before calling this function
2077 * and the stream lock.
2079 * Return 1 if the traced data are still getting read else 0 meaning that the
2080 * data is available for trace viewer reading.
2082 int lttng_ustconsumer_data_pending(struct lttng_consumer_stream
*stream
)
2087 assert(stream
->ustream
);
2089 DBG("UST consumer checking data pending");
2091 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
2096 if (stream
->chan
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
2097 uint64_t contiguous
, pushed
;
2099 /* Ease our life a bit. */
2100 contiguous
= stream
->chan
->metadata_cache
->contiguous
;
2101 pushed
= stream
->ust_metadata_pushed
;
2104 * We can simply check whether all contiguously available data
2105 * has been pushed to the ring buffer, since the push operation
2106 * is performed within get_next_subbuf(), and because both
2107 * get_next_subbuf() and put_next_subbuf() are issued atomically
2108 * thanks to the stream lock within
2109 * lttng_ustconsumer_read_subbuffer(). This basically means that
2110 * whetnever ust_metadata_pushed is incremented, the associated
2111 * metadata has been consumed from the metadata stream.
2113 DBG("UST consumer metadata pending check: contiguous %" PRIu64
" vs pushed %" PRIu64
,
2114 contiguous
, pushed
);
2115 assert(((int64_t) contiguous
- pushed
) >= 0);
2116 if ((contiguous
!= pushed
) ||
2117 (((int64_t) contiguous
- pushed
) > 0 || contiguous
== 0)) {
2118 ret
= 1; /* Data is pending */
2122 ret
= ustctl_get_next_subbuf(stream
->ustream
);
2125 * There is still data so let's put back this
2128 ret
= ustctl_put_subbuf(stream
->ustream
);
2130 ret
= 1; /* Data is pending */
2135 /* Data is NOT pending so ready to be read. */
2143 * Close every metadata stream wait fd of the metadata hash table. This
2144 * function MUST be used very carefully so not to run into a race between the
2145 * metadata thread handling streams and this function closing their wait fd.
2147 * For UST, this is used when the session daemon hangs up. Its the metadata
2148 * producer so calling this is safe because we are assured that no state change
2149 * can occur in the metadata thread for the streams in the hash table.
2151 void lttng_ustconsumer_close_metadata(struct lttng_ht
*metadata_ht
)
2153 struct lttng_ht_iter iter
;
2154 struct lttng_consumer_stream
*stream
;
2156 assert(metadata_ht
);
2157 assert(metadata_ht
->ht
);
2159 DBG("UST consumer closing all metadata streams");
2162 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
,
2165 health_code_update();
2167 pthread_mutex_lock(&stream
->chan
->lock
);
2169 * Whatever returned value, we must continue to try to close everything
2172 (void) _close_metadata(stream
->chan
);
2173 DBG("Metadata wait fd %d and poll pipe fd %d closed", stream
->wait_fd
,
2174 stream
->ust_metadata_poll_pipe
[1]);
2175 pthread_mutex_unlock(&stream
->chan
->lock
);
2181 void lttng_ustconsumer_close_stream_wakeup(struct lttng_consumer_stream
*stream
)
2185 ret
= ustctl_stream_close_wakeup_fd(stream
->ustream
);
2187 ERR("Unable to close wakeup fd");
2192 * Please refer to consumer-timer.c before adding any lock within this
2193 * function or any of its callees. Timers have a very strict locking
2194 * semantic with respect to teardown. Failure to respect this semantic
2195 * introduces deadlocks.
2197 int lttng_ustconsumer_request_metadata(struct lttng_consumer_local_data
*ctx
,
2198 struct lttng_consumer_channel
*channel
, int timer
, int wait
)
2200 struct lttcomm_metadata_request_msg request
;
2201 struct lttcomm_consumer_msg msg
;
2202 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
2203 uint64_t len
, key
, offset
;
2207 assert(channel
->metadata_cache
);
2209 /* send the metadata request to sessiond */
2210 switch (consumer_data
.type
) {
2211 case LTTNG_CONSUMER64_UST
:
2212 request
.bits_per_long
= 64;
2214 case LTTNG_CONSUMER32_UST
:
2215 request
.bits_per_long
= 32;
2218 request
.bits_per_long
= 0;
2222 request
.session_id
= channel
->session_id
;
2223 request
.session_id_per_pid
= channel
->session_id_per_pid
;
2225 * Request the application UID here so the metadata of that application can
2226 * be sent back. The channel UID corresponds to the user UID of the session
2227 * used for the rights on the stream file(s).
2229 request
.uid
= channel
->ust_app_uid
;
2230 request
.key
= channel
->key
;
2232 DBG("Sending metadata request to sessiond, session id %" PRIu64
2233 ", per-pid %" PRIu64
", app UID %u and channek key %" PRIu64
,
2234 request
.session_id
, request
.session_id_per_pid
, request
.uid
,
2237 pthread_mutex_lock(&ctx
->metadata_socket_lock
);
2239 health_code_update();
2241 ret
= lttcomm_send_unix_sock(ctx
->consumer_metadata_socket
, &request
,
2244 ERR("Asking metadata to sessiond");
2248 health_code_update();
2250 /* Receive the metadata from sessiond */
2251 ret
= lttcomm_recv_unix_sock(ctx
->consumer_metadata_socket
, &msg
,
2253 if (ret
!= sizeof(msg
)) {
2254 DBG("Consumer received unexpected message size %d (expects %zu)",
2256 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
2258 * The ret value might 0 meaning an orderly shutdown but this is ok
2259 * since the caller handles this.
2264 health_code_update();
2266 if (msg
.cmd_type
== LTTNG_ERR_UND
) {
2267 /* No registry found */
2268 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2272 } else if (msg
.cmd_type
!= LTTNG_CONSUMER_PUSH_METADATA
) {
2273 ERR("Unexpected cmd_type received %d", msg
.cmd_type
);
2278 len
= msg
.u
.push_metadata
.len
;
2279 key
= msg
.u
.push_metadata
.key
;
2280 offset
= msg
.u
.push_metadata
.target_offset
;
2282 assert(key
== channel
->key
);
2284 DBG("No new metadata to receive for key %" PRIu64
, key
);
2287 health_code_update();
2289 /* Tell session daemon we are ready to receive the metadata. */
2290 ret
= consumer_send_status_msg(ctx
->consumer_metadata_socket
,
2291 LTTCOMM_CONSUMERD_SUCCESS
);
2292 if (ret
< 0 || len
== 0) {
2294 * Somehow, the session daemon is not responding anymore or there is
2295 * nothing to receive.
2300 health_code_update();
2302 ret
= lttng_ustconsumer_recv_metadata(ctx
->consumer_metadata_socket
,
2303 key
, offset
, len
, channel
, timer
, wait
);
2306 * Only send the status msg if the sessiond is alive meaning a positive
2309 (void) consumer_send_status_msg(ctx
->consumer_metadata_socket
, ret
);
2314 health_code_update();
2316 pthread_mutex_unlock(&ctx
->metadata_socket_lock
);