2 * Copyright (C) 2011 - Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * 2012 - David Goulet <dgoulet@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, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
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.
28 #include <sys/socket.h>
29 #include <sys/types.h>
34 #include <bin/lttng-consumerd/health-consumerd.h>
35 #include <common/common.h>
36 #include <common/utils.h>
37 #include <common/compat/poll.h>
38 #include <common/compat/endian.h>
39 #include <common/index/index.h>
40 #include <common/kernel-ctl/kernel-ctl.h>
41 #include <common/sessiond-comm/relayd.h>
42 #include <common/sessiond-comm/sessiond-comm.h>
43 #include <common/kernel-consumer/kernel-consumer.h>
44 #include <common/relayd/relayd.h>
45 #include <common/ust-consumer/ust-consumer.h>
46 #include <common/consumer-timer.h>
49 #include "consumer-stream.h"
50 #include "consumer-testpoint.h"
52 struct lttng_consumer_global_data consumer_data
= {
55 .type
= LTTNG_CONSUMER_UNKNOWN
,
58 enum consumer_channel_action
{
61 CONSUMER_CHANNEL_QUIT
,
64 struct consumer_channel_msg
{
65 enum consumer_channel_action action
;
66 struct lttng_consumer_channel
*chan
; /* add */
67 uint64_t key
; /* del */
71 * Flag to inform the polling thread to quit when all fd hung up. Updated by
72 * the consumer_thread_receive_fds when it notices that all fds has hung up.
73 * Also updated by the signal handler (consumer_should_exit()). Read by the
76 volatile int consumer_quit
;
79 * Global hash table containing respectively metadata and data streams. The
80 * stream element in this ht should only be updated by the metadata poll thread
81 * for the metadata and the data poll thread for the data.
83 static struct lttng_ht
*metadata_ht
;
84 static struct lttng_ht
*data_ht
;
87 * Notify a thread lttng pipe to poll back again. This usually means that some
88 * global state has changed so we just send back the thread in a poll wait
91 static void notify_thread_lttng_pipe(struct lttng_pipe
*pipe
)
93 struct lttng_consumer_stream
*null_stream
= NULL
;
97 (void) lttng_pipe_write(pipe
, &null_stream
, sizeof(null_stream
));
100 static void notify_health_quit_pipe(int *pipe
)
104 ret
= lttng_write(pipe
[1], "4", 1);
106 PERROR("write consumer health quit");
110 static void notify_channel_pipe(struct lttng_consumer_local_data
*ctx
,
111 struct lttng_consumer_channel
*chan
,
113 enum consumer_channel_action action
)
115 struct consumer_channel_msg msg
;
118 memset(&msg
, 0, sizeof(msg
));
123 ret
= lttng_write(ctx
->consumer_channel_pipe
[1], &msg
, sizeof(msg
));
124 if (ret
< sizeof(msg
)) {
125 PERROR("notify_channel_pipe write error");
129 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
132 notify_channel_pipe(ctx
, NULL
, key
, CONSUMER_CHANNEL_DEL
);
135 static int read_channel_pipe(struct lttng_consumer_local_data
*ctx
,
136 struct lttng_consumer_channel
**chan
,
138 enum consumer_channel_action
*action
)
140 struct consumer_channel_msg msg
;
143 ret
= lttng_read(ctx
->consumer_channel_pipe
[0], &msg
, sizeof(msg
));
144 if (ret
< sizeof(msg
)) {
148 *action
= msg
.action
;
156 * Cleanup the stream list of a channel. Those streams are not yet globally
159 static void clean_channel_stream_list(struct lttng_consumer_channel
*channel
)
161 struct lttng_consumer_stream
*stream
, *stmp
;
165 /* Delete streams that might have been left in the stream list. */
166 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
168 cds_list_del(&stream
->send_node
);
170 * Once a stream is added to this list, the buffers were created so we
171 * have a guarantee that this call will succeed. Setting the monitor
172 * mode to 0 so we don't lock nor try to delete the stream from the
176 consumer_stream_destroy(stream
, NULL
);
181 * Find a stream. The consumer_data.lock must be locked during this
184 static struct lttng_consumer_stream
*find_stream(uint64_t key
,
187 struct lttng_ht_iter iter
;
188 struct lttng_ht_node_u64
*node
;
189 struct lttng_consumer_stream
*stream
= NULL
;
193 /* -1ULL keys are lookup failures */
194 if (key
== (uint64_t) -1ULL) {
200 lttng_ht_lookup(ht
, &key
, &iter
);
201 node
= lttng_ht_iter_get_node_u64(&iter
);
203 stream
= caa_container_of(node
, struct lttng_consumer_stream
, node
);
211 static void steal_stream_key(uint64_t key
, struct lttng_ht
*ht
)
213 struct lttng_consumer_stream
*stream
;
216 stream
= find_stream(key
, ht
);
218 stream
->key
= (uint64_t) -1ULL;
220 * We don't want the lookup to match, but we still need
221 * to iterate on this stream when iterating over the hash table. Just
222 * change the node key.
224 stream
->node
.key
= (uint64_t) -1ULL;
230 * Return a channel object for the given key.
232 * RCU read side lock MUST be acquired before calling this function and
233 * protects the channel ptr.
235 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
)
237 struct lttng_ht_iter iter
;
238 struct lttng_ht_node_u64
*node
;
239 struct lttng_consumer_channel
*channel
= NULL
;
241 /* -1ULL keys are lookup failures */
242 if (key
== (uint64_t) -1ULL) {
246 lttng_ht_lookup(consumer_data
.channel_ht
, &key
, &iter
);
247 node
= lttng_ht_iter_get_node_u64(&iter
);
249 channel
= caa_container_of(node
, struct lttng_consumer_channel
, node
);
256 * There is a possibility that the consumer does not have enough time between
257 * the close of the channel on the session daemon and the cleanup in here thus
258 * once we have a channel add with an existing key, we know for sure that this
259 * channel will eventually get cleaned up by all streams being closed.
261 * This function just nullifies the already existing channel key.
263 static void steal_channel_key(uint64_t key
)
265 struct lttng_consumer_channel
*channel
;
268 channel
= consumer_find_channel(key
);
270 channel
->key
= (uint64_t) -1ULL;
272 * We don't want the lookup to match, but we still need to iterate on
273 * this channel when iterating over the hash table. Just change the
276 channel
->node
.key
= (uint64_t) -1ULL;
281 static void free_channel_rcu(struct rcu_head
*head
)
283 struct lttng_ht_node_u64
*node
=
284 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
285 struct lttng_consumer_channel
*channel
=
286 caa_container_of(node
, struct lttng_consumer_channel
, node
);
292 * RCU protected relayd socket pair free.
294 static void free_relayd_rcu(struct rcu_head
*head
)
296 struct lttng_ht_node_u64
*node
=
297 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
298 struct consumer_relayd_sock_pair
*relayd
=
299 caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
302 * Close all sockets. This is done in the call RCU since we don't want the
303 * socket fds to be reassigned thus potentially creating bad state of the
306 * We do not have to lock the control socket mutex here since at this stage
307 * there is no one referencing to this relayd object.
309 (void) relayd_close(&relayd
->control_sock
);
310 (void) relayd_close(&relayd
->data_sock
);
316 * Destroy and free relayd socket pair object.
318 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
)
321 struct lttng_ht_iter iter
;
323 if (relayd
== NULL
) {
327 DBG("Consumer destroy and close relayd socket pair");
329 iter
.iter
.node
= &relayd
->node
.node
;
330 ret
= lttng_ht_del(consumer_data
.relayd_ht
, &iter
);
332 /* We assume the relayd is being or is destroyed */
336 /* RCU free() call */
337 call_rcu(&relayd
->node
.head
, free_relayd_rcu
);
341 * Remove a channel from the global list protected by a mutex. This function is
342 * also responsible for freeing its data structures.
344 void consumer_del_channel(struct lttng_consumer_channel
*channel
)
347 struct lttng_ht_iter iter
;
349 DBG("Consumer delete channel key %" PRIu64
, channel
->key
);
351 pthread_mutex_lock(&consumer_data
.lock
);
352 pthread_mutex_lock(&channel
->lock
);
354 /* Destroy streams that might have been left in the stream list. */
355 clean_channel_stream_list(channel
);
357 if (channel
->live_timer_enabled
== 1) {
358 consumer_timer_live_stop(channel
);
361 switch (consumer_data
.type
) {
362 case LTTNG_CONSUMER_KERNEL
:
364 case LTTNG_CONSUMER32_UST
:
365 case LTTNG_CONSUMER64_UST
:
366 lttng_ustconsumer_del_channel(channel
);
369 ERR("Unknown consumer_data type");
375 iter
.iter
.node
= &channel
->node
.node
;
376 ret
= lttng_ht_del(consumer_data
.channel_ht
, &iter
);
380 call_rcu(&channel
->node
.head
, free_channel_rcu
);
382 pthread_mutex_unlock(&channel
->lock
);
383 pthread_mutex_unlock(&consumer_data
.lock
);
387 * Iterate over the relayd hash table and destroy each element. Finally,
388 * destroy the whole hash table.
390 static void cleanup_relayd_ht(void)
392 struct lttng_ht_iter iter
;
393 struct consumer_relayd_sock_pair
*relayd
;
397 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
399 consumer_destroy_relayd(relayd
);
404 lttng_ht_destroy(consumer_data
.relayd_ht
);
408 * Update the end point status of all streams having the given network sequence
409 * index (relayd index).
411 * It's atomically set without having the stream mutex locked which is fine
412 * because we handle the write/read race with a pipe wakeup for each thread.
414 static void update_endpoint_status_by_netidx(uint64_t net_seq_idx
,
415 enum consumer_endpoint_status status
)
417 struct lttng_ht_iter iter
;
418 struct lttng_consumer_stream
*stream
;
420 DBG("Consumer set delete flag on stream by idx %" PRIu64
, net_seq_idx
);
424 /* Let's begin with metadata */
425 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
426 if (stream
->net_seq_idx
== net_seq_idx
) {
427 uatomic_set(&stream
->endpoint_status
, status
);
428 DBG("Delete flag set to metadata stream %d", stream
->wait_fd
);
432 /* Follow up by the data streams */
433 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
434 if (stream
->net_seq_idx
== net_seq_idx
) {
435 uatomic_set(&stream
->endpoint_status
, status
);
436 DBG("Delete flag set to data stream %d", stream
->wait_fd
);
443 * Cleanup a relayd object by flagging every associated streams for deletion,
444 * destroying the object meaning removing it from the relayd hash table,
445 * closing the sockets and freeing the memory in a RCU call.
447 * If a local data context is available, notify the threads that the streams'
448 * state have changed.
450 static void cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
,
451 struct lttng_consumer_local_data
*ctx
)
457 DBG("Cleaning up relayd sockets");
459 /* Save the net sequence index before destroying the object */
460 netidx
= relayd
->net_seq_idx
;
463 * Delete the relayd from the relayd hash table, close the sockets and free
464 * the object in a RCU call.
466 consumer_destroy_relayd(relayd
);
468 /* Set inactive endpoint to all streams */
469 update_endpoint_status_by_netidx(netidx
, CONSUMER_ENDPOINT_INACTIVE
);
472 * With a local data context, notify the threads that the streams' state
473 * have changed. The write() action on the pipe acts as an "implicit"
474 * memory barrier ordering the updates of the end point status from the
475 * read of this status which happens AFTER receiving this notify.
478 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
479 notify_thread_lttng_pipe(ctx
->consumer_metadata_pipe
);
484 * Flag a relayd socket pair for destruction. Destroy it if the refcount
487 * RCU read side lock MUST be aquired before calling this function.
489 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair
*relayd
)
493 /* Set destroy flag for this object */
494 uatomic_set(&relayd
->destroy_flag
, 1);
496 /* Destroy the relayd if refcount is 0 */
497 if (uatomic_read(&relayd
->refcount
) == 0) {
498 consumer_destroy_relayd(relayd
);
503 * Completly destroy stream from every visiable data structure and the given
506 * One this call returns, the stream object is not longer usable nor visible.
508 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
511 consumer_stream_destroy(stream
, ht
);
515 * XXX naming of del vs destroy is all mixed up.
517 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
)
519 consumer_stream_destroy(stream
, data_ht
);
522 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
)
524 consumer_stream_destroy(stream
, metadata_ht
);
527 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
529 enum lttng_consumer_stream_state state
,
530 const char *channel_name
,
537 enum consumer_channel_type type
,
538 unsigned int monitor
)
541 struct lttng_consumer_stream
*stream
;
543 stream
= zmalloc(sizeof(*stream
));
544 if (stream
== NULL
) {
545 PERROR("malloc struct lttng_consumer_stream");
552 stream
->key
= stream_key
;
554 stream
->out_fd_offset
= 0;
555 stream
->output_written
= 0;
556 stream
->state
= state
;
559 stream
->net_seq_idx
= relayd_id
;
560 stream
->session_id
= session_id
;
561 stream
->monitor
= monitor
;
562 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
563 stream
->index_fd
= -1;
564 pthread_mutex_init(&stream
->lock
, NULL
);
566 /* If channel is the metadata, flag this stream as metadata. */
567 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
568 stream
->metadata_flag
= 1;
569 /* Metadata is flat out. */
570 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
571 /* Live rendez-vous point. */
572 pthread_cond_init(&stream
->metadata_rdv
, NULL
);
573 pthread_mutex_init(&stream
->metadata_rdv_lock
, NULL
);
575 /* Format stream name to <channel_name>_<cpu_number> */
576 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
579 PERROR("snprintf stream name");
584 /* Key is always the wait_fd for streams. */
585 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
587 /* Init node per channel id key */
588 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
590 /* Init session id node with the stream session id */
591 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
593 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
594 " relayd_id %" PRIu64
", session_id %" PRIu64
,
595 stream
->name
, stream
->key
, channel_key
,
596 stream
->net_seq_idx
, stream
->session_id
);
612 * Add a stream to the global list protected by a mutex.
614 int consumer_add_data_stream(struct lttng_consumer_stream
*stream
)
616 struct lttng_ht
*ht
= data_ht
;
622 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
624 pthread_mutex_lock(&consumer_data
.lock
);
625 pthread_mutex_lock(&stream
->chan
->lock
);
626 pthread_mutex_lock(&stream
->chan
->timer_lock
);
627 pthread_mutex_lock(&stream
->lock
);
630 /* Steal stream identifier to avoid having streams with the same key */
631 steal_stream_key(stream
->key
, ht
);
633 lttng_ht_add_unique_u64(ht
, &stream
->node
);
635 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
636 &stream
->node_channel_id
);
639 * Add stream to the stream_list_ht of the consumer data. No need to steal
640 * the key since the HT does not use it and we allow to add redundant keys
643 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
646 * When nb_init_stream_left reaches 0, we don't need to trigger any action
647 * in terms of destroying the associated channel, because the action that
648 * causes the count to become 0 also causes a stream to be added. The
649 * channel deletion will thus be triggered by the following removal of this
652 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
653 /* Increment refcount before decrementing nb_init_stream_left */
655 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
658 /* Update consumer data once the node is inserted. */
659 consumer_data
.stream_count
++;
660 consumer_data
.need_update
= 1;
663 pthread_mutex_unlock(&stream
->lock
);
664 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
665 pthread_mutex_unlock(&stream
->chan
->lock
);
666 pthread_mutex_unlock(&consumer_data
.lock
);
671 void consumer_del_data_stream(struct lttng_consumer_stream
*stream
)
673 consumer_del_stream(stream
, data_ht
);
677 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
678 * be acquired before calling this.
680 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
683 struct lttng_ht_node_u64
*node
;
684 struct lttng_ht_iter iter
;
688 lttng_ht_lookup(consumer_data
.relayd_ht
,
689 &relayd
->net_seq_idx
, &iter
);
690 node
= lttng_ht_iter_get_node_u64(&iter
);
694 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
701 * Allocate and return a consumer relayd socket.
703 struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
704 uint64_t net_seq_idx
)
706 struct consumer_relayd_sock_pair
*obj
= NULL
;
708 /* net sequence index of -1 is a failure */
709 if (net_seq_idx
== (uint64_t) -1ULL) {
713 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
715 PERROR("zmalloc relayd sock");
719 obj
->net_seq_idx
= net_seq_idx
;
721 obj
->destroy_flag
= 0;
722 obj
->control_sock
.sock
.fd
= -1;
723 obj
->data_sock
.sock
.fd
= -1;
724 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
725 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
732 * Find a relayd socket pair in the global consumer data.
734 * Return the object if found else NULL.
735 * RCU read-side lock must be held across this call and while using the
738 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
740 struct lttng_ht_iter iter
;
741 struct lttng_ht_node_u64
*node
;
742 struct consumer_relayd_sock_pair
*relayd
= NULL
;
744 /* Negative keys are lookup failures */
745 if (key
== (uint64_t) -1ULL) {
749 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
751 node
= lttng_ht_iter_get_node_u64(&iter
);
753 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
761 * Find a relayd and send the stream
763 * Returns 0 on success, < 0 on error
765 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
,
769 struct consumer_relayd_sock_pair
*relayd
;
772 assert(stream
->net_seq_idx
!= -1ULL);
775 /* The stream is not metadata. Get relayd reference if exists. */
777 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
778 if (relayd
!= NULL
) {
779 /* Add stream on the relayd */
780 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
781 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
782 path
, &stream
->relayd_stream_id
,
783 stream
->chan
->tracefile_size
, stream
->chan
->tracefile_count
);
784 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
789 uatomic_inc(&relayd
->refcount
);
790 stream
->sent_to_relayd
= 1;
792 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't send it.",
793 stream
->key
, stream
->net_seq_idx
);
798 DBG("Stream %s with key %" PRIu64
" sent to relayd id %" PRIu64
,
799 stream
->name
, stream
->key
, stream
->net_seq_idx
);
807 * Find a relayd and send the streams sent message
809 * Returns 0 on success, < 0 on error
811 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
)
814 struct consumer_relayd_sock_pair
*relayd
;
816 assert(net_seq_idx
!= -1ULL);
818 /* The stream is not metadata. Get relayd reference if exists. */
820 relayd
= consumer_find_relayd(net_seq_idx
);
821 if (relayd
!= NULL
) {
822 /* Add stream on the relayd */
823 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
824 ret
= relayd_streams_sent(&relayd
->control_sock
);
825 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
830 ERR("Relayd ID %" PRIu64
" unknown. Can't send streams_sent.",
837 DBG("All streams sent relayd id %" PRIu64
, net_seq_idx
);
845 * Find a relayd and close the stream
847 void close_relayd_stream(struct lttng_consumer_stream
*stream
)
849 struct consumer_relayd_sock_pair
*relayd
;
851 /* The stream is not metadata. Get relayd reference if exists. */
853 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
855 consumer_stream_relayd_close(stream
, relayd
);
861 * Handle stream for relayd transmission if the stream applies for network
862 * streaming where the net sequence index is set.
864 * Return destination file descriptor or negative value on error.
866 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
867 size_t data_size
, unsigned long padding
,
868 struct consumer_relayd_sock_pair
*relayd
)
871 struct lttcomm_relayd_data_hdr data_hdr
;
877 /* Reset data header */
878 memset(&data_hdr
, 0, sizeof(data_hdr
));
880 if (stream
->metadata_flag
) {
881 /* Caller MUST acquire the relayd control socket lock */
882 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
887 /* Metadata are always sent on the control socket. */
888 outfd
= relayd
->control_sock
.sock
.fd
;
890 /* Set header with stream information */
891 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
892 data_hdr
.data_size
= htobe32(data_size
);
893 data_hdr
.padding_size
= htobe32(padding
);
895 * Note that net_seq_num below is assigned with the *current* value of
896 * next_net_seq_num and only after that the next_net_seq_num will be
897 * increment. This is why when issuing a command on the relayd using
898 * this next value, 1 should always be substracted in order to compare
899 * the last seen sequence number on the relayd side to the last sent.
901 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
902 /* Other fields are zeroed previously */
904 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
910 ++stream
->next_net_seq_num
;
912 /* Set to go on data socket */
913 outfd
= relayd
->data_sock
.sock
.fd
;
921 * Allocate and return a new lttng_consumer_channel object using the given key
922 * to initialize the hash table node.
924 * On error, return NULL.
926 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
928 const char *pathname
,
933 enum lttng_event_output output
,
934 uint64_t tracefile_size
,
935 uint64_t tracefile_count
,
936 uint64_t session_id_per_pid
,
937 unsigned int monitor
,
938 unsigned int live_timer_interval
)
940 struct lttng_consumer_channel
*channel
;
942 channel
= zmalloc(sizeof(*channel
));
943 if (channel
== NULL
) {
944 PERROR("malloc struct lttng_consumer_channel");
949 channel
->refcount
= 0;
950 channel
->session_id
= session_id
;
951 channel
->session_id_per_pid
= session_id_per_pid
;
954 channel
->relayd_id
= relayd_id
;
955 channel
->tracefile_size
= tracefile_size
;
956 channel
->tracefile_count
= tracefile_count
;
957 channel
->monitor
= monitor
;
958 channel
->live_timer_interval
= live_timer_interval
;
959 pthread_mutex_init(&channel
->lock
, NULL
);
960 pthread_mutex_init(&channel
->timer_lock
, NULL
);
963 case LTTNG_EVENT_SPLICE
:
964 channel
->output
= CONSUMER_CHANNEL_SPLICE
;
966 case LTTNG_EVENT_MMAP
:
967 channel
->output
= CONSUMER_CHANNEL_MMAP
;
977 * In monitor mode, the streams associated with the channel will be put in
978 * a special list ONLY owned by this channel. So, the refcount is set to 1
979 * here meaning that the channel itself has streams that are referenced.
981 * On a channel deletion, once the channel is no longer visible, the
982 * refcount is decremented and checked for a zero value to delete it. With
983 * streams in no monitor mode, it will now be safe to destroy the channel.
985 if (!channel
->monitor
) {
986 channel
->refcount
= 1;
989 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
990 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
992 strncpy(channel
->name
, name
, sizeof(channel
->name
));
993 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
995 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
997 channel
->wait_fd
= -1;
999 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
1001 DBG("Allocated channel (key %" PRIu64
")", channel
->key
)
1008 * Add a channel to the global list protected by a mutex.
1010 * Always return 0 indicating success.
1012 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
1013 struct lttng_consumer_local_data
*ctx
)
1015 pthread_mutex_lock(&consumer_data
.lock
);
1016 pthread_mutex_lock(&channel
->lock
);
1017 pthread_mutex_lock(&channel
->timer_lock
);
1020 * This gives us a guarantee that the channel we are about to add to the
1021 * channel hash table will be unique. See this function comment on the why
1022 * we need to steel the channel key at this stage.
1024 steal_channel_key(channel
->key
);
1027 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
1030 pthread_mutex_unlock(&channel
->timer_lock
);
1031 pthread_mutex_unlock(&channel
->lock
);
1032 pthread_mutex_unlock(&consumer_data
.lock
);
1034 if (channel
->wait_fd
!= -1 && channel
->type
== CONSUMER_CHANNEL_TYPE_DATA
) {
1035 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
1042 * Allocate the pollfd structure and the local view of the out fds to avoid
1043 * doing a lookup in the linked list and concurrency issues when writing is
1044 * needed. Called with consumer_data.lock held.
1046 * Returns the number of fds in the structures.
1048 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
1049 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
1050 struct lttng_ht
*ht
)
1053 struct lttng_ht_iter iter
;
1054 struct lttng_consumer_stream
*stream
;
1059 assert(local_stream
);
1061 DBG("Updating poll fd array");
1063 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1065 * Only active streams with an active end point can be added to the
1066 * poll set and local stream storage of the thread.
1068 * There is a potential race here for endpoint_status to be updated
1069 * just after the check. However, this is OK since the stream(s) will
1070 * be deleted once the thread is notified that the end point state has
1071 * changed where this function will be called back again.
1073 if (stream
->state
!= LTTNG_CONSUMER_ACTIVE_STREAM
||
1074 stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
1078 * This clobbers way too much the debug output. Uncomment that if you
1079 * need it for debugging purposes.
1081 * DBG("Active FD %d", stream->wait_fd);
1083 (*pollfd
)[i
].fd
= stream
->wait_fd
;
1084 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1085 local_stream
[i
] = stream
;
1091 * Insert the consumer_data_pipe at the end of the array and don't
1092 * increment i so nb_fd is the number of real FD.
1094 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
1095 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1097 (*pollfd
)[i
+ 1].fd
= lttng_pipe_get_readfd(ctx
->consumer_wakeup_pipe
);
1098 (*pollfd
)[i
+ 1].events
= POLLIN
| POLLPRI
;
1103 * Poll on the should_quit pipe and the command socket return -1 on
1104 * error, 1 if should exit, 0 if data is available on the command socket
1106 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
1111 num_rdy
= poll(consumer_sockpoll
, 2, -1);
1112 if (num_rdy
== -1) {
1114 * Restart interrupted system call.
1116 if (errno
== EINTR
) {
1119 PERROR("Poll error");
1122 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
1123 DBG("consumer_should_quit wake up");
1130 * Set the error socket.
1132 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1135 ctx
->consumer_error_socket
= sock
;
1139 * Set the command socket path.
1141 void lttng_consumer_set_command_sock_path(
1142 struct lttng_consumer_local_data
*ctx
, char *sock
)
1144 ctx
->consumer_command_sock_path
= sock
;
1148 * Send return code to the session daemon.
1149 * If the socket is not defined, we return 0, it is not a fatal error
1151 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1153 if (ctx
->consumer_error_socket
> 0) {
1154 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1155 sizeof(enum lttcomm_sessiond_command
));
1162 * Close all the tracefiles and stream fds and MUST be called when all
1163 * instances are destroyed i.e. when all threads were joined and are ended.
1165 void lttng_consumer_cleanup(void)
1167 struct lttng_ht_iter iter
;
1168 struct lttng_consumer_channel
*channel
;
1172 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1174 consumer_del_channel(channel
);
1179 lttng_ht_destroy(consumer_data
.channel_ht
);
1181 cleanup_relayd_ht();
1183 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1186 * This HT contains streams that are freed by either the metadata thread or
1187 * the data thread so we do *nothing* on the hash table and simply destroy
1190 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1194 * Called from signal handler.
1196 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1201 ret
= lttng_write(ctx
->consumer_should_quit
[1], "4", 1);
1203 PERROR("write consumer quit");
1206 DBG("Consumer flag that it should quit");
1209 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1212 int outfd
= stream
->out_fd
;
1215 * This does a blocking write-and-wait on any page that belongs to the
1216 * subbuffer prior to the one we just wrote.
1217 * Don't care about error values, as these are just hints and ways to
1218 * limit the amount of page cache used.
1220 if (orig_offset
< stream
->max_sb_size
) {
1223 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1224 stream
->max_sb_size
,
1225 SYNC_FILE_RANGE_WAIT_BEFORE
1226 | SYNC_FILE_RANGE_WRITE
1227 | SYNC_FILE_RANGE_WAIT_AFTER
);
1229 * Give hints to the kernel about how we access the file:
1230 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1233 * We need to call fadvise again after the file grows because the
1234 * kernel does not seem to apply fadvise to non-existing parts of the
1237 * Call fadvise _after_ having waited for the page writeback to
1238 * complete because the dirty page writeback semantic is not well
1239 * defined. So it can be expected to lead to lower throughput in
1242 posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1243 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1247 * Initialise the necessary environnement :
1248 * - create a new context
1249 * - create the poll_pipe
1250 * - create the should_quit pipe (for signal handler)
1251 * - create the thread pipe (for splice)
1253 * Takes a function pointer as argument, this function is called when data is
1254 * available on a buffer. This function is responsible to do the
1255 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1256 * buffer configuration and then kernctl_put_next_subbuf at the end.
1258 * Returns a pointer to the new context or NULL on error.
1260 struct lttng_consumer_local_data
*lttng_consumer_create(
1261 enum lttng_consumer_type type
,
1262 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1263 struct lttng_consumer_local_data
*ctx
),
1264 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1265 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1266 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1269 struct lttng_consumer_local_data
*ctx
;
1271 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1272 consumer_data
.type
== type
);
1273 consumer_data
.type
= type
;
1275 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1277 PERROR("allocating context");
1281 ctx
->consumer_error_socket
= -1;
1282 ctx
->consumer_metadata_socket
= -1;
1283 pthread_mutex_init(&ctx
->metadata_socket_lock
, NULL
);
1284 /* assign the callbacks */
1285 ctx
->on_buffer_ready
= buffer_ready
;
1286 ctx
->on_recv_channel
= recv_channel
;
1287 ctx
->on_recv_stream
= recv_stream
;
1288 ctx
->on_update_stream
= update_stream
;
1290 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1291 if (!ctx
->consumer_data_pipe
) {
1292 goto error_poll_pipe
;
1295 ctx
->consumer_wakeup_pipe
= lttng_pipe_open(0);
1296 if (!ctx
->consumer_wakeup_pipe
) {
1297 goto error_wakeup_pipe
;
1300 ret
= pipe(ctx
->consumer_should_quit
);
1302 PERROR("Error creating recv pipe");
1303 goto error_quit_pipe
;
1306 ret
= pipe(ctx
->consumer_channel_pipe
);
1308 PERROR("Error creating channel pipe");
1309 goto error_channel_pipe
;
1312 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1313 if (!ctx
->consumer_metadata_pipe
) {
1314 goto error_metadata_pipe
;
1319 error_metadata_pipe
:
1320 utils_close_pipe(ctx
->consumer_channel_pipe
);
1322 utils_close_pipe(ctx
->consumer_should_quit
);
1324 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1326 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1334 * Iterate over all streams of the hashtable and free them properly.
1336 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1338 struct lttng_ht_iter iter
;
1339 struct lttng_consumer_stream
*stream
;
1346 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1348 * Ignore return value since we are currently cleaning up so any error
1351 (void) consumer_del_stream(stream
, ht
);
1355 lttng_ht_destroy(ht
);
1359 * Iterate over all streams of the metadata hashtable and free them
1362 static void destroy_metadata_stream_ht(struct lttng_ht
*ht
)
1364 struct lttng_ht_iter iter
;
1365 struct lttng_consumer_stream
*stream
;
1372 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1374 * Ignore return value since we are currently cleaning up so any error
1377 (void) consumer_del_metadata_stream(stream
, ht
);
1381 lttng_ht_destroy(ht
);
1385 * Close all fds associated with the instance and free the context.
1387 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1391 DBG("Consumer destroying it. Closing everything.");
1397 destroy_data_stream_ht(data_ht
);
1398 destroy_metadata_stream_ht(metadata_ht
);
1400 ret
= close(ctx
->consumer_error_socket
);
1404 ret
= close(ctx
->consumer_metadata_socket
);
1408 utils_close_pipe(ctx
->consumer_channel_pipe
);
1409 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1410 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1411 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1412 utils_close_pipe(ctx
->consumer_should_quit
);
1414 unlink(ctx
->consumer_command_sock_path
);
1419 * Write the metadata stream id on the specified file descriptor.
1421 static int write_relayd_metadata_id(int fd
,
1422 struct lttng_consumer_stream
*stream
,
1423 struct consumer_relayd_sock_pair
*relayd
, unsigned long padding
)
1426 struct lttcomm_relayd_metadata_payload hdr
;
1428 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1429 hdr
.padding_size
= htobe32(padding
);
1430 ret
= lttng_write(fd
, (void *) &hdr
, sizeof(hdr
));
1431 if (ret
< sizeof(hdr
)) {
1433 * This error means that the fd's end is closed so ignore the PERROR
1434 * not to clubber the error output since this can happen in a normal
1437 if (errno
!= EPIPE
) {
1438 PERROR("write metadata stream id");
1440 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1442 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1443 * handle writting the missing part so report that as an error and
1444 * don't lie to the caller.
1449 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1450 stream
->relayd_stream_id
, padding
);
1457 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1458 * core function for writing trace buffers to either the local filesystem or
1461 * It must be called with the stream lock held.
1463 * Careful review MUST be put if any changes occur!
1465 * Returns the number of bytes written
1467 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1468 struct lttng_consumer_local_data
*ctx
,
1469 struct lttng_consumer_stream
*stream
, unsigned long len
,
1470 unsigned long padding
,
1471 struct ctf_packet_index
*index
)
1473 unsigned long mmap_offset
;
1476 off_t orig_offset
= stream
->out_fd_offset
;
1477 /* Default is on the disk */
1478 int outfd
= stream
->out_fd
;
1479 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1480 unsigned int relayd_hang_up
= 0;
1482 /* RCU lock for the relayd pointer */
1485 /* Flag that the current stream if set for network streaming. */
1486 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1487 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1488 if (relayd
== NULL
) {
1494 /* get the offset inside the fd to mmap */
1495 switch (consumer_data
.type
) {
1496 case LTTNG_CONSUMER_KERNEL
:
1497 mmap_base
= stream
->mmap_base
;
1498 ret
= kernctl_get_mmap_read_offset(stream
->wait_fd
, &mmap_offset
);
1501 PERROR("tracer ctl get_mmap_read_offset");
1505 case LTTNG_CONSUMER32_UST
:
1506 case LTTNG_CONSUMER64_UST
:
1507 mmap_base
= lttng_ustctl_get_mmap_base(stream
);
1509 ERR("read mmap get mmap base for stream %s", stream
->name
);
1513 ret
= lttng_ustctl_get_mmap_read_offset(stream
, &mmap_offset
);
1515 PERROR("tracer ctl get_mmap_read_offset");
1521 ERR("Unknown consumer_data type");
1525 /* Handle stream on the relayd if the output is on the network */
1527 unsigned long netlen
= len
;
1530 * Lock the control socket for the complete duration of the function
1531 * since from this point on we will use the socket.
1533 if (stream
->metadata_flag
) {
1534 /* Metadata requires the control socket. */
1535 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1536 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1539 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1544 /* Use the returned socket. */
1547 /* Write metadata stream id before payload */
1548 if (stream
->metadata_flag
) {
1549 ret
= write_relayd_metadata_id(outfd
, stream
, relayd
, padding
);
1556 /* No streaming, we have to set the len with the full padding */
1560 * Check if we need to change the tracefile before writing the packet.
1562 if (stream
->chan
->tracefile_size
> 0 &&
1563 (stream
->tracefile_size_current
+ len
) >
1564 stream
->chan
->tracefile_size
) {
1565 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1566 stream
->name
, stream
->chan
->tracefile_size
,
1567 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1568 stream
->out_fd
, &(stream
->tracefile_count_current
),
1571 ERR("Rotating output file");
1574 outfd
= stream
->out_fd
;
1576 if (stream
->index_fd
>= 0) {
1577 ret
= index_create_file(stream
->chan
->pathname
,
1578 stream
->name
, stream
->uid
, stream
->gid
,
1579 stream
->chan
->tracefile_size
,
1580 stream
->tracefile_count_current
);
1584 stream
->index_fd
= ret
;
1587 /* Reset current size because we just perform a rotation. */
1588 stream
->tracefile_size_current
= 0;
1589 stream
->out_fd_offset
= 0;
1592 stream
->tracefile_size_current
+= len
;
1594 index
->offset
= htobe64(stream
->out_fd_offset
);
1599 * This call guarantee that len or less is returned. It's impossible to
1600 * receive a ret value that is bigger than len.
1602 ret
= lttng_write(outfd
, mmap_base
+ mmap_offset
, len
);
1603 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, len
);
1604 if (ret
< 0 || ((size_t) ret
!= len
)) {
1606 * Report error to caller if nothing was written else at least send the
1614 /* Socket operation failed. We consider the relayd dead */
1615 if (errno
== EPIPE
|| errno
== EINVAL
|| errno
== EBADF
) {
1617 * This is possible if the fd is closed on the other side
1618 * (outfd) or any write problem. It can be verbose a bit for a
1619 * normal execution if for instance the relayd is stopped
1620 * abruptly. This can happen so set this to a DBG statement.
1622 DBG("Consumer mmap write detected relayd hang up");
1624 /* Unhandled error, print it and stop function right now. */
1625 PERROR("Error in write mmap (ret %zd != len %lu)", ret
, len
);
1629 stream
->output_written
+= ret
;
1631 /* This call is useless on a socket so better save a syscall. */
1633 /* This won't block, but will start writeout asynchronously */
1634 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, len
,
1635 SYNC_FILE_RANGE_WRITE
);
1636 stream
->out_fd_offset
+= len
;
1638 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1642 * This is a special case that the relayd has closed its socket. Let's
1643 * cleanup the relayd object and all associated streams.
1645 if (relayd
&& relayd_hang_up
) {
1646 cleanup_relayd(relayd
, ctx
);
1650 /* Unlock only if ctrl socket used */
1651 if (relayd
&& stream
->metadata_flag
) {
1652 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1660 * Splice the data from the ring buffer to the tracefile.
1662 * It must be called with the stream lock held.
1664 * Returns the number of bytes spliced.
1666 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1667 struct lttng_consumer_local_data
*ctx
,
1668 struct lttng_consumer_stream
*stream
, unsigned long len
,
1669 unsigned long padding
,
1670 struct ctf_packet_index
*index
)
1672 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1674 off_t orig_offset
= stream
->out_fd_offset
;
1675 int fd
= stream
->wait_fd
;
1676 /* Default is on the disk */
1677 int outfd
= stream
->out_fd
;
1678 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1680 unsigned int relayd_hang_up
= 0;
1682 switch (consumer_data
.type
) {
1683 case LTTNG_CONSUMER_KERNEL
:
1685 case LTTNG_CONSUMER32_UST
:
1686 case LTTNG_CONSUMER64_UST
:
1687 /* Not supported for user space tracing */
1690 ERR("Unknown consumer_data type");
1694 /* RCU lock for the relayd pointer */
1697 /* Flag that the current stream if set for network streaming. */
1698 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1699 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1700 if (relayd
== NULL
) {
1705 splice_pipe
= stream
->splice_pipe
;
1707 /* Write metadata stream id before payload */
1709 unsigned long total_len
= len
;
1711 if (stream
->metadata_flag
) {
1713 * Lock the control socket for the complete duration of the function
1714 * since from this point on we will use the socket.
1716 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1718 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
, relayd
,
1726 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1729 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1735 /* Use the returned socket. */
1738 /* No streaming, we have to set the len with the full padding */
1742 * Check if we need to change the tracefile before writing the packet.
1744 if (stream
->chan
->tracefile_size
> 0 &&
1745 (stream
->tracefile_size_current
+ len
) >
1746 stream
->chan
->tracefile_size
) {
1747 ret
= utils_rotate_stream_file(stream
->chan
->pathname
,
1748 stream
->name
, stream
->chan
->tracefile_size
,
1749 stream
->chan
->tracefile_count
, stream
->uid
, stream
->gid
,
1750 stream
->out_fd
, &(stream
->tracefile_count_current
),
1754 ERR("Rotating output file");
1757 outfd
= stream
->out_fd
;
1759 if (stream
->index_fd
>= 0) {
1760 ret
= index_create_file(stream
->chan
->pathname
,
1761 stream
->name
, stream
->uid
, stream
->gid
,
1762 stream
->chan
->tracefile_size
,
1763 stream
->tracefile_count_current
);
1768 stream
->index_fd
= ret
;
1771 /* Reset current size because we just perform a rotation. */
1772 stream
->tracefile_size_current
= 0;
1773 stream
->out_fd_offset
= 0;
1776 stream
->tracefile_size_current
+= len
;
1777 index
->offset
= htobe64(stream
->out_fd_offset
);
1781 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1782 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1783 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1784 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1785 DBG("splice chan to pipe, ret %zd", ret_splice
);
1786 if (ret_splice
< 0) {
1789 PERROR("Error in relay splice");
1793 /* Handle stream on the relayd if the output is on the network */
1794 if (relayd
&& stream
->metadata_flag
) {
1795 size_t metadata_payload_size
=
1796 sizeof(struct lttcomm_relayd_metadata_payload
);
1798 /* Update counter to fit the spliced data */
1799 ret_splice
+= metadata_payload_size
;
1800 len
+= metadata_payload_size
;
1802 * We do this so the return value can match the len passed as
1803 * argument to this function.
1805 written
-= metadata_payload_size
;
1808 /* Splice data out */
1809 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1810 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1811 DBG("Consumer splice pipe to file (out_fd: %d), ret %zd",
1813 if (ret_splice
< 0) {
1818 } else if (ret_splice
> len
) {
1820 * We don't expect this code path to be executed but you never know
1821 * so this is an extra protection agains a buggy splice().
1824 written
+= ret_splice
;
1825 PERROR("Wrote more data than requested %zd (len: %lu)", ret_splice
,
1829 /* All good, update current len and continue. */
1833 /* This call is useless on a socket so better save a syscall. */
1835 /* This won't block, but will start writeout asynchronously */
1836 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
1837 SYNC_FILE_RANGE_WRITE
);
1838 stream
->out_fd_offset
+= ret_splice
;
1840 stream
->output_written
+= ret_splice
;
1841 written
+= ret_splice
;
1843 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1848 * This is a special case that the relayd has closed its socket. Let's
1849 * cleanup the relayd object and all associated streams.
1851 if (relayd
&& relayd_hang_up
) {
1852 cleanup_relayd(relayd
, ctx
);
1853 /* Skip splice error so the consumer does not fail */
1858 /* send the appropriate error description to sessiond */
1861 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
1864 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
1867 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
1872 if (relayd
&& stream
->metadata_flag
) {
1873 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1881 * Take a snapshot for a specific fd
1883 * Returns 0 on success, < 0 on error
1885 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
1887 switch (consumer_data
.type
) {
1888 case LTTNG_CONSUMER_KERNEL
:
1889 return lttng_kconsumer_take_snapshot(stream
);
1890 case LTTNG_CONSUMER32_UST
:
1891 case LTTNG_CONSUMER64_UST
:
1892 return lttng_ustconsumer_take_snapshot(stream
);
1894 ERR("Unknown consumer_data type");
1901 * Get the produced position
1903 * Returns 0 on success, < 0 on error
1905 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
1908 switch (consumer_data
.type
) {
1909 case LTTNG_CONSUMER_KERNEL
:
1910 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
1911 case LTTNG_CONSUMER32_UST
:
1912 case LTTNG_CONSUMER64_UST
:
1913 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
1915 ERR("Unknown consumer_data type");
1921 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
1922 int sock
, struct pollfd
*consumer_sockpoll
)
1924 switch (consumer_data
.type
) {
1925 case LTTNG_CONSUMER_KERNEL
:
1926 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1927 case LTTNG_CONSUMER32_UST
:
1928 case LTTNG_CONSUMER64_UST
:
1929 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
1931 ERR("Unknown consumer_data type");
1937 void lttng_consumer_close_all_metadata(void)
1939 switch (consumer_data
.type
) {
1940 case LTTNG_CONSUMER_KERNEL
:
1942 * The Kernel consumer has a different metadata scheme so we don't
1943 * close anything because the stream will be closed by the session
1947 case LTTNG_CONSUMER32_UST
:
1948 case LTTNG_CONSUMER64_UST
:
1950 * Close all metadata streams. The metadata hash table is passed and
1951 * this call iterates over it by closing all wakeup fd. This is safe
1952 * because at this point we are sure that the metadata producer is
1953 * either dead or blocked.
1955 lttng_ustconsumer_close_all_metadata(metadata_ht
);
1958 ERR("Unknown consumer_data type");
1964 * Clean up a metadata stream and free its memory.
1966 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
1967 struct lttng_ht
*ht
)
1969 struct lttng_consumer_channel
*free_chan
= NULL
;
1973 * This call should NEVER receive regular stream. It must always be
1974 * metadata stream and this is crucial for data structure synchronization.
1976 assert(stream
->metadata_flag
);
1978 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
1980 pthread_mutex_lock(&consumer_data
.lock
);
1981 pthread_mutex_lock(&stream
->chan
->lock
);
1982 pthread_mutex_lock(&stream
->lock
);
1984 /* Remove any reference to that stream. */
1985 consumer_stream_delete(stream
, ht
);
1987 /* Close down everything including the relayd if one. */
1988 consumer_stream_close(stream
);
1989 /* Destroy tracer buffers of the stream. */
1990 consumer_stream_destroy_buffers(stream
);
1992 /* Atomically decrement channel refcount since other threads can use it. */
1993 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1)
1994 && !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
1995 /* Go for channel deletion! */
1996 free_chan
= stream
->chan
;
2000 * Nullify the stream reference so it is not used after deletion. The
2001 * channel lock MUST be acquired before being able to check for a NULL
2004 stream
->chan
->metadata_stream
= NULL
;
2006 pthread_mutex_unlock(&stream
->lock
);
2007 pthread_mutex_unlock(&stream
->chan
->lock
);
2008 pthread_mutex_unlock(&consumer_data
.lock
);
2011 consumer_del_channel(free_chan
);
2014 consumer_stream_free(stream
);
2018 * Action done with the metadata stream when adding it to the consumer internal
2019 * data structures to handle it.
2021 int consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
)
2023 struct lttng_ht
*ht
= metadata_ht
;
2025 struct lttng_ht_iter iter
;
2026 struct lttng_ht_node_u64
*node
;
2031 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
2033 pthread_mutex_lock(&consumer_data
.lock
);
2034 pthread_mutex_lock(&stream
->chan
->lock
);
2035 pthread_mutex_lock(&stream
->chan
->timer_lock
);
2036 pthread_mutex_lock(&stream
->lock
);
2039 * From here, refcounts are updated so be _careful_ when returning an error
2046 * Lookup the stream just to make sure it does not exist in our internal
2047 * state. This should NEVER happen.
2049 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
2050 node
= lttng_ht_iter_get_node_u64(&iter
);
2054 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2055 * in terms of destroying the associated channel, because the action that
2056 * causes the count to become 0 also causes a stream to be added. The
2057 * channel deletion will thus be triggered by the following removal of this
2060 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2061 /* Increment refcount before decrementing nb_init_stream_left */
2063 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2066 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2068 lttng_ht_add_unique_u64(consumer_data
.stream_per_chan_id_ht
,
2069 &stream
->node_channel_id
);
2072 * Add stream to the stream_list_ht of the consumer data. No need to steal
2073 * the key since the HT does not use it and we allow to add redundant keys
2076 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2080 pthread_mutex_unlock(&stream
->lock
);
2081 pthread_mutex_unlock(&stream
->chan
->lock
);
2082 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
2083 pthread_mutex_unlock(&consumer_data
.lock
);
2088 * Delete data stream that are flagged for deletion (endpoint_status).
2090 static void validate_endpoint_status_data_stream(void)
2092 struct lttng_ht_iter iter
;
2093 struct lttng_consumer_stream
*stream
;
2095 DBG("Consumer delete flagged data stream");
2098 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2099 /* Validate delete flag of the stream */
2100 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2103 /* Delete it right now */
2104 consumer_del_stream(stream
, data_ht
);
2110 * Delete metadata stream that are flagged for deletion (endpoint_status).
2112 static void validate_endpoint_status_metadata_stream(
2113 struct lttng_poll_event
*pollset
)
2115 struct lttng_ht_iter iter
;
2116 struct lttng_consumer_stream
*stream
;
2118 DBG("Consumer delete flagged metadata stream");
2123 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2124 /* Validate delete flag of the stream */
2125 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2129 * Remove from pollset so the metadata thread can continue without
2130 * blocking on a deleted stream.
2132 lttng_poll_del(pollset
, stream
->wait_fd
);
2134 /* Delete it right now */
2135 consumer_del_metadata_stream(stream
, metadata_ht
);
2141 * Thread polls on metadata file descriptor and write them on disk or on the
2144 void *consumer_thread_metadata_poll(void *data
)
2146 int ret
, i
, pollfd
, err
= -1;
2147 uint32_t revents
, nb_fd
;
2148 struct lttng_consumer_stream
*stream
= NULL
;
2149 struct lttng_ht_iter iter
;
2150 struct lttng_ht_node_u64
*node
;
2151 struct lttng_poll_event events
;
2152 struct lttng_consumer_local_data
*ctx
= data
;
2155 rcu_register_thread();
2157 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_METADATA
);
2159 if (testpoint(consumerd_thread_metadata
)) {
2160 goto error_testpoint
;
2163 health_code_update();
2165 DBG("Thread metadata poll started");
2167 /* Size is set to 1 for the consumer_metadata pipe */
2168 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2170 ERR("Poll set creation failed");
2174 ret
= lttng_poll_add(&events
,
2175 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2181 DBG("Metadata main loop started");
2185 health_code_update();
2186 health_poll_entry();
2187 DBG("Metadata poll wait");
2188 ret
= lttng_poll_wait(&events
, -1);
2189 DBG("Metadata poll return from wait with %d fd(s)",
2190 LTTNG_POLL_GETNB(&events
));
2192 DBG("Metadata event catched in thread");
2194 if (errno
== EINTR
) {
2195 ERR("Poll EINTR catched");
2198 if (LTTNG_POLL_GETNB(&events
) == 0) {
2199 err
= 0; /* All is OK */
2206 /* From here, the event is a metadata wait fd */
2207 for (i
= 0; i
< nb_fd
; i
++) {
2208 health_code_update();
2210 revents
= LTTNG_POLL_GETEV(&events
, i
);
2211 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2214 /* No activity for this FD (poll implementation). */
2218 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2219 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2220 DBG("Metadata thread pipe hung up");
2222 * Remove the pipe from the poll set and continue the loop
2223 * since their might be data to consume.
2225 lttng_poll_del(&events
,
2226 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2227 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2229 } else if (revents
& LPOLLIN
) {
2232 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2233 &stream
, sizeof(stream
));
2234 if (pipe_len
< sizeof(stream
)) {
2235 PERROR("read metadata stream");
2237 * Continue here to handle the rest of the streams.
2242 /* A NULL stream means that the state has changed. */
2243 if (stream
== NULL
) {
2244 /* Check for deleted streams. */
2245 validate_endpoint_status_metadata_stream(&events
);
2249 DBG("Adding metadata stream %d to poll set",
2252 /* Add metadata stream to the global poll events list */
2253 lttng_poll_add(&events
, stream
->wait_fd
,
2254 LPOLLIN
| LPOLLPRI
| LPOLLHUP
);
2257 /* Handle other stream */
2263 uint64_t tmp_id
= (uint64_t) pollfd
;
2265 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2267 node
= lttng_ht_iter_get_node_u64(&iter
);
2270 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2273 /* Check for error event */
2274 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2275 DBG("Metadata fd %d is hup|err.", pollfd
);
2276 if (!stream
->hangup_flush_done
2277 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2278 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2279 DBG("Attempting to flush and consume the UST buffers");
2280 lttng_ustconsumer_on_stream_hangup(stream
);
2282 /* We just flushed the stream now read it. */
2284 health_code_update();
2286 len
= ctx
->on_buffer_ready(stream
, ctx
);
2288 * We don't check the return value here since if we get
2289 * a negative len, it means an error occured thus we
2290 * simply remove it from the poll set and free the
2296 lttng_poll_del(&events
, stream
->wait_fd
);
2298 * This call update the channel states, closes file descriptors
2299 * and securely free the stream.
2301 consumer_del_metadata_stream(stream
, metadata_ht
);
2302 } else if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2303 /* Get the data out of the metadata file descriptor */
2304 DBG("Metadata available on fd %d", pollfd
);
2305 assert(stream
->wait_fd
== pollfd
);
2308 health_code_update();
2310 len
= ctx
->on_buffer_ready(stream
, ctx
);
2312 * We don't check the return value here since if we get
2313 * a negative len, it means an error occured thus we
2314 * simply remove it from the poll set and free the
2319 /* It's ok to have an unavailable sub-buffer */
2320 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2321 /* Clean up stream from consumer and free it. */
2322 lttng_poll_del(&events
, stream
->wait_fd
);
2323 consumer_del_metadata_stream(stream
, metadata_ht
);
2327 /* Release RCU lock for the stream looked up */
2336 DBG("Metadata poll thread exiting");
2338 lttng_poll_clean(&events
);
2343 ERR("Health error occurred in %s", __func__
);
2345 health_unregister(health_consumerd
);
2346 rcu_unregister_thread();
2351 * This thread polls the fds in the set to consume the data and write
2352 * it to tracefile if necessary.
2354 void *consumer_thread_data_poll(void *data
)
2356 int num_rdy
, num_hup
, high_prio
, ret
, i
, err
= -1;
2357 struct pollfd
*pollfd
= NULL
;
2358 /* local view of the streams */
2359 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2360 /* local view of consumer_data.fds_count */
2362 struct lttng_consumer_local_data
*ctx
= data
;
2365 rcu_register_thread();
2367 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_DATA
);
2369 if (testpoint(consumerd_thread_data
)) {
2370 goto error_testpoint
;
2373 health_code_update();
2375 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
*));
2376 if (local_stream
== NULL
) {
2377 PERROR("local_stream malloc");
2382 health_code_update();
2388 * the fds set has been updated, we need to update our
2389 * local array as well
2391 pthread_mutex_lock(&consumer_data
.lock
);
2392 if (consumer_data
.need_update
) {
2397 local_stream
= NULL
;
2400 * Allocate for all fds +1 for the consumer_data_pipe and +1 for
2403 pollfd
= zmalloc((consumer_data
.stream_count
+ 2) * sizeof(struct pollfd
));
2404 if (pollfd
== NULL
) {
2405 PERROR("pollfd malloc");
2406 pthread_mutex_unlock(&consumer_data
.lock
);
2410 local_stream
= zmalloc((consumer_data
.stream_count
+ 2) *
2411 sizeof(struct lttng_consumer_stream
*));
2412 if (local_stream
== NULL
) {
2413 PERROR("local_stream malloc");
2414 pthread_mutex_unlock(&consumer_data
.lock
);
2417 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2420 ERR("Error in allocating pollfd or local_outfds");
2421 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2422 pthread_mutex_unlock(&consumer_data
.lock
);
2426 consumer_data
.need_update
= 0;
2428 pthread_mutex_unlock(&consumer_data
.lock
);
2430 /* No FDs and consumer_quit, consumer_cleanup the thread */
2431 if (nb_fd
== 0 && consumer_quit
== 1) {
2432 err
= 0; /* All is OK */
2435 /* poll on the array of fds */
2437 DBG("polling on %d fd", nb_fd
+ 2);
2438 health_poll_entry();
2439 num_rdy
= poll(pollfd
, nb_fd
+ 2, -1);
2441 DBG("poll num_rdy : %d", num_rdy
);
2442 if (num_rdy
== -1) {
2444 * Restart interrupted system call.
2446 if (errno
== EINTR
) {
2449 PERROR("Poll error");
2450 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2452 } else if (num_rdy
== 0) {
2453 DBG("Polling thread timed out");
2458 * If the consumer_data_pipe triggered poll go directly to the
2459 * beginning of the loop to update the array. We want to prioritize
2460 * array update over low-priority reads.
2462 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2463 ssize_t pipe_readlen
;
2465 DBG("consumer_data_pipe wake up");
2466 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2467 &new_stream
, sizeof(new_stream
));
2468 if (pipe_readlen
< sizeof(new_stream
)) {
2469 PERROR("Consumer data pipe");
2470 /* Continue so we can at least handle the current stream(s). */
2475 * If the stream is NULL, just ignore it. It's also possible that
2476 * the sessiond poll thread changed the consumer_quit state and is
2477 * waking us up to test it.
2479 if (new_stream
== NULL
) {
2480 validate_endpoint_status_data_stream();
2484 /* Continue to update the local streams and handle prio ones */
2488 /* Handle wakeup pipe. */
2489 if (pollfd
[nb_fd
+ 1].revents
& (POLLIN
| POLLPRI
)) {
2491 ssize_t pipe_readlen
;
2493 pipe_readlen
= lttng_pipe_read(ctx
->consumer_wakeup_pipe
, &dummy
,
2495 if (pipe_readlen
< 0) {
2496 PERROR("Consumer data wakeup pipe");
2498 /* We've been awakened to handle stream(s). */
2499 ctx
->has_wakeup
= 0;
2502 /* Take care of high priority channels first. */
2503 for (i
= 0; i
< nb_fd
; i
++) {
2504 health_code_update();
2506 if (local_stream
[i
] == NULL
) {
2509 if (pollfd
[i
].revents
& POLLPRI
) {
2510 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2512 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2513 /* it's ok to have an unavailable sub-buffer */
2514 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2515 /* Clean the stream and free it. */
2516 consumer_del_stream(local_stream
[i
], data_ht
);
2517 local_stream
[i
] = NULL
;
2518 } else if (len
> 0) {
2519 local_stream
[i
]->data_read
= 1;
2525 * If we read high prio channel in this loop, try again
2526 * for more high prio data.
2532 /* Take care of low priority channels. */
2533 for (i
= 0; i
< nb_fd
; i
++) {
2534 health_code_update();
2536 if (local_stream
[i
] == NULL
) {
2539 if ((pollfd
[i
].revents
& POLLIN
) ||
2540 local_stream
[i
]->hangup_flush_done
||
2541 local_stream
[i
]->has_data
) {
2542 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2543 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2544 /* it's ok to have an unavailable sub-buffer */
2545 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2546 /* Clean the stream and free it. */
2547 consumer_del_stream(local_stream
[i
], data_ht
);
2548 local_stream
[i
] = NULL
;
2549 } else if (len
> 0) {
2550 local_stream
[i
]->data_read
= 1;
2555 /* Handle hangup and errors */
2556 for (i
= 0; i
< nb_fd
; i
++) {
2557 health_code_update();
2559 if (local_stream
[i
] == NULL
) {
2562 if (!local_stream
[i
]->hangup_flush_done
2563 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2564 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2565 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2566 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2568 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2569 /* Attempt read again, for the data we just flushed. */
2570 local_stream
[i
]->data_read
= 1;
2573 * If the poll flag is HUP/ERR/NVAL and we have
2574 * read no data in this pass, we can remove the
2575 * stream from its hash table.
2577 if ((pollfd
[i
].revents
& POLLHUP
)) {
2578 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2579 if (!local_stream
[i
]->data_read
) {
2580 consumer_del_stream(local_stream
[i
], data_ht
);
2581 local_stream
[i
] = NULL
;
2584 } else if (pollfd
[i
].revents
& POLLERR
) {
2585 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2586 if (!local_stream
[i
]->data_read
) {
2587 consumer_del_stream(local_stream
[i
], data_ht
);
2588 local_stream
[i
] = NULL
;
2591 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2592 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2593 if (!local_stream
[i
]->data_read
) {
2594 consumer_del_stream(local_stream
[i
], data_ht
);
2595 local_stream
[i
] = NULL
;
2599 if (local_stream
[i
] != NULL
) {
2600 local_stream
[i
]->data_read
= 0;
2607 DBG("polling thread exiting");
2612 * Close the write side of the pipe so epoll_wait() in
2613 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2614 * read side of the pipe. If we close them both, epoll_wait strangely does
2615 * not return and could create a endless wait period if the pipe is the
2616 * only tracked fd in the poll set. The thread will take care of closing
2619 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2624 ERR("Health error occurred in %s", __func__
);
2626 health_unregister(health_consumerd
);
2628 rcu_unregister_thread();
2633 * Close wake-up end of each stream belonging to the channel. This will
2634 * allow the poll() on the stream read-side to detect when the
2635 * write-side (application) finally closes them.
2638 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2640 struct lttng_ht
*ht
;
2641 struct lttng_consumer_stream
*stream
;
2642 struct lttng_ht_iter iter
;
2644 ht
= consumer_data
.stream_per_chan_id_ht
;
2647 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2648 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2649 ht
->match_fct
, &channel
->key
,
2650 &iter
.iter
, stream
, node_channel_id
.node
) {
2652 * Protect against teardown with mutex.
2654 pthread_mutex_lock(&stream
->lock
);
2655 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2658 switch (consumer_data
.type
) {
2659 case LTTNG_CONSUMER_KERNEL
:
2661 case LTTNG_CONSUMER32_UST
:
2662 case LTTNG_CONSUMER64_UST
:
2663 if (stream
->metadata_flag
) {
2664 /* Safe and protected by the stream lock. */
2665 lttng_ustconsumer_close_metadata(stream
->chan
);
2668 * Note: a mutex is taken internally within
2669 * liblttng-ust-ctl to protect timer wakeup_fd
2670 * use from concurrent close.
2672 lttng_ustconsumer_close_stream_wakeup(stream
);
2676 ERR("Unknown consumer_data type");
2680 pthread_mutex_unlock(&stream
->lock
);
2685 static void destroy_channel_ht(struct lttng_ht
*ht
)
2687 struct lttng_ht_iter iter
;
2688 struct lttng_consumer_channel
*channel
;
2696 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2697 ret
= lttng_ht_del(ht
, &iter
);
2702 lttng_ht_destroy(ht
);
2706 * This thread polls the channel fds to detect when they are being
2707 * closed. It closes all related streams if the channel is detected as
2708 * closed. It is currently only used as a shim layer for UST because the
2709 * consumerd needs to keep the per-stream wakeup end of pipes open for
2712 void *consumer_thread_channel_poll(void *data
)
2714 int ret
, i
, pollfd
, err
= -1;
2715 uint32_t revents
, nb_fd
;
2716 struct lttng_consumer_channel
*chan
= NULL
;
2717 struct lttng_ht_iter iter
;
2718 struct lttng_ht_node_u64
*node
;
2719 struct lttng_poll_event events
;
2720 struct lttng_consumer_local_data
*ctx
= data
;
2721 struct lttng_ht
*channel_ht
;
2723 rcu_register_thread();
2725 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_CHANNEL
);
2727 if (testpoint(consumerd_thread_channel
)) {
2728 goto error_testpoint
;
2731 health_code_update();
2733 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2735 /* ENOMEM at this point. Better to bail out. */
2739 DBG("Thread channel poll started");
2741 /* Size is set to 1 for the consumer_channel pipe */
2742 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2744 ERR("Poll set creation failed");
2748 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
2754 DBG("Channel main loop started");
2758 health_code_update();
2759 DBG("Channel poll wait");
2760 health_poll_entry();
2761 ret
= lttng_poll_wait(&events
, -1);
2762 DBG("Channel poll return from wait with %d fd(s)",
2763 LTTNG_POLL_GETNB(&events
));
2765 DBG("Channel event catched in thread");
2767 if (errno
== EINTR
) {
2768 ERR("Poll EINTR catched");
2771 if (LTTNG_POLL_GETNB(&events
) == 0) {
2772 err
= 0; /* All is OK */
2779 /* From here, the event is a channel wait fd */
2780 for (i
= 0; i
< nb_fd
; i
++) {
2781 health_code_update();
2783 revents
= LTTNG_POLL_GETEV(&events
, i
);
2784 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2787 /* No activity for this FD (poll implementation). */
2791 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
2792 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2793 DBG("Channel thread pipe hung up");
2795 * Remove the pipe from the poll set and continue the loop
2796 * since their might be data to consume.
2798 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2800 } else if (revents
& LPOLLIN
) {
2801 enum consumer_channel_action action
;
2804 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
2806 ERR("Error reading channel pipe");
2811 case CONSUMER_CHANNEL_ADD
:
2812 DBG("Adding channel %d to poll set",
2815 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
2818 lttng_ht_add_unique_u64(channel_ht
,
2819 &chan
->wait_fd_node
);
2821 /* Add channel to the global poll events list */
2822 lttng_poll_add(&events
, chan
->wait_fd
,
2823 LPOLLIN
| LPOLLPRI
);
2825 case CONSUMER_CHANNEL_DEL
:
2828 * This command should never be called if the channel
2829 * has streams monitored by either the data or metadata
2830 * thread. The consumer only notify this thread with a
2831 * channel del. command if it receives a destroy
2832 * channel command from the session daemon that send it
2833 * if a command prior to the GET_CHANNEL failed.
2837 chan
= consumer_find_channel(key
);
2840 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
2843 lttng_poll_del(&events
, chan
->wait_fd
);
2844 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
2845 ret
= lttng_ht_del(channel_ht
, &iter
);
2848 switch (consumer_data
.type
) {
2849 case LTTNG_CONSUMER_KERNEL
:
2851 case LTTNG_CONSUMER32_UST
:
2852 case LTTNG_CONSUMER64_UST
:
2853 health_code_update();
2854 /* Destroy streams that might have been left in the stream list. */
2855 clean_channel_stream_list(chan
);
2858 ERR("Unknown consumer_data type");
2863 * Release our own refcount. Force channel deletion even if
2864 * streams were not initialized.
2866 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
2867 consumer_del_channel(chan
);
2872 case CONSUMER_CHANNEL_QUIT
:
2874 * Remove the pipe from the poll set and continue the loop
2875 * since their might be data to consume.
2877 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
2880 ERR("Unknown action");
2885 /* Handle other stream */
2891 uint64_t tmp_id
= (uint64_t) pollfd
;
2893 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
2895 node
= lttng_ht_iter_get_node_u64(&iter
);
2898 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
2901 /* Check for error event */
2902 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2903 DBG("Channel fd %d is hup|err.", pollfd
);
2905 lttng_poll_del(&events
, chan
->wait_fd
);
2906 ret
= lttng_ht_del(channel_ht
, &iter
);
2910 * This will close the wait fd for each stream associated to
2911 * this channel AND monitored by the data/metadata thread thus
2912 * will be clean by the right thread.
2914 consumer_close_channel_streams(chan
);
2916 /* Release our own refcount */
2917 if (!uatomic_sub_return(&chan
->refcount
, 1)
2918 && !uatomic_read(&chan
->nb_init_stream_left
)) {
2919 consumer_del_channel(chan
);
2923 /* Release RCU lock for the channel looked up */
2931 lttng_poll_clean(&events
);
2933 destroy_channel_ht(channel_ht
);
2936 DBG("Channel poll thread exiting");
2939 ERR("Health error occurred in %s", __func__
);
2941 health_unregister(health_consumerd
);
2942 rcu_unregister_thread();
2946 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
2947 struct pollfd
*sockpoll
, int client_socket
)
2954 ret
= lttng_consumer_poll_socket(sockpoll
);
2958 DBG("Metadata connection on client_socket");
2960 /* Blocking call, waiting for transmission */
2961 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
2962 if (ctx
->consumer_metadata_socket
< 0) {
2963 WARN("On accept metadata");
2974 * This thread listens on the consumerd socket and receives the file
2975 * descriptors from the session daemon.
2977 void *consumer_thread_sessiond_poll(void *data
)
2979 int sock
= -1, client_socket
, ret
, err
= -1;
2981 * structure to poll for incoming data on communication socket avoids
2982 * making blocking sockets.
2984 struct pollfd consumer_sockpoll
[2];
2985 struct lttng_consumer_local_data
*ctx
= data
;
2987 rcu_register_thread();
2989 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_SESSIOND
);
2991 if (testpoint(consumerd_thread_sessiond
)) {
2992 goto error_testpoint
;
2995 health_code_update();
2997 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
2998 unlink(ctx
->consumer_command_sock_path
);
2999 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
3000 if (client_socket
< 0) {
3001 ERR("Cannot create command socket");
3005 ret
= lttcomm_listen_unix_sock(client_socket
);
3010 DBG("Sending ready command to lttng-sessiond");
3011 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
3012 /* return < 0 on error, but == 0 is not fatal */
3014 ERR("Error sending ready command to lttng-sessiond");
3018 /* prepare the FDs to poll : to client socket and the should_quit pipe */
3019 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
3020 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
3021 consumer_sockpoll
[1].fd
= client_socket
;
3022 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3024 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3032 DBG("Connection on client_socket");
3034 /* Blocking call, waiting for transmission */
3035 sock
= lttcomm_accept_unix_sock(client_socket
);
3042 * Setup metadata socket which is the second socket connection on the
3043 * command unix socket.
3045 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
3054 /* This socket is not useful anymore. */
3055 ret
= close(client_socket
);
3057 PERROR("close client_socket");
3061 /* update the polling structure to poll on the established socket */
3062 consumer_sockpoll
[1].fd
= sock
;
3063 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3066 health_code_update();
3068 health_poll_entry();
3069 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3078 DBG("Incoming command on sock");
3079 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
3082 * This could simply be a session daemon quitting. Don't output
3085 DBG("Communication interrupted on command socket");
3089 if (consumer_quit
) {
3090 DBG("consumer_thread_receive_fds received quit from signal");
3091 err
= 0; /* All is OK */
3094 DBG("received command on sock");
3100 DBG("Consumer thread sessiond poll exiting");
3103 * Close metadata streams since the producer is the session daemon which
3106 * NOTE: for now, this only applies to the UST tracer.
3108 lttng_consumer_close_all_metadata();
3111 * when all fds have hung up, the polling thread
3117 * Notify the data poll thread to poll back again and test the
3118 * consumer_quit state that we just set so to quit gracefully.
3120 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
3122 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
3124 notify_health_quit_pipe(health_quit_pipe
);
3126 /* Cleaning up possibly open sockets. */
3130 PERROR("close sock sessiond poll");
3133 if (client_socket
>= 0) {
3134 ret
= close(client_socket
);
3136 PERROR("close client_socket sessiond poll");
3143 ERR("Health error occurred in %s", __func__
);
3145 health_unregister(health_consumerd
);
3147 rcu_unregister_thread();
3151 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
3152 struct lttng_consumer_local_data
*ctx
)
3156 pthread_mutex_lock(&stream
->lock
);
3157 if (stream
->metadata_flag
) {
3158 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
3161 switch (consumer_data
.type
) {
3162 case LTTNG_CONSUMER_KERNEL
:
3163 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
3165 case LTTNG_CONSUMER32_UST
:
3166 case LTTNG_CONSUMER64_UST
:
3167 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3170 ERR("Unknown consumer_data type");
3176 if (stream
->metadata_flag
) {
3177 pthread_cond_broadcast(&stream
->metadata_rdv
);
3178 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
3180 pthread_mutex_unlock(&stream
->lock
);
3184 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3186 switch (consumer_data
.type
) {
3187 case LTTNG_CONSUMER_KERNEL
:
3188 return lttng_kconsumer_on_recv_stream(stream
);
3189 case LTTNG_CONSUMER32_UST
:
3190 case LTTNG_CONSUMER64_UST
:
3191 return lttng_ustconsumer_on_recv_stream(stream
);
3193 ERR("Unknown consumer_data type");
3200 * Allocate and set consumer data hash tables.
3202 int lttng_consumer_init(void)
3204 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3205 if (!consumer_data
.channel_ht
) {
3209 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3210 if (!consumer_data
.relayd_ht
) {
3214 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3215 if (!consumer_data
.stream_list_ht
) {
3219 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3220 if (!consumer_data
.stream_per_chan_id_ht
) {
3224 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3229 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3241 * Process the ADD_RELAYD command receive by a consumer.
3243 * This will create a relayd socket pair and add it to the relayd hash table.
3244 * The caller MUST acquire a RCU read side lock before calling it.
3246 int consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3247 struct lttng_consumer_local_data
*ctx
, int sock
,
3248 struct pollfd
*consumer_sockpoll
,
3249 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
,
3250 uint64_t relayd_session_id
)
3252 int fd
= -1, ret
= -1, relayd_created
= 0;
3253 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3254 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3257 assert(relayd_sock
);
3259 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3261 /* Get relayd reference if exists. */
3262 relayd
= consumer_find_relayd(net_seq_idx
);
3263 if (relayd
== NULL
) {
3264 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3265 /* Not found. Allocate one. */
3266 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3267 if (relayd
== NULL
) {
3269 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3272 relayd
->sessiond_session_id
= sessiond_id
;
3277 * This code path MUST continue to the consumer send status message to
3278 * we can notify the session daemon and continue our work without
3279 * killing everything.
3283 * relayd key should never be found for control socket.
3285 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3288 /* First send a status message before receiving the fds. */
3289 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
3291 /* Somehow, the session daemon is not responding anymore. */
3292 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3293 goto error_nosignal
;
3296 /* Poll on consumer socket. */
3297 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3299 /* Needing to exit in the middle of a command: error. */
3300 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3302 goto error_nosignal
;
3305 /* Get relayd socket from session daemon */
3306 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3307 if (ret
!= sizeof(fd
)) {
3309 fd
= -1; /* Just in case it gets set with an invalid value. */
3312 * Failing to receive FDs might indicate a major problem such as
3313 * reaching a fd limit during the receive where the kernel returns a
3314 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3315 * don't take any chances and stop everything.
3317 * XXX: Feature request #558 will fix that and avoid this possible
3318 * issue when reaching the fd limit.
3320 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3321 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3325 /* Copy socket information and received FD */
3326 switch (sock_type
) {
3327 case LTTNG_STREAM_CONTROL
:
3328 /* Copy received lttcomm socket */
3329 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3330 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3331 /* Handle create_sock error. */
3333 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3337 * Close the socket created internally by
3338 * lttcomm_create_sock, so we can replace it by the one
3339 * received from sessiond.
3341 if (close(relayd
->control_sock
.sock
.fd
)) {
3345 /* Assign new file descriptor */
3346 relayd
->control_sock
.sock
.fd
= fd
;
3347 fd
= -1; /* For error path */
3348 /* Assign version values. */
3349 relayd
->control_sock
.major
= relayd_sock
->major
;
3350 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3352 relayd
->relayd_session_id
= relayd_session_id
;
3355 case LTTNG_STREAM_DATA
:
3356 /* Copy received lttcomm socket */
3357 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3358 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3359 /* Handle create_sock error. */
3361 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3365 * Close the socket created internally by
3366 * lttcomm_create_sock, so we can replace it by the one
3367 * received from sessiond.
3369 if (close(relayd
->data_sock
.sock
.fd
)) {
3373 /* Assign new file descriptor */
3374 relayd
->data_sock
.sock
.fd
= fd
;
3375 fd
= -1; /* for eventual error paths */
3376 /* Assign version values. */
3377 relayd
->data_sock
.major
= relayd_sock
->major
;
3378 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3381 ERR("Unknown relayd socket type (%d)", sock_type
);
3383 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3387 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3388 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3389 relayd
->net_seq_idx
, fd
);
3391 /* We successfully added the socket. Send status back. */
3392 ret
= consumer_send_status_msg(sock
, ret_code
);
3394 /* Somehow, the session daemon is not responding anymore. */
3395 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3396 goto error_nosignal
;
3400 * Add relayd socket pair to consumer data hashtable. If object already
3401 * exists or on error, the function gracefully returns.
3409 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3410 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3414 /* Close received socket if valid. */
3417 PERROR("close received socket");
3421 if (relayd_created
) {
3429 * Try to lock the stream mutex.
3431 * On success, 1 is returned else 0 indicating that the mutex is NOT lock.
3433 static int stream_try_lock(struct lttng_consumer_stream
*stream
)
3440 * Try to lock the stream mutex. On failure, we know that the stream is
3441 * being used else where hence there is data still being extracted.
3443 ret
= pthread_mutex_trylock(&stream
->lock
);
3445 /* For both EBUSY and EINVAL error, the mutex is NOT locked. */
3457 * Search for a relayd associated to the session id and return the reference.
3459 * A rcu read side lock MUST be acquire before calling this function and locked
3460 * until the relayd object is no longer necessary.
3462 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3464 struct lttng_ht_iter iter
;
3465 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3467 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3468 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3471 * Check by sessiond id which is unique here where the relayd session
3472 * id might not be when having multiple relayd.
3474 if (relayd
->sessiond_session_id
== id
) {
3475 /* Found the relayd. There can be only one per id. */
3487 * Check if for a given session id there is still data needed to be extract
3490 * Return 1 if data is pending or else 0 meaning ready to be read.
3492 int consumer_data_pending(uint64_t id
)
3495 struct lttng_ht_iter iter
;
3496 struct lttng_ht
*ht
;
3497 struct lttng_consumer_stream
*stream
;
3498 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3499 int (*data_pending
)(struct lttng_consumer_stream
*);
3501 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3504 pthread_mutex_lock(&consumer_data
.lock
);
3506 switch (consumer_data
.type
) {
3507 case LTTNG_CONSUMER_KERNEL
:
3508 data_pending
= lttng_kconsumer_data_pending
;
3510 case LTTNG_CONSUMER32_UST
:
3511 case LTTNG_CONSUMER64_UST
:
3512 data_pending
= lttng_ustconsumer_data_pending
;
3515 ERR("Unknown consumer data type");
3519 /* Ease our life a bit */
3520 ht
= consumer_data
.stream_list_ht
;
3522 relayd
= find_relayd_by_session_id(id
);
3524 /* Send init command for data pending. */
3525 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3526 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3527 relayd
->relayd_session_id
);
3528 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3530 /* Communication error thus the relayd so no data pending. */
3531 goto data_not_pending
;
3535 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3536 ht
->hash_fct(&id
, lttng_ht_seed
),
3538 &iter
.iter
, stream
, node_session_id
.node
) {
3539 /* If this call fails, the stream is being used hence data pending. */
3540 ret
= stream_try_lock(stream
);
3546 * A removed node from the hash table indicates that the stream has
3547 * been deleted thus having a guarantee that the buffers are closed
3548 * on the consumer side. However, data can still be transmitted
3549 * over the network so don't skip the relayd check.
3551 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3553 /* Check the stream if there is data in the buffers. */
3554 ret
= data_pending(stream
);
3556 pthread_mutex_unlock(&stream
->lock
);
3563 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3564 if (stream
->metadata_flag
) {
3565 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3566 stream
->relayd_stream_id
);
3568 ret
= relayd_data_pending(&relayd
->control_sock
,
3569 stream
->relayd_stream_id
,
3570 stream
->next_net_seq_num
- 1);
3572 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3574 pthread_mutex_unlock(&stream
->lock
);
3578 pthread_mutex_unlock(&stream
->lock
);
3582 unsigned int is_data_inflight
= 0;
3584 /* Send init command for data pending. */
3585 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3586 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3587 relayd
->relayd_session_id
, &is_data_inflight
);
3588 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3590 goto data_not_pending
;
3592 if (is_data_inflight
) {
3598 * Finding _no_ node in the hash table and no inflight data means that the
3599 * stream(s) have been removed thus data is guaranteed to be available for
3600 * analysis from the trace files.
3604 /* Data is available to be read by a viewer. */
3605 pthread_mutex_unlock(&consumer_data
.lock
);
3610 /* Data is still being extracted from buffers. */
3611 pthread_mutex_unlock(&consumer_data
.lock
);
3617 * Send a ret code status message to the sessiond daemon.
3619 * Return the sendmsg() return value.
3621 int consumer_send_status_msg(int sock
, int ret_code
)
3623 struct lttcomm_consumer_status_msg msg
;
3625 memset(&msg
, 0, sizeof(msg
));
3626 msg
.ret_code
= ret_code
;
3628 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3632 * Send a channel status message to the sessiond daemon.
3634 * Return the sendmsg() return value.
3636 int consumer_send_status_channel(int sock
,
3637 struct lttng_consumer_channel
*channel
)
3639 struct lttcomm_consumer_status_channel msg
;
3643 memset(&msg
, 0, sizeof(msg
));
3645 msg
.ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
3647 msg
.ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3648 msg
.key
= channel
->key
;
3649 msg
.stream_count
= channel
->streams
.count
;
3652 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3656 * Using a maximum stream size with the produced and consumed position of a
3657 * stream, computes the new consumed position to be as close as possible to the
3658 * maximum possible stream size.
3660 * If maximum stream size is lower than the possible buffer size (produced -
3661 * consumed), the consumed_pos given is returned untouched else the new value
3664 unsigned long consumer_get_consumed_maxsize(unsigned long consumed_pos
,
3665 unsigned long produced_pos
, uint64_t max_stream_size
)
3667 if (max_stream_size
&& max_stream_size
< (produced_pos
- consumed_pos
)) {
3668 /* Offset from the produced position to get the latest buffers. */
3669 return produced_pos
- max_stream_size
;
3672 return consumed_pos
;