2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2017 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 2 only,
8 * as published by the Free Software Foundation.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
27 #include <sys/socket.h>
28 #include <sys/types.h>
33 #include <bin/lttng-consumerd/health-consumerd.h>
34 #include <common/common.h>
35 #include <common/kernel-ctl/kernel-ctl.h>
36 #include <common/sessiond-comm/sessiond-comm.h>
37 #include <common/sessiond-comm/relayd.h>
38 #include <common/compat/fcntl.h>
39 #include <common/compat/endian.h>
40 #include <common/pipe.h>
41 #include <common/relayd/relayd.h>
42 #include <common/utils.h>
43 #include <common/consumer/consumer-stream.h>
44 #include <common/index/index.h>
45 #include <common/consumer/consumer-timer.h>
47 #include "kernel-consumer.h"
49 extern struct lttng_consumer_global_data consumer_data
;
50 extern int consumer_poll_timeout
;
53 * Take a snapshot for a specific fd
55 * Returns 0 on success, < 0 on error
57 int lttng_kconsumer_take_snapshot(struct lttng_consumer_stream
*stream
)
60 int infd
= stream
->wait_fd
;
62 ret
= kernctl_snapshot(infd
);
64 * -EAGAIN is not an error, it just means that there is no data to
67 if (ret
!= 0 && ret
!= -EAGAIN
) {
68 PERROR("Getting sub-buffer snapshot.");
75 * Sample consumed and produced positions for a specific fd.
77 * Returns 0 on success, < 0 on error.
79 int lttng_kconsumer_sample_snapshot_positions(
80 struct lttng_consumer_stream
*stream
)
84 return kernctl_snapshot_sample_positions(stream
->wait_fd
);
88 * Get the produced position
90 * Returns 0 on success, < 0 on error
92 int lttng_kconsumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
96 int infd
= stream
->wait_fd
;
98 ret
= kernctl_snapshot_get_produced(infd
, pos
);
100 PERROR("kernctl_snapshot_get_produced");
107 * Get the consumerd position
109 * Returns 0 on success, < 0 on error
111 int lttng_kconsumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
115 int infd
= stream
->wait_fd
;
117 ret
= kernctl_snapshot_get_consumed(infd
, pos
);
119 PERROR("kernctl_snapshot_get_consumed");
126 * Take a snapshot of all the stream of a channel
128 * Returns 0 on success, < 0 on error
130 int lttng_kconsumer_snapshot_channel(uint64_t key
, char *path
,
131 uint64_t relayd_id
, uint64_t nb_packets_per_stream
,
132 struct lttng_consumer_local_data
*ctx
)
135 struct lttng_consumer_channel
*channel
;
136 struct lttng_consumer_stream
*stream
;
138 DBG("Kernel consumer snapshot channel %" PRIu64
, key
);
142 channel
= consumer_find_channel(key
);
144 ERR("No channel found for key %" PRIu64
, key
);
149 /* Splice is not supported yet for channel snapshot. */
150 if (channel
->output
!= CONSUMER_CHANNEL_MMAP
) {
151 ERR("Unsupported output %d", channel
->output
);
156 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
157 unsigned long consumed_pos
, produced_pos
;
159 health_code_update();
162 * Lock stream because we are about to change its state.
164 pthread_mutex_lock(&stream
->lock
);
167 * Assign the received relayd ID so we can use it for streaming. The streams
168 * are not visible to anyone so this is OK to change it.
170 stream
->net_seq_idx
= relayd_id
;
171 channel
->relayd_id
= relayd_id
;
172 if (relayd_id
!= (uint64_t) -1ULL) {
173 ret
= consumer_send_relayd_stream(stream
, path
);
175 ERR("sending stream to relayd");
179 ret
= utils_create_stream_file(path
, stream
->name
,
180 stream
->chan
->tracefile_size
,
181 stream
->tracefile_count_current
,
182 stream
->uid
, stream
->gid
, NULL
);
184 ERR("utils_create_stream_file");
188 stream
->out_fd
= ret
;
189 stream
->tracefile_size_current
= 0;
191 DBG("Kernel consumer snapshot stream %s/%s (%" PRIu64
")",
192 path
, stream
->name
, stream
->key
);
195 ret
= kernctl_buffer_flush_empty(stream
->wait_fd
);
198 * Doing a buffer flush which does not take into
199 * account empty packets. This is not perfect
200 * for stream intersection, but required as a
201 * fall-back when "flush_empty" is not
202 * implemented by lttng-modules.
204 ret
= kernctl_buffer_flush(stream
->wait_fd
);
206 ERR("Failed to flush kernel stream");
212 ret
= lttng_kconsumer_take_snapshot(stream
);
214 ERR("Taking kernel snapshot");
218 ret
= lttng_kconsumer_get_produced_snapshot(stream
, &produced_pos
);
220 ERR("Produced kernel snapshot position");
224 ret
= lttng_kconsumer_get_consumed_snapshot(stream
, &consumed_pos
);
226 ERR("Consumerd kernel snapshot position");
230 if (stream
->max_sb_size
== 0) {
231 ret
= kernctl_get_max_subbuf_size(stream
->wait_fd
,
232 &stream
->max_sb_size
);
234 ERR("Getting kernel max_sb_size");
239 consumed_pos
= consumer_get_consume_start_pos(consumed_pos
,
240 produced_pos
, nb_packets_per_stream
,
241 stream
->max_sb_size
);
243 while (consumed_pos
< produced_pos
) {
245 unsigned long len
, padded_len
;
247 health_code_update();
249 DBG("Kernel consumer taking snapshot at pos %lu", consumed_pos
);
251 ret
= kernctl_get_subbuf(stream
->wait_fd
, &consumed_pos
);
253 if (ret
!= -EAGAIN
) {
254 PERROR("kernctl_get_subbuf snapshot");
257 DBG("Kernel consumer get subbuf failed. Skipping it.");
258 consumed_pos
+= stream
->max_sb_size
;
259 stream
->chan
->lost_packets
++;
263 ret
= kernctl_get_subbuf_size(stream
->wait_fd
, &len
);
265 ERR("Snapshot kernctl_get_subbuf_size");
266 goto error_put_subbuf
;
269 ret
= kernctl_get_padded_subbuf_size(stream
->wait_fd
, &padded_len
);
271 ERR("Snapshot kernctl_get_padded_subbuf_size");
272 goto error_put_subbuf
;
275 read_len
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, len
,
276 padded_len
- len
, NULL
);
278 * We write the padded len in local tracefiles but the data len
279 * when using a relay. Display the error but continue processing
280 * to try to release the subbuffer.
282 if (relayd_id
!= (uint64_t) -1ULL) {
283 if (read_len
!= len
) {
284 ERR("Error sending to the relay (ret: %zd != len: %lu)",
288 if (read_len
!= padded_len
) {
289 ERR("Error writing to tracefile (ret: %zd != len: %lu)",
290 read_len
, padded_len
);
294 ret
= kernctl_put_subbuf(stream
->wait_fd
);
296 ERR("Snapshot kernctl_put_subbuf");
299 consumed_pos
+= stream
->max_sb_size
;
302 if (relayd_id
== (uint64_t) -1ULL) {
303 if (stream
->out_fd
>= 0) {
304 ret
= close(stream
->out_fd
);
306 PERROR("Kernel consumer snapshot close out_fd");
312 close_relayd_stream(stream
);
313 stream
->net_seq_idx
= (uint64_t) -1ULL;
315 pthread_mutex_unlock(&stream
->lock
);
323 ret
= kernctl_put_subbuf(stream
->wait_fd
);
325 ERR("Snapshot kernctl_put_subbuf error path");
328 pthread_mutex_unlock(&stream
->lock
);
335 * Read the whole metadata available for a snapshot.
337 * Returns 0 on success, < 0 on error
339 int lttng_kconsumer_snapshot_metadata(uint64_t key
, char *path
,
340 uint64_t relayd_id
, struct lttng_consumer_local_data
*ctx
)
342 int ret
, use_relayd
= 0;
344 struct lttng_consumer_channel
*metadata_channel
;
345 struct lttng_consumer_stream
*metadata_stream
;
349 DBG("Kernel consumer snapshot metadata with key %" PRIu64
" at path %s",
354 metadata_channel
= consumer_find_channel(key
);
355 if (!metadata_channel
) {
356 ERR("Kernel snapshot metadata not found for key %" PRIu64
, key
);
361 metadata_stream
= metadata_channel
->metadata_stream
;
362 assert(metadata_stream
);
364 /* Flag once that we have a valid relayd for the stream. */
365 if (relayd_id
!= (uint64_t) -1ULL) {
370 ret
= consumer_send_relayd_stream(metadata_stream
, path
);
375 ret
= utils_create_stream_file(path
, metadata_stream
->name
,
376 metadata_stream
->chan
->tracefile_size
,
377 metadata_stream
->tracefile_count_current
,
378 metadata_stream
->uid
, metadata_stream
->gid
, NULL
);
382 metadata_stream
->out_fd
= ret
;
386 health_code_update();
388 ret_read
= lttng_kconsumer_read_subbuffer(metadata_stream
, ctx
);
390 if (ret_read
!= -EAGAIN
) {
391 ERR("Kernel snapshot reading metadata subbuffer (ret: %zd)",
395 /* ret_read is negative at this point so we will exit the loop. */
398 } while (ret_read
>= 0);
401 close_relayd_stream(metadata_stream
);
402 metadata_stream
->net_seq_idx
= (uint64_t) -1ULL;
404 if (metadata_stream
->out_fd
>= 0) {
405 ret
= close(metadata_stream
->out_fd
);
407 PERROR("Kernel consumer snapshot metadata close out_fd");
409 * Don't go on error here since the snapshot was successful at this
410 * point but somehow the close failed.
413 metadata_stream
->out_fd
= -1;
419 cds_list_del(&metadata_stream
->send_node
);
420 consumer_stream_destroy(metadata_stream
, NULL
);
421 metadata_channel
->metadata_stream
= NULL
;
428 * Receive command from session daemon and process it.
430 * Return 1 on success else a negative value or 0.
432 int lttng_kconsumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
433 int sock
, struct pollfd
*consumer_sockpoll
)
436 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
437 struct lttcomm_consumer_msg msg
;
439 health_code_update();
441 ret
= lttcomm_recv_unix_sock(sock
, &msg
, sizeof(msg
));
442 if (ret
!= sizeof(msg
)) {
444 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_CMD
);
450 health_code_update();
452 /* Deprecated command */
453 assert(msg
.cmd_type
!= LTTNG_CONSUMER_STOP
);
455 health_code_update();
457 /* relayd needs RCU read-side protection */
460 switch (msg
.cmd_type
) {
461 case LTTNG_CONSUMER_ADD_RELAYD_SOCKET
:
463 /* Session daemon status message are handled in the following call. */
464 consumer_add_relayd_socket(msg
.u
.relayd_sock
.net_index
,
465 msg
.u
.relayd_sock
.type
, ctx
, sock
, consumer_sockpoll
,
466 &msg
.u
.relayd_sock
.sock
, msg
.u
.relayd_sock
.session_id
,
467 msg
.u
.relayd_sock
.relayd_session_id
);
470 case LTTNG_CONSUMER_ADD_CHANNEL
:
472 struct lttng_consumer_channel
*new_channel
;
475 health_code_update();
477 /* First send a status message before receiving the fds. */
478 ret
= consumer_send_status_msg(sock
, ret_code
);
480 /* Somehow, the session daemon is not responding anymore. */
484 health_code_update();
486 DBG("consumer_add_channel %" PRIu64
, msg
.u
.channel
.channel_key
);
487 new_channel
= consumer_allocate_channel(msg
.u
.channel
.channel_key
,
488 msg
.u
.channel
.session_id
, msg
.u
.channel
.pathname
,
489 msg
.u
.channel
.name
, msg
.u
.channel
.uid
, msg
.u
.channel
.gid
,
490 msg
.u
.channel
.relayd_id
, msg
.u
.channel
.output
,
491 msg
.u
.channel
.tracefile_size
,
492 msg
.u
.channel
.tracefile_count
, 0,
493 msg
.u
.channel
.monitor
,
494 msg
.u
.channel
.live_timer_interval
,
496 if (new_channel
== NULL
) {
497 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
500 new_channel
->nb_init_stream_left
= msg
.u
.channel
.nb_init_streams
;
501 switch (msg
.u
.channel
.output
) {
502 case LTTNG_EVENT_SPLICE
:
503 new_channel
->output
= CONSUMER_CHANNEL_SPLICE
;
505 case LTTNG_EVENT_MMAP
:
506 new_channel
->output
= CONSUMER_CHANNEL_MMAP
;
509 ERR("Channel output unknown %d", msg
.u
.channel
.output
);
513 /* Translate and save channel type. */
514 switch (msg
.u
.channel
.type
) {
515 case CONSUMER_CHANNEL_TYPE_DATA
:
516 case CONSUMER_CHANNEL_TYPE_METADATA
:
517 new_channel
->type
= msg
.u
.channel
.type
;
524 health_code_update();
526 if (ctx
->on_recv_channel
!= NULL
) {
527 ret_recv
= ctx
->on_recv_channel(new_channel
);
529 ret
= consumer_add_channel(new_channel
, ctx
);
530 } else if (ret_recv
< 0) {
534 ret
= consumer_add_channel(new_channel
, ctx
);
536 if (msg
.u
.channel
.type
== CONSUMER_CHANNEL_TYPE_DATA
&& !ret
) {
537 int monitor_start_ret
;
539 DBG("Consumer starting monitor timer");
540 consumer_timer_live_start(new_channel
,
541 msg
.u
.channel
.live_timer_interval
);
542 monitor_start_ret
= consumer_timer_monitor_start(
544 msg
.u
.channel
.monitor_timer_interval
);
545 if (monitor_start_ret
< 0) {
546 ERR("Starting channel monitoring timer failed");
552 health_code_update();
554 /* If we received an error in add_channel, we need to report it. */
556 ret
= consumer_send_status_msg(sock
, ret
);
565 case LTTNG_CONSUMER_ADD_STREAM
:
568 struct lttng_pipe
*stream_pipe
;
569 struct lttng_consumer_stream
*new_stream
;
570 struct lttng_consumer_channel
*channel
;
574 * Get stream's channel reference. Needed when adding the stream to the
577 channel
= consumer_find_channel(msg
.u
.stream
.channel_key
);
580 * We could not find the channel. Can happen if cpu hotplug
581 * happens while tearing down.
583 ERR("Unable to find channel key %" PRIu64
, msg
.u
.stream
.channel_key
);
584 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
587 health_code_update();
589 /* First send a status message before receiving the fds. */
590 ret
= consumer_send_status_msg(sock
, ret_code
);
592 /* Somehow, the session daemon is not responding anymore. */
596 health_code_update();
598 if (ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
599 /* Channel was not found. */
605 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
611 health_code_update();
613 /* Get stream file descriptor from socket */
614 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
615 if (ret
!= sizeof(fd
)) {
616 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
621 health_code_update();
624 * Send status code to session daemon only if the recv works. If the
625 * above recv() failed, the session daemon is notified through the
626 * error socket and the teardown is eventually done.
628 ret
= consumer_send_status_msg(sock
, ret_code
);
630 /* Somehow, the session daemon is not responding anymore. */
634 health_code_update();
636 new_stream
= consumer_allocate_stream(channel
->key
,
638 LTTNG_CONSUMER_ACTIVE_STREAM
,
648 if (new_stream
== NULL
) {
653 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_OUTFD_ERROR
);
659 new_stream
->chan
= channel
;
660 new_stream
->wait_fd
= fd
;
661 switch (channel
->output
) {
662 case CONSUMER_CHANNEL_SPLICE
:
663 new_stream
->output
= LTTNG_EVENT_SPLICE
;
664 ret
= utils_create_pipe(new_stream
->splice_pipe
);
669 case CONSUMER_CHANNEL_MMAP
:
670 new_stream
->output
= LTTNG_EVENT_MMAP
;
673 ERR("Stream output unknown %d", channel
->output
);
678 * We've just assigned the channel to the stream so increment the
679 * refcount right now. We don't need to increment the refcount for
680 * streams in no monitor because we handle manually the cleanup of
681 * those. It is very important to make sure there is NO prior
682 * consumer_del_stream() calls or else the refcount will be unbalanced.
684 if (channel
->monitor
) {
685 uatomic_inc(&new_stream
->chan
->refcount
);
689 * The buffer flush is done on the session daemon side for the kernel
690 * so no need for the stream "hangup_flush_done" variable to be
691 * tracked. This is important for a kernel stream since we don't rely
692 * on the flush state of the stream to read data. It's not the case for
693 * user space tracing.
695 new_stream
->hangup_flush_done
= 0;
697 health_code_update();
699 if (ctx
->on_recv_stream
) {
700 ret
= ctx
->on_recv_stream(new_stream
);
702 consumer_stream_free(new_stream
);
707 health_code_update();
709 if (new_stream
->metadata_flag
) {
710 channel
->metadata_stream
= new_stream
;
713 /* Do not monitor this stream. */
714 if (!channel
->monitor
) {
715 DBG("Kernel consumer add stream %s in no monitor mode with "
716 "relayd id %" PRIu64
, new_stream
->name
,
717 new_stream
->net_seq_idx
);
718 cds_list_add(&new_stream
->send_node
, &channel
->streams
.head
);
722 /* Send stream to relayd if the stream has an ID. */
723 if (new_stream
->net_seq_idx
!= (uint64_t) -1ULL) {
724 ret
= consumer_send_relayd_stream(new_stream
,
725 new_stream
->chan
->pathname
);
727 consumer_stream_free(new_stream
);
732 * If adding an extra stream to an already
733 * existing channel (e.g. cpu hotplug), we need
734 * to send the "streams_sent" command to relayd.
736 if (channel
->streams_sent_to_relayd
) {
737 ret
= consumer_send_relayd_streams_sent(
738 new_stream
->net_seq_idx
);
745 /* Get the right pipe where the stream will be sent. */
746 if (new_stream
->metadata_flag
) {
747 ret
= consumer_add_metadata_stream(new_stream
);
749 ERR("Consumer add metadata stream %" PRIu64
" failed. Continuing",
751 consumer_stream_free(new_stream
);
754 stream_pipe
= ctx
->consumer_metadata_pipe
;
756 ret
= consumer_add_data_stream(new_stream
);
758 ERR("Consumer add stream %" PRIu64
" failed. Continuing",
760 consumer_stream_free(new_stream
);
763 stream_pipe
= ctx
->consumer_data_pipe
;
766 /* Vitible to other threads */
767 new_stream
->globally_visible
= 1;
769 health_code_update();
771 ret
= lttng_pipe_write(stream_pipe
, &new_stream
, sizeof(new_stream
));
773 ERR("Consumer write %s stream to pipe %d",
774 new_stream
->metadata_flag
? "metadata" : "data",
775 lttng_pipe_get_writefd(stream_pipe
));
776 if (new_stream
->metadata_flag
) {
777 consumer_del_stream_for_metadata(new_stream
);
779 consumer_del_stream_for_data(new_stream
);
784 DBG("Kernel consumer ADD_STREAM %s (fd: %d) with relayd id %" PRIu64
,
785 new_stream
->name
, fd
, new_stream
->relayd_stream_id
);
788 case LTTNG_CONSUMER_STREAMS_SENT
:
790 struct lttng_consumer_channel
*channel
;
793 * Get stream's channel reference. Needed when adding the stream to the
796 channel
= consumer_find_channel(msg
.u
.sent_streams
.channel_key
);
799 * We could not find the channel. Can happen if cpu hotplug
800 * happens while tearing down.
802 ERR("Unable to find channel key %" PRIu64
,
803 msg
.u
.sent_streams
.channel_key
);
804 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
807 health_code_update();
810 * Send status code to session daemon.
812 ret
= consumer_send_status_msg(sock
, ret_code
);
813 if (ret
< 0 || ret_code
!= LTTCOMM_CONSUMERD_SUCCESS
) {
814 /* Somehow, the session daemon is not responding anymore. */
818 health_code_update();
821 * We should not send this message if we don't monitor the
822 * streams in this channel.
824 if (!channel
->monitor
) {
828 health_code_update();
829 /* Send stream to relayd if the stream has an ID. */
830 if (msg
.u
.sent_streams
.net_seq_idx
!= (uint64_t) -1ULL) {
831 ret
= consumer_send_relayd_streams_sent(
832 msg
.u
.sent_streams
.net_seq_idx
);
836 channel
->streams_sent_to_relayd
= true;
840 case LTTNG_CONSUMER_UPDATE_STREAM
:
845 case LTTNG_CONSUMER_DESTROY_RELAYD
:
847 uint64_t index
= msg
.u
.destroy_relayd
.net_seq_idx
;
848 struct consumer_relayd_sock_pair
*relayd
;
850 DBG("Kernel consumer destroying relayd %" PRIu64
, index
);
852 /* Get relayd reference if exists. */
853 relayd
= consumer_find_relayd(index
);
854 if (relayd
== NULL
) {
855 DBG("Unable to find relayd %" PRIu64
, index
);
856 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
860 * Each relayd socket pair has a refcount of stream attached to it
861 * which tells if the relayd is still active or not depending on the
864 * This will set the destroy flag of the relayd object and destroy it
865 * if the refcount reaches zero when called.
867 * The destroy can happen either here or when a stream fd hangs up.
870 consumer_flag_relayd_for_destroy(relayd
);
873 health_code_update();
875 ret
= consumer_send_status_msg(sock
, ret_code
);
877 /* Somehow, the session daemon is not responding anymore. */
883 case LTTNG_CONSUMER_DATA_PENDING
:
886 uint64_t id
= msg
.u
.data_pending
.session_id
;
888 DBG("Kernel consumer data pending command for id %" PRIu64
, id
);
890 ret
= consumer_data_pending(id
);
892 health_code_update();
894 /* Send back returned value to session daemon */
895 ret
= lttcomm_send_unix_sock(sock
, &ret
, sizeof(ret
));
897 PERROR("send data pending ret code");
902 * No need to send back a status message since the data pending
903 * returned value is the response.
907 case LTTNG_CONSUMER_SNAPSHOT_CHANNEL
:
909 if (msg
.u
.snapshot_channel
.metadata
== 1) {
910 ret
= lttng_kconsumer_snapshot_metadata(msg
.u
.snapshot_channel
.key
,
911 msg
.u
.snapshot_channel
.pathname
,
912 msg
.u
.snapshot_channel
.relayd_id
, ctx
);
914 ERR("Snapshot metadata failed");
915 ret_code
= LTTCOMM_CONSUMERD_ERROR_METADATA
;
918 ret
= lttng_kconsumer_snapshot_channel(msg
.u
.snapshot_channel
.key
,
919 msg
.u
.snapshot_channel
.pathname
,
920 msg
.u
.snapshot_channel
.relayd_id
,
921 msg
.u
.snapshot_channel
.nb_packets_per_stream
,
924 ERR("Snapshot channel failed");
925 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
929 health_code_update();
931 ret
= consumer_send_status_msg(sock
, ret_code
);
933 /* Somehow, the session daemon is not responding anymore. */
938 case LTTNG_CONSUMER_DESTROY_CHANNEL
:
940 uint64_t key
= msg
.u
.destroy_channel
.key
;
941 struct lttng_consumer_channel
*channel
;
943 channel
= consumer_find_channel(key
);
945 ERR("Kernel consumer destroy channel %" PRIu64
" not found", key
);
946 ret_code
= LTTCOMM_CONSUMERD_CHAN_NOT_FOUND
;
949 health_code_update();
951 ret
= consumer_send_status_msg(sock
, ret_code
);
953 /* Somehow, the session daemon is not responding anymore. */
957 health_code_update();
959 /* Stop right now if no channel was found. */
965 * This command should ONLY be issued for channel with streams set in
968 assert(!channel
->monitor
);
971 * The refcount should ALWAYS be 0 in the case of a channel in no
974 assert(!uatomic_sub_return(&channel
->refcount
, 1));
976 consumer_del_channel(channel
);
980 case LTTNG_CONSUMER_DISCARDED_EVENTS
:
984 struct lttng_consumer_channel
*channel
;
985 uint64_t id
= msg
.u
.discarded_events
.session_id
;
986 uint64_t key
= msg
.u
.discarded_events
.channel_key
;
988 DBG("Kernel consumer discarded events command for session id %"
989 PRIu64
", channel key %" PRIu64
, id
, key
);
991 channel
= consumer_find_channel(key
);
993 ERR("Kernel consumer discarded events channel %"
994 PRIu64
" not found", key
);
997 count
= channel
->discarded_events
;
1000 health_code_update();
1002 /* Send back returned value to session daemon */
1003 ret
= lttcomm_send_unix_sock(sock
, &count
, sizeof(count
));
1005 PERROR("send discarded events");
1011 case LTTNG_CONSUMER_LOST_PACKETS
:
1015 struct lttng_consumer_channel
*channel
;
1016 uint64_t id
= msg
.u
.lost_packets
.session_id
;
1017 uint64_t key
= msg
.u
.lost_packets
.channel_key
;
1019 DBG("Kernel consumer lost packets command for session id %"
1020 PRIu64
", channel key %" PRIu64
, id
, key
);
1022 channel
= consumer_find_channel(key
);
1024 ERR("Kernel consumer lost packets channel %"
1025 PRIu64
" not found", key
);
1028 count
= channel
->lost_packets
;
1031 health_code_update();
1033 /* Send back returned value to session daemon */
1034 ret
= lttcomm_send_unix_sock(sock
, &count
, sizeof(count
));
1036 PERROR("send lost packets");
1042 case LTTNG_CONSUMER_SET_CHANNEL_MONITOR_PIPE
:
1044 int channel_monitor_pipe
;
1046 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1047 /* Successfully received the command's type. */
1048 ret
= consumer_send_status_msg(sock
, ret_code
);
1053 ret
= lttcomm_recv_fds_unix_sock(sock
, &channel_monitor_pipe
,
1055 if (ret
!= sizeof(channel_monitor_pipe
)) {
1056 ERR("Failed to receive channel monitor pipe");
1060 DBG("Received channel monitor pipe (%d)", channel_monitor_pipe
);
1061 ret
= consumer_timer_thread_set_channel_monitor_pipe(
1062 channel_monitor_pipe
);
1066 ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
1067 /* Set the pipe as non-blocking. */
1068 ret
= fcntl(channel_monitor_pipe
, F_GETFL
, 0);
1070 PERROR("fcntl get flags of the channel monitoring pipe");
1075 ret
= fcntl(channel_monitor_pipe
, F_SETFL
,
1076 flags
| O_NONBLOCK
);
1078 PERROR("fcntl set O_NONBLOCK flag of the channel monitoring pipe");
1081 DBG("Channel monitor pipe set as non-blocking");
1083 ret_code
= LTTCOMM_CONSUMERD_ALREADY_SET
;
1085 ret
= consumer_send_status_msg(sock
, ret_code
);
1099 * Return 1 to indicate success since the 0 value can be a socket
1100 * shutdown during the recv() or send() call.
1102 health_code_update();
1107 /* This will issue a consumer stop. */
1112 * Populate index values of a kernel stream. Values are set in big endian order.
1114 * Return 0 on success or else a negative value.
1116 static int get_index_values(struct ctf_packet_index
*index
, int infd
)
1120 ret
= kernctl_get_timestamp_begin(infd
, &index
->timestamp_begin
);
1122 PERROR("kernctl_get_timestamp_begin");
1125 index
->timestamp_begin
= htobe64(index
->timestamp_begin
);
1127 ret
= kernctl_get_timestamp_end(infd
, &index
->timestamp_end
);
1129 PERROR("kernctl_get_timestamp_end");
1132 index
->timestamp_end
= htobe64(index
->timestamp_end
);
1134 ret
= kernctl_get_events_discarded(infd
, &index
->events_discarded
);
1136 PERROR("kernctl_get_events_discarded");
1139 index
->events_discarded
= htobe64(index
->events_discarded
);
1141 ret
= kernctl_get_content_size(infd
, &index
->content_size
);
1143 PERROR("kernctl_get_content_size");
1146 index
->content_size
= htobe64(index
->content_size
);
1148 ret
= kernctl_get_packet_size(infd
, &index
->packet_size
);
1150 PERROR("kernctl_get_packet_size");
1153 index
->packet_size
= htobe64(index
->packet_size
);
1155 ret
= kernctl_get_stream_id(infd
, &index
->stream_id
);
1157 PERROR("kernctl_get_stream_id");
1160 index
->stream_id
= htobe64(index
->stream_id
);
1162 ret
= kernctl_get_instance_id(infd
, &index
->stream_instance_id
);
1164 if (ret
== -ENOTTY
) {
1165 /* Command not implemented by lttng-modules. */
1166 index
->stream_instance_id
= -1ULL;
1168 PERROR("kernctl_get_instance_id");
1172 index
->stream_instance_id
= htobe64(index
->stream_instance_id
);
1174 ret
= kernctl_get_sequence_number(infd
, &index
->packet_seq_num
);
1176 if (ret
== -ENOTTY
) {
1177 /* Command not implemented by lttng-modules. */
1178 index
->packet_seq_num
= -1ULL;
1181 PERROR("kernctl_get_sequence_number");
1185 index
->packet_seq_num
= htobe64(index
->packet_seq_num
);
1191 * Sync metadata meaning request them to the session daemon and snapshot to the
1192 * metadata thread can consumer them.
1194 * Metadata stream lock MUST be acquired.
1196 * Return 0 if new metadatda is available, EAGAIN if the metadata stream
1197 * is empty or a negative value on error.
1199 int lttng_kconsumer_sync_metadata(struct lttng_consumer_stream
*metadata
)
1205 ret
= kernctl_buffer_flush(metadata
->wait_fd
);
1207 ERR("Failed to flush kernel stream");
1211 ret
= kernctl_snapshot(metadata
->wait_fd
);
1213 if (ret
!= -EAGAIN
) {
1214 ERR("Sync metadata, taking kernel snapshot failed.");
1217 DBG("Sync metadata, no new kernel metadata");
1218 /* No new metadata, exit. */
1228 int update_stream_stats(struct lttng_consumer_stream
*stream
)
1231 uint64_t seq
, discarded
;
1233 ret
= kernctl_get_sequence_number(stream
->wait_fd
, &seq
);
1235 if (ret
== -ENOTTY
) {
1236 /* Command not implemented by lttng-modules. */
1239 PERROR("kernctl_get_sequence_number");
1245 * Start the sequence when we extract the first packet in case we don't
1246 * start at 0 (for example if a consumer is not connected to the
1247 * session immediately after the beginning).
1249 if (stream
->last_sequence_number
== -1ULL) {
1250 stream
->last_sequence_number
= seq
;
1251 } else if (seq
> stream
->last_sequence_number
) {
1252 stream
->chan
->lost_packets
+= seq
-
1253 stream
->last_sequence_number
- 1;
1255 /* seq <= last_sequence_number */
1256 ERR("Sequence number inconsistent : prev = %" PRIu64
1257 ", current = %" PRIu64
,
1258 stream
->last_sequence_number
, seq
);
1262 stream
->last_sequence_number
= seq
;
1264 ret
= kernctl_get_events_discarded(stream
->wait_fd
, &discarded
);
1266 PERROR("kernctl_get_events_discarded");
1269 if (discarded
< stream
->last_discarded_events
) {
1271 * Overflow has occurred. We assume only one wrap-around
1274 stream
->chan
->discarded_events
+= (1ULL << (CAA_BITS_PER_LONG
- 1)) -
1275 stream
->last_discarded_events
+ discarded
;
1277 stream
->chan
->discarded_events
+= discarded
-
1278 stream
->last_discarded_events
;
1280 stream
->last_discarded_events
= discarded
;
1288 * Check if the local version of the metadata stream matches with the version
1289 * of the metadata stream in the kernel. If it was updated, set the reset flag
1293 int metadata_stream_check_version(int infd
, struct lttng_consumer_stream
*stream
)
1296 uint64_t cur_version
;
1298 ret
= kernctl_get_metadata_version(infd
, &cur_version
);
1300 if (ret
== -ENOTTY
) {
1302 * LTTng-modules does not implement this
1308 ERR("Failed to get the metadata version");
1312 if (stream
->metadata_version
== cur_version
) {
1317 DBG("New metadata version detected");
1318 stream
->metadata_version
= cur_version
;
1319 stream
->reset_metadata_flag
= 1;
1327 * Consume data on a file descriptor and write it on a trace file.
1329 ssize_t
lttng_kconsumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
1330 struct lttng_consumer_local_data
*ctx
)
1332 unsigned long len
, subbuf_size
, padding
;
1333 int err
, write_index
= 1;
1335 int infd
= stream
->wait_fd
;
1336 struct ctf_packet_index index
;
1338 DBG("In read_subbuffer (infd : %d)", infd
);
1340 /* Get the next subbuffer */
1341 err
= kernctl_get_next_subbuf(infd
);
1344 * This is a debug message even for single-threaded consumer,
1345 * because poll() have more relaxed criterions than get subbuf,
1346 * so get_subbuf may fail for short race windows where poll()
1347 * would issue wakeups.
1349 DBG("Reserving sub buffer failed (everything is normal, "
1350 "it is due to concurrency)");
1355 /* Get the full subbuffer size including padding */
1356 err
= kernctl_get_padded_subbuf_size(infd
, &len
);
1358 PERROR("Getting sub-buffer len failed.");
1359 err
= kernctl_put_subbuf(infd
);
1361 if (err
== -EFAULT
) {
1362 PERROR("Error in unreserving sub buffer\n");
1363 } else if (err
== -EIO
) {
1364 /* Should never happen with newer LTTng versions */
1365 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1374 if (!stream
->metadata_flag
) {
1375 ret
= get_index_values(&index
, infd
);
1377 err
= kernctl_put_subbuf(infd
);
1379 if (err
== -EFAULT
) {
1380 PERROR("Error in unreserving sub buffer\n");
1381 } else if (err
== -EIO
) {
1382 /* Should never happen with newer LTTng versions */
1383 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1390 ret
= update_stream_stats(stream
);
1392 err
= kernctl_put_subbuf(infd
);
1394 if (err
== -EFAULT
) {
1395 PERROR("Error in unreserving sub buffer\n");
1396 } else if (err
== -EIO
) {
1397 /* Should never happen with newer LTTng versions */
1398 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1407 ret
= metadata_stream_check_version(infd
, stream
);
1409 err
= kernctl_put_subbuf(infd
);
1411 if (err
== -EFAULT
) {
1412 PERROR("Error in unreserving sub buffer\n");
1413 } else if (err
== -EIO
) {
1414 /* Should never happen with newer LTTng versions */
1415 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1424 switch (stream
->chan
->output
) {
1425 case CONSUMER_CHANNEL_SPLICE
:
1427 * XXX: The lttng-modules splice "actor" does not handle copying
1428 * partial pages hence only using the subbuffer size without the
1429 * padding makes the splice fail.
1434 /* splice the subbuffer to the tracefile */
1435 ret
= lttng_consumer_on_read_subbuffer_splice(ctx
, stream
, subbuf_size
,
1438 * XXX: Splice does not support network streaming so the return value
1439 * is simply checked against subbuf_size and not like the mmap() op.
1441 if (ret
!= subbuf_size
) {
1443 * display the error but continue processing to try
1444 * to release the subbuffer
1446 ERR("Error splicing to tracefile (ret: %zd != len: %lu)",
1451 case CONSUMER_CHANNEL_MMAP
:
1452 /* Get subbuffer size without padding */
1453 err
= kernctl_get_subbuf_size(infd
, &subbuf_size
);
1455 PERROR("Getting sub-buffer len failed.");
1456 err
= kernctl_put_subbuf(infd
);
1458 if (err
== -EFAULT
) {
1459 PERROR("Error in unreserving sub buffer\n");
1460 } else if (err
== -EIO
) {
1461 /* Should never happen with newer LTTng versions */
1462 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1471 /* Make sure the tracer is not gone mad on us! */
1472 assert(len
>= subbuf_size
);
1474 padding
= len
- subbuf_size
;
1476 /* write the subbuffer to the tracefile */
1477 ret
= lttng_consumer_on_read_subbuffer_mmap(ctx
, stream
, subbuf_size
,
1480 * The mmap operation should write subbuf_size amount of data when
1481 * network streaming or the full padding (len) size when we are _not_
1484 if ((ret
!= subbuf_size
&& stream
->net_seq_idx
!= (uint64_t) -1ULL) ||
1485 (ret
!= len
&& stream
->net_seq_idx
== (uint64_t) -1ULL)) {
1487 * Display the error but continue processing to try to release the
1488 * subbuffer. This is a DBG statement since this is possible to
1489 * happen without being a critical error.
1491 DBG("Error writing to tracefile "
1492 "(ret: %zd != len: %lu != subbuf_size: %lu)",
1493 ret
, len
, subbuf_size
);
1498 ERR("Unknown output method");
1502 err
= kernctl_put_next_subbuf(infd
);
1504 if (err
== -EFAULT
) {
1505 PERROR("Error in unreserving sub buffer\n");
1506 } else if (err
== -EIO
) {
1507 /* Should never happen with newer LTTng versions */
1508 PERROR("Reader has been pushed by the writer, last sub-buffer corrupted.");
1514 /* Write index if needed. */
1519 if (stream
->chan
->live_timer_interval
&& !stream
->metadata_flag
) {
1521 * In live, block until all the metadata is sent.
1523 pthread_mutex_lock(&stream
->metadata_timer_lock
);
1524 assert(!stream
->missed_metadata_flush
);
1525 stream
->waiting_on_metadata
= true;
1526 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
1528 err
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
1530 pthread_mutex_lock(&stream
->metadata_timer_lock
);
1531 stream
->waiting_on_metadata
= false;
1532 if (stream
->missed_metadata_flush
) {
1533 stream
->missed_metadata_flush
= false;
1534 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
1535 (void) consumer_flush_kernel_index(stream
);
1537 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
1544 err
= consumer_stream_write_index(stream
, &index
);
1553 int lttng_kconsumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
1560 * Don't create anything if this is set for streaming or should not be
1563 if (stream
->net_seq_idx
== (uint64_t) -1ULL && stream
->chan
->monitor
) {
1564 ret
= utils_create_stream_file(stream
->chan
->pathname
, stream
->name
,
1565 stream
->chan
->tracefile_size
, stream
->tracefile_count_current
,
1566 stream
->uid
, stream
->gid
, NULL
);
1570 stream
->out_fd
= ret
;
1571 stream
->tracefile_size_current
= 0;
1573 if (!stream
->metadata_flag
) {
1574 struct lttng_index_file
*index_file
;
1576 index_file
= lttng_index_file_create(stream
->chan
->pathname
,
1577 stream
->name
, stream
->uid
, stream
->gid
,
1578 stream
->chan
->tracefile_size
,
1579 stream
->tracefile_count_current
,
1580 CTF_INDEX_MAJOR
, CTF_INDEX_MINOR
);
1584 assert(!stream
->index_file
);
1585 stream
->index_file
= index_file
;
1589 if (stream
->output
== LTTNG_EVENT_MMAP
) {
1590 /* get the len of the mmap region */
1591 unsigned long mmap_len
;
1593 ret
= kernctl_get_mmap_len(stream
->wait_fd
, &mmap_len
);
1595 PERROR("kernctl_get_mmap_len");
1596 goto error_close_fd
;
1598 stream
->mmap_len
= (size_t) mmap_len
;
1600 stream
->mmap_base
= mmap(NULL
, stream
->mmap_len
, PROT_READ
,
1601 MAP_PRIVATE
, stream
->wait_fd
, 0);
1602 if (stream
->mmap_base
== MAP_FAILED
) {
1603 PERROR("Error mmaping");
1605 goto error_close_fd
;
1609 /* we return 0 to let the library handle the FD internally */
1613 if (stream
->out_fd
>= 0) {
1616 err
= close(stream
->out_fd
);
1618 stream
->out_fd
= -1;
1625 * Check if data is still being extracted from the buffers for a specific
1626 * stream. Consumer data lock MUST be acquired before calling this function
1627 * and the stream lock.
1629 * Return 1 if the traced data are still getting read else 0 meaning that the
1630 * data is available for trace viewer reading.
1632 int lttng_kconsumer_data_pending(struct lttng_consumer_stream
*stream
)
1638 if (stream
->endpoint_status
!= CONSUMER_ENDPOINT_ACTIVE
) {
1643 ret
= kernctl_get_next_subbuf(stream
->wait_fd
);
1645 /* There is still data so let's put back this subbuffer. */
1646 ret
= kernctl_put_subbuf(stream
->wait_fd
);
1648 ret
= 1; /* Data is pending */
1652 /* Data is NOT pending and ready to be read. */