2 * Copyright (C) 2011 Julien Desfossez <julien.desfossez@polymtl.ca>
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2012 David Goulet <dgoulet@efficios.com>
6 * SPDX-License-Identifier: GPL-2.0-only
17 #include <sys/socket.h>
18 #include <sys/types.h>
23 #include <bin/lttng-consumerd/health-consumerd.h>
24 #include <common/common.h>
25 #include <common/utils.h>
26 #include <common/time.h>
27 #include <common/compat/poll.h>
28 #include <common/compat/endian.h>
29 #include <common/index/index.h>
30 #include <common/kernel-ctl/kernel-ctl.h>
31 #include <common/sessiond-comm/relayd.h>
32 #include <common/sessiond-comm/sessiond-comm.h>
33 #include <common/kernel-consumer/kernel-consumer.h>
34 #include <common/relayd/relayd.h>
35 #include <common/ust-consumer/ust-consumer.h>
36 #include <common/consumer/consumer-timer.h>
37 #include <common/consumer/consumer.h>
38 #include <common/consumer/consumer-stream.h>
39 #include <common/consumer/consumer-testpoint.h>
40 #include <common/align.h>
41 #include <common/consumer/consumer-metadata-cache.h>
42 #include <common/trace-chunk.h>
43 #include <common/trace-chunk-registry.h>
44 #include <common/string-utils/format.h>
45 #include <common/dynamic-array.h>
47 struct lttng_consumer_global_data consumer_data
= {
50 .type
= LTTNG_CONSUMER_UNKNOWN
,
53 enum consumer_channel_action
{
56 CONSUMER_CHANNEL_QUIT
,
59 struct consumer_channel_msg
{
60 enum consumer_channel_action action
;
61 struct lttng_consumer_channel
*chan
; /* add */
62 uint64_t key
; /* del */
65 /* Flag used to temporarily pause data consumption from testpoints. */
66 int data_consumption_paused
;
69 * Flag to inform the polling thread to quit when all fd hung up. Updated by
70 * the consumer_thread_receive_fds when it notices that all fds has hung up.
71 * Also updated by the signal handler (consumer_should_exit()). Read by the
77 * Global hash table containing respectively metadata and data streams. The
78 * stream element in this ht should only be updated by the metadata poll thread
79 * for the metadata and the data poll thread for the data.
81 static struct lttng_ht
*metadata_ht
;
82 static struct lttng_ht
*data_ht
;
84 static const char *get_consumer_domain(void)
86 switch (consumer_data
.type
) {
87 case LTTNG_CONSUMER_KERNEL
:
88 return DEFAULT_KERNEL_TRACE_DIR
;
89 case LTTNG_CONSUMER64_UST
:
91 case LTTNG_CONSUMER32_UST
:
92 return DEFAULT_UST_TRACE_DIR
;
99 * Notify a thread lttng pipe to poll back again. This usually means that some
100 * global state has changed so we just send back the thread in a poll wait
103 static void notify_thread_lttng_pipe(struct lttng_pipe
*pipe
)
105 struct lttng_consumer_stream
*null_stream
= NULL
;
109 (void) lttng_pipe_write(pipe
, &null_stream
, sizeof(null_stream
));
112 static void notify_health_quit_pipe(int *pipe
)
116 ret
= lttng_write(pipe
[1], "4", 1);
118 PERROR("write consumer health quit");
122 static void notify_channel_pipe(struct lttng_consumer_local_data
*ctx
,
123 struct lttng_consumer_channel
*chan
,
125 enum consumer_channel_action action
)
127 struct consumer_channel_msg msg
;
130 memset(&msg
, 0, sizeof(msg
));
135 ret
= lttng_write(ctx
->consumer_channel_pipe
[1], &msg
, sizeof(msg
));
136 if (ret
< sizeof(msg
)) {
137 PERROR("notify_channel_pipe write error");
141 void notify_thread_del_channel(struct lttng_consumer_local_data
*ctx
,
144 notify_channel_pipe(ctx
, NULL
, key
, CONSUMER_CHANNEL_DEL
);
147 static int read_channel_pipe(struct lttng_consumer_local_data
*ctx
,
148 struct lttng_consumer_channel
**chan
,
150 enum consumer_channel_action
*action
)
152 struct consumer_channel_msg msg
;
155 ret
= lttng_read(ctx
->consumer_channel_pipe
[0], &msg
, sizeof(msg
));
156 if (ret
< sizeof(msg
)) {
160 *action
= msg
.action
;
168 * Cleanup the stream list of a channel. Those streams are not yet globally
171 static void clean_channel_stream_list(struct lttng_consumer_channel
*channel
)
173 struct lttng_consumer_stream
*stream
, *stmp
;
177 /* Delete streams that might have been left in the stream list. */
178 cds_list_for_each_entry_safe(stream
, stmp
, &channel
->streams
.head
,
180 cds_list_del(&stream
->send_node
);
182 * Once a stream is added to this list, the buffers were created so we
183 * have a guarantee that this call will succeed. Setting the monitor
184 * mode to 0 so we don't lock nor try to delete the stream from the
188 consumer_stream_destroy(stream
, NULL
);
193 * Find a stream. The consumer_data.lock must be locked during this
196 static struct lttng_consumer_stream
*find_stream(uint64_t key
,
199 struct lttng_ht_iter iter
;
200 struct lttng_ht_node_u64
*node
;
201 struct lttng_consumer_stream
*stream
= NULL
;
205 /* -1ULL keys are lookup failures */
206 if (key
== (uint64_t) -1ULL) {
212 lttng_ht_lookup(ht
, &key
, &iter
);
213 node
= lttng_ht_iter_get_node_u64(&iter
);
215 stream
= caa_container_of(node
, struct lttng_consumer_stream
, node
);
223 static void steal_stream_key(uint64_t key
, struct lttng_ht
*ht
)
225 struct lttng_consumer_stream
*stream
;
228 stream
= find_stream(key
, ht
);
230 stream
->key
= (uint64_t) -1ULL;
232 * We don't want the lookup to match, but we still need
233 * to iterate on this stream when iterating over the hash table. Just
234 * change the node key.
236 stream
->node
.key
= (uint64_t) -1ULL;
242 * Return a channel object for the given key.
244 * RCU read side lock MUST be acquired before calling this function and
245 * protects the channel ptr.
247 struct lttng_consumer_channel
*consumer_find_channel(uint64_t key
)
249 struct lttng_ht_iter iter
;
250 struct lttng_ht_node_u64
*node
;
251 struct lttng_consumer_channel
*channel
= NULL
;
253 /* -1ULL keys are lookup failures */
254 if (key
== (uint64_t) -1ULL) {
258 lttng_ht_lookup(consumer_data
.channel_ht
, &key
, &iter
);
259 node
= lttng_ht_iter_get_node_u64(&iter
);
261 channel
= caa_container_of(node
, struct lttng_consumer_channel
, node
);
268 * There is a possibility that the consumer does not have enough time between
269 * the close of the channel on the session daemon and the cleanup in here thus
270 * once we have a channel add with an existing key, we know for sure that this
271 * channel will eventually get cleaned up by all streams being closed.
273 * This function just nullifies the already existing channel key.
275 static void steal_channel_key(uint64_t key
)
277 struct lttng_consumer_channel
*channel
;
280 channel
= consumer_find_channel(key
);
282 channel
->key
= (uint64_t) -1ULL;
284 * We don't want the lookup to match, but we still need to iterate on
285 * this channel when iterating over the hash table. Just change the
288 channel
->node
.key
= (uint64_t) -1ULL;
293 static void free_channel_rcu(struct rcu_head
*head
)
295 struct lttng_ht_node_u64
*node
=
296 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
297 struct lttng_consumer_channel
*channel
=
298 caa_container_of(node
, struct lttng_consumer_channel
, node
);
300 switch (consumer_data
.type
) {
301 case LTTNG_CONSUMER_KERNEL
:
303 case LTTNG_CONSUMER32_UST
:
304 case LTTNG_CONSUMER64_UST
:
305 lttng_ustconsumer_free_channel(channel
);
308 ERR("Unknown consumer_data type");
315 * RCU protected relayd socket pair free.
317 static void free_relayd_rcu(struct rcu_head
*head
)
319 struct lttng_ht_node_u64
*node
=
320 caa_container_of(head
, struct lttng_ht_node_u64
, head
);
321 struct consumer_relayd_sock_pair
*relayd
=
322 caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
325 * Close all sockets. This is done in the call RCU since we don't want the
326 * socket fds to be reassigned thus potentially creating bad state of the
329 * We do not have to lock the control socket mutex here since at this stage
330 * there is no one referencing to this relayd object.
332 (void) relayd_close(&relayd
->control_sock
);
333 (void) relayd_close(&relayd
->data_sock
);
335 pthread_mutex_destroy(&relayd
->ctrl_sock_mutex
);
340 * Destroy and free relayd socket pair object.
342 void consumer_destroy_relayd(struct consumer_relayd_sock_pair
*relayd
)
345 struct lttng_ht_iter iter
;
347 if (relayd
== NULL
) {
351 DBG("Consumer destroy and close relayd socket pair");
353 iter
.iter
.node
= &relayd
->node
.node
;
354 ret
= lttng_ht_del(consumer_data
.relayd_ht
, &iter
);
356 /* We assume the relayd is being or is destroyed */
360 /* RCU free() call */
361 call_rcu(&relayd
->node
.head
, free_relayd_rcu
);
365 * Remove a channel from the global list protected by a mutex. This function is
366 * also responsible for freeing its data structures.
368 void consumer_del_channel(struct lttng_consumer_channel
*channel
)
370 struct lttng_ht_iter iter
;
372 DBG("Consumer delete channel key %" PRIu64
, channel
->key
);
374 pthread_mutex_lock(&consumer_data
.lock
);
375 pthread_mutex_lock(&channel
->lock
);
377 /* Destroy streams that might have been left in the stream list. */
378 clean_channel_stream_list(channel
);
380 if (channel
->live_timer_enabled
== 1) {
381 consumer_timer_live_stop(channel
);
383 if (channel
->monitor_timer_enabled
== 1) {
384 consumer_timer_monitor_stop(channel
);
387 switch (consumer_data
.type
) {
388 case LTTNG_CONSUMER_KERNEL
:
390 case LTTNG_CONSUMER32_UST
:
391 case LTTNG_CONSUMER64_UST
:
392 lttng_ustconsumer_del_channel(channel
);
395 ERR("Unknown consumer_data type");
400 lttng_trace_chunk_put(channel
->trace_chunk
);
401 channel
->trace_chunk
= NULL
;
403 if (channel
->is_published
) {
407 iter
.iter
.node
= &channel
->node
.node
;
408 ret
= lttng_ht_del(consumer_data
.channel_ht
, &iter
);
411 iter
.iter
.node
= &channel
->channels_by_session_id_ht_node
.node
;
412 ret
= lttng_ht_del(consumer_data
.channels_by_session_id_ht
,
418 channel
->is_deleted
= true;
419 call_rcu(&channel
->node
.head
, free_channel_rcu
);
421 pthread_mutex_unlock(&channel
->lock
);
422 pthread_mutex_unlock(&consumer_data
.lock
);
426 * Iterate over the relayd hash table and destroy each element. Finally,
427 * destroy the whole hash table.
429 static void cleanup_relayd_ht(void)
431 struct lttng_ht_iter iter
;
432 struct consumer_relayd_sock_pair
*relayd
;
436 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
438 consumer_destroy_relayd(relayd
);
443 lttng_ht_destroy(consumer_data
.relayd_ht
);
447 * Update the end point status of all streams having the given network sequence
448 * index (relayd index).
450 * It's atomically set without having the stream mutex locked which is fine
451 * because we handle the write/read race with a pipe wakeup for each thread.
453 static void update_endpoint_status_by_netidx(uint64_t net_seq_idx
,
454 enum consumer_endpoint_status status
)
456 struct lttng_ht_iter iter
;
457 struct lttng_consumer_stream
*stream
;
459 DBG("Consumer set delete flag on stream by idx %" PRIu64
, net_seq_idx
);
463 /* Let's begin with metadata */
464 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
465 if (stream
->net_seq_idx
== net_seq_idx
) {
466 uatomic_set(&stream
->endpoint_status
, status
);
467 DBG("Delete flag set to metadata stream %d", stream
->wait_fd
);
471 /* Follow up by the data streams */
472 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
473 if (stream
->net_seq_idx
== net_seq_idx
) {
474 uatomic_set(&stream
->endpoint_status
, status
);
475 DBG("Delete flag set to data stream %d", stream
->wait_fd
);
482 * Cleanup a relayd object by flagging every associated streams for deletion,
483 * destroying the object meaning removing it from the relayd hash table,
484 * closing the sockets and freeing the memory in a RCU call.
486 * If a local data context is available, notify the threads that the streams'
487 * state have changed.
489 void lttng_consumer_cleanup_relayd(struct consumer_relayd_sock_pair
*relayd
)
495 DBG("Cleaning up relayd object ID %"PRIu64
, relayd
->net_seq_idx
);
497 /* Save the net sequence index before destroying the object */
498 netidx
= relayd
->net_seq_idx
;
501 * Delete the relayd from the relayd hash table, close the sockets and free
502 * the object in a RCU call.
504 consumer_destroy_relayd(relayd
);
506 /* Set inactive endpoint to all streams */
507 update_endpoint_status_by_netidx(netidx
, CONSUMER_ENDPOINT_INACTIVE
);
510 * With a local data context, notify the threads that the streams' state
511 * have changed. The write() action on the pipe acts as an "implicit"
512 * memory barrier ordering the updates of the end point status from the
513 * read of this status which happens AFTER receiving this notify.
515 notify_thread_lttng_pipe(relayd
->ctx
->consumer_data_pipe
);
516 notify_thread_lttng_pipe(relayd
->ctx
->consumer_metadata_pipe
);
520 * Flag a relayd socket pair for destruction. Destroy it if the refcount
523 * RCU read side lock MUST be aquired before calling this function.
525 void consumer_flag_relayd_for_destroy(struct consumer_relayd_sock_pair
*relayd
)
529 /* Set destroy flag for this object */
530 uatomic_set(&relayd
->destroy_flag
, 1);
532 /* Destroy the relayd if refcount is 0 */
533 if (uatomic_read(&relayd
->refcount
) == 0) {
534 consumer_destroy_relayd(relayd
);
539 * Completly destroy stream from every visiable data structure and the given
542 * One this call returns, the stream object is not longer usable nor visible.
544 void consumer_del_stream(struct lttng_consumer_stream
*stream
,
547 consumer_stream_destroy(stream
, ht
);
551 * XXX naming of del vs destroy is all mixed up.
553 void consumer_del_stream_for_data(struct lttng_consumer_stream
*stream
)
555 consumer_stream_destroy(stream
, data_ht
);
558 void consumer_del_stream_for_metadata(struct lttng_consumer_stream
*stream
)
560 consumer_stream_destroy(stream
, metadata_ht
);
563 void consumer_stream_update_channel_attributes(
564 struct lttng_consumer_stream
*stream
,
565 struct lttng_consumer_channel
*channel
)
567 stream
->channel_read_only_attributes
.tracefile_size
=
568 channel
->tracefile_size
;
571 struct lttng_consumer_stream
*consumer_allocate_stream(uint64_t channel_key
,
573 const char *channel_name
,
576 struct lttng_trace_chunk
*trace_chunk
,
579 enum consumer_channel_type type
,
580 unsigned int monitor
)
583 struct lttng_consumer_stream
*stream
;
585 stream
= zmalloc(sizeof(*stream
));
586 if (stream
== NULL
) {
587 PERROR("malloc struct lttng_consumer_stream");
592 if (trace_chunk
&& !lttng_trace_chunk_get(trace_chunk
)) {
593 ERR("Failed to acquire trace chunk reference during the creation of a stream");
599 stream
->key
= stream_key
;
600 stream
->trace_chunk
= trace_chunk
;
602 stream
->out_fd_offset
= 0;
603 stream
->output_written
= 0;
604 stream
->net_seq_idx
= relayd_id
;
605 stream
->session_id
= session_id
;
606 stream
->monitor
= monitor
;
607 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
608 stream
->index_file
= NULL
;
609 stream
->last_sequence_number
= -1ULL;
610 stream
->rotate_position
= -1ULL;
611 pthread_mutex_init(&stream
->lock
, NULL
);
612 pthread_mutex_init(&stream
->metadata_timer_lock
, NULL
);
614 /* If channel is the metadata, flag this stream as metadata. */
615 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
616 stream
->metadata_flag
= 1;
617 /* Metadata is flat out. */
618 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
619 /* Live rendez-vous point. */
620 pthread_cond_init(&stream
->metadata_rdv
, NULL
);
621 pthread_mutex_init(&stream
->metadata_rdv_lock
, NULL
);
623 /* Format stream name to <channel_name>_<cpu_number> */
624 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
627 PERROR("snprintf stream name");
632 /* Key is always the wait_fd for streams. */
633 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
635 /* Init node per channel id key */
636 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
638 /* Init session id node with the stream session id */
639 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
641 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
642 " relayd_id %" PRIu64
", session_id %" PRIu64
,
643 stream
->name
, stream
->key
, channel_key
,
644 stream
->net_seq_idx
, stream
->session_id
);
651 lttng_trace_chunk_put(stream
->trace_chunk
);
661 * Add a stream to the global list protected by a mutex.
663 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
)
665 struct lttng_ht
*ht
= data_ht
;
670 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
672 pthread_mutex_lock(&consumer_data
.lock
);
673 pthread_mutex_lock(&stream
->chan
->lock
);
674 pthread_mutex_lock(&stream
->chan
->timer_lock
);
675 pthread_mutex_lock(&stream
->lock
);
678 /* Steal stream identifier to avoid having streams with the same key */
679 steal_stream_key(stream
->key
, ht
);
681 lttng_ht_add_unique_u64(ht
, &stream
->node
);
683 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
684 &stream
->node_channel_id
);
687 * Add stream to the stream_list_ht of the consumer data. No need to steal
688 * the key since the HT does not use it and we allow to add redundant keys
691 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
694 * When nb_init_stream_left reaches 0, we don't need to trigger any action
695 * in terms of destroying the associated channel, because the action that
696 * causes the count to become 0 also causes a stream to be added. The
697 * channel deletion will thus be triggered by the following removal of this
700 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
701 /* Increment refcount before decrementing nb_init_stream_left */
703 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
706 /* Update consumer data once the node is inserted. */
707 consumer_data
.stream_count
++;
708 consumer_data
.need_update
= 1;
711 pthread_mutex_unlock(&stream
->lock
);
712 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
713 pthread_mutex_unlock(&stream
->chan
->lock
);
714 pthread_mutex_unlock(&consumer_data
.lock
);
718 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
719 * be acquired before calling this.
721 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
724 struct lttng_ht_node_u64
*node
;
725 struct lttng_ht_iter iter
;
729 lttng_ht_lookup(consumer_data
.relayd_ht
,
730 &relayd
->net_seq_idx
, &iter
);
731 node
= lttng_ht_iter_get_node_u64(&iter
);
735 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
742 * Allocate and return a consumer relayd socket.
744 static struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
745 uint64_t net_seq_idx
)
747 struct consumer_relayd_sock_pair
*obj
= NULL
;
749 /* net sequence index of -1 is a failure */
750 if (net_seq_idx
== (uint64_t) -1ULL) {
754 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
756 PERROR("zmalloc relayd sock");
760 obj
->net_seq_idx
= net_seq_idx
;
762 obj
->destroy_flag
= 0;
763 obj
->control_sock
.sock
.fd
= -1;
764 obj
->data_sock
.sock
.fd
= -1;
765 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
766 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
773 * Find a relayd socket pair in the global consumer data.
775 * Return the object if found else NULL.
776 * RCU read-side lock must be held across this call and while using the
779 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
781 struct lttng_ht_iter iter
;
782 struct lttng_ht_node_u64
*node
;
783 struct consumer_relayd_sock_pair
*relayd
= NULL
;
785 /* Negative keys are lookup failures */
786 if (key
== (uint64_t) -1ULL) {
790 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
792 node
= lttng_ht_iter_get_node_u64(&iter
);
794 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
802 * Find a relayd and send the stream
804 * Returns 0 on success, < 0 on error
806 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
,
810 struct consumer_relayd_sock_pair
*relayd
;
813 assert(stream
->net_seq_idx
!= -1ULL);
816 /* The stream is not metadata. Get relayd reference if exists. */
818 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
819 if (relayd
!= NULL
) {
820 /* Add stream on the relayd */
821 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
822 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
823 get_consumer_domain(), path
, &stream
->relayd_stream_id
,
824 stream
->chan
->tracefile_size
,
825 stream
->chan
->tracefile_count
,
826 stream
->trace_chunk
);
827 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
829 ERR("Relayd add stream failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
830 lttng_consumer_cleanup_relayd(relayd
);
834 uatomic_inc(&relayd
->refcount
);
835 stream
->sent_to_relayd
= 1;
837 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't send it.",
838 stream
->key
, stream
->net_seq_idx
);
843 DBG("Stream %s with key %" PRIu64
" sent to relayd id %" PRIu64
,
844 stream
->name
, stream
->key
, stream
->net_seq_idx
);
852 * Find a relayd and send the streams sent message
854 * Returns 0 on success, < 0 on error
856 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
)
859 struct consumer_relayd_sock_pair
*relayd
;
861 assert(net_seq_idx
!= -1ULL);
863 /* The stream is not metadata. Get relayd reference if exists. */
865 relayd
= consumer_find_relayd(net_seq_idx
);
866 if (relayd
!= NULL
) {
867 /* Add stream on the relayd */
868 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
869 ret
= relayd_streams_sent(&relayd
->control_sock
);
870 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
872 ERR("Relayd streams sent failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
873 lttng_consumer_cleanup_relayd(relayd
);
877 ERR("Relayd ID %" PRIu64
" unknown. Can't send streams_sent.",
884 DBG("All streams sent relayd id %" PRIu64
, net_seq_idx
);
892 * Find a relayd and close the stream
894 void close_relayd_stream(struct lttng_consumer_stream
*stream
)
896 struct consumer_relayd_sock_pair
*relayd
;
898 /* The stream is not metadata. Get relayd reference if exists. */
900 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
902 consumer_stream_relayd_close(stream
, relayd
);
908 * Handle stream for relayd transmission if the stream applies for network
909 * streaming where the net sequence index is set.
911 * Return destination file descriptor or negative value on error.
913 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
914 size_t data_size
, unsigned long padding
,
915 struct consumer_relayd_sock_pair
*relayd
)
918 struct lttcomm_relayd_data_hdr data_hdr
;
924 /* Reset data header */
925 memset(&data_hdr
, 0, sizeof(data_hdr
));
927 if (stream
->metadata_flag
) {
928 /* Caller MUST acquire the relayd control socket lock */
929 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
934 /* Metadata are always sent on the control socket. */
935 outfd
= relayd
->control_sock
.sock
.fd
;
937 /* Set header with stream information */
938 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
939 data_hdr
.data_size
= htobe32(data_size
);
940 data_hdr
.padding_size
= htobe32(padding
);
943 * Note that net_seq_num below is assigned with the *current* value of
944 * next_net_seq_num and only after that the next_net_seq_num will be
945 * increment. This is why when issuing a command on the relayd using
946 * this next value, 1 should always be substracted in order to compare
947 * the last seen sequence number on the relayd side to the last sent.
949 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
950 /* Other fields are zeroed previously */
952 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
958 ++stream
->next_net_seq_num
;
960 /* Set to go on data socket */
961 outfd
= relayd
->data_sock
.sock
.fd
;
969 * Trigger a dump of the metadata content. Following/during the succesful
970 * completion of this call, the metadata poll thread will start receiving
971 * metadata packets to consume.
973 * The caller must hold the channel and stream locks.
976 int consumer_metadata_stream_dump(struct lttng_consumer_stream
*stream
)
980 ASSERT_LOCKED(stream
->chan
->lock
);
981 ASSERT_LOCKED(stream
->lock
);
982 assert(stream
->metadata_flag
);
983 assert(stream
->chan
->trace_chunk
);
985 switch (consumer_data
.type
) {
986 case LTTNG_CONSUMER_KERNEL
:
988 * Reset the position of what has been read from the
989 * metadata cache to 0 so we can dump it again.
991 ret
= kernctl_metadata_cache_dump(stream
->wait_fd
);
993 case LTTNG_CONSUMER32_UST
:
994 case LTTNG_CONSUMER64_UST
:
996 * Reset the position pushed from the metadata cache so it
997 * will write from the beginning on the next push.
999 stream
->ust_metadata_pushed
= 0;
1000 ret
= consumer_metadata_wakeup_pipe(stream
->chan
);
1003 ERR("Unknown consumer_data type");
1007 ERR("Failed to dump the metadata cache");
1013 int lttng_consumer_channel_set_trace_chunk(
1014 struct lttng_consumer_channel
*channel
,
1015 struct lttng_trace_chunk
*new_trace_chunk
)
1017 pthread_mutex_lock(&channel
->lock
);
1018 if (channel
->is_deleted
) {
1020 * The channel has been logically deleted and should no longer
1021 * be used. It has released its reference to its current trace
1022 * chunk and should not acquire a new one.
1024 * Return success as there is nothing for the caller to do.
1030 * The acquisition of the reference cannot fail (barring
1031 * a severe internal error) since a reference to the published
1032 * chunk is already held by the caller.
1034 if (new_trace_chunk
) {
1035 const bool acquired_reference
= lttng_trace_chunk_get(
1038 assert(acquired_reference
);
1041 lttng_trace_chunk_put(channel
->trace_chunk
);
1042 channel
->trace_chunk
= new_trace_chunk
;
1044 pthread_mutex_unlock(&channel
->lock
);
1049 * Allocate and return a new lttng_consumer_channel object using the given key
1050 * to initialize the hash table node.
1052 * On error, return NULL.
1054 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
1055 uint64_t session_id
,
1056 const uint64_t *chunk_id
,
1057 const char *pathname
,
1060 enum lttng_event_output output
,
1061 uint64_t tracefile_size
,
1062 uint64_t tracefile_count
,
1063 uint64_t session_id_per_pid
,
1064 unsigned int monitor
,
1065 unsigned int live_timer_interval
,
1066 const char *root_shm_path
,
1067 const char *shm_path
)
1069 struct lttng_consumer_channel
*channel
= NULL
;
1070 struct lttng_trace_chunk
*trace_chunk
= NULL
;
1073 trace_chunk
= lttng_trace_chunk_registry_find_chunk(
1074 consumer_data
.chunk_registry
, session_id
,
1077 ERR("Failed to find trace chunk reference during creation of channel");
1082 channel
= zmalloc(sizeof(*channel
));
1083 if (channel
== NULL
) {
1084 PERROR("malloc struct lttng_consumer_channel");
1089 channel
->refcount
= 0;
1090 channel
->session_id
= session_id
;
1091 channel
->session_id_per_pid
= session_id_per_pid
;
1092 channel
->relayd_id
= relayd_id
;
1093 channel
->tracefile_size
= tracefile_size
;
1094 channel
->tracefile_count
= tracefile_count
;
1095 channel
->monitor
= monitor
;
1096 channel
->live_timer_interval
= live_timer_interval
;
1097 pthread_mutex_init(&channel
->lock
, NULL
);
1098 pthread_mutex_init(&channel
->timer_lock
, NULL
);
1101 case LTTNG_EVENT_SPLICE
:
1102 channel
->output
= CONSUMER_CHANNEL_SPLICE
;
1104 case LTTNG_EVENT_MMAP
:
1105 channel
->output
= CONSUMER_CHANNEL_MMAP
;
1115 * In monitor mode, the streams associated with the channel will be put in
1116 * a special list ONLY owned by this channel. So, the refcount is set to 1
1117 * here meaning that the channel itself has streams that are referenced.
1119 * On a channel deletion, once the channel is no longer visible, the
1120 * refcount is decremented and checked for a zero value to delete it. With
1121 * streams in no monitor mode, it will now be safe to destroy the channel.
1123 if (!channel
->monitor
) {
1124 channel
->refcount
= 1;
1127 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
1128 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
1130 strncpy(channel
->name
, name
, sizeof(channel
->name
));
1131 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
1133 if (root_shm_path
) {
1134 strncpy(channel
->root_shm_path
, root_shm_path
, sizeof(channel
->root_shm_path
));
1135 channel
->root_shm_path
[sizeof(channel
->root_shm_path
) - 1] = '\0';
1138 strncpy(channel
->shm_path
, shm_path
, sizeof(channel
->shm_path
));
1139 channel
->shm_path
[sizeof(channel
->shm_path
) - 1] = '\0';
1142 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
1143 lttng_ht_node_init_u64(&channel
->channels_by_session_id_ht_node
,
1144 channel
->session_id
);
1146 channel
->wait_fd
= -1;
1147 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
1150 int ret
= lttng_consumer_channel_set_trace_chunk(channel
,
1157 DBG("Allocated channel (key %" PRIu64
")", channel
->key
);
1160 lttng_trace_chunk_put(trace_chunk
);
1163 consumer_del_channel(channel
);
1169 * Add a channel to the global list protected by a mutex.
1171 * Always return 0 indicating success.
1173 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
1174 struct lttng_consumer_local_data
*ctx
)
1176 pthread_mutex_lock(&consumer_data
.lock
);
1177 pthread_mutex_lock(&channel
->lock
);
1178 pthread_mutex_lock(&channel
->timer_lock
);
1181 * This gives us a guarantee that the channel we are about to add to the
1182 * channel hash table will be unique. See this function comment on the why
1183 * we need to steel the channel key at this stage.
1185 steal_channel_key(channel
->key
);
1188 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
1189 lttng_ht_add_u64(consumer_data
.channels_by_session_id_ht
,
1190 &channel
->channels_by_session_id_ht_node
);
1192 channel
->is_published
= true;
1194 pthread_mutex_unlock(&channel
->timer_lock
);
1195 pthread_mutex_unlock(&channel
->lock
);
1196 pthread_mutex_unlock(&consumer_data
.lock
);
1198 if (channel
->wait_fd
!= -1 && channel
->type
== CONSUMER_CHANNEL_TYPE_DATA
) {
1199 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
1206 * Allocate the pollfd structure and the local view of the out fds to avoid
1207 * doing a lookup in the linked list and concurrency issues when writing is
1208 * needed. Called with consumer_data.lock held.
1210 * Returns the number of fds in the structures.
1212 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
1213 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
1214 struct lttng_ht
*ht
, int *nb_inactive_fd
)
1217 struct lttng_ht_iter iter
;
1218 struct lttng_consumer_stream
*stream
;
1223 assert(local_stream
);
1225 DBG("Updating poll fd array");
1226 *nb_inactive_fd
= 0;
1228 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1230 * Only active streams with an active end point can be added to the
1231 * poll set and local stream storage of the thread.
1233 * There is a potential race here for endpoint_status to be updated
1234 * just after the check. However, this is OK since the stream(s) will
1235 * be deleted once the thread is notified that the end point state has
1236 * changed where this function will be called back again.
1238 * We track the number of inactive FDs because they still need to be
1239 * closed by the polling thread after a wakeup on the data_pipe or
1242 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
1243 (*nb_inactive_fd
)++;
1247 * This clobbers way too much the debug output. Uncomment that if you
1248 * need it for debugging purposes.
1250 (*pollfd
)[i
].fd
= stream
->wait_fd
;
1251 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1252 local_stream
[i
] = stream
;
1258 * Insert the consumer_data_pipe at the end of the array and don't
1259 * increment i so nb_fd is the number of real FD.
1261 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
1262 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1264 (*pollfd
)[i
+ 1].fd
= lttng_pipe_get_readfd(ctx
->consumer_wakeup_pipe
);
1265 (*pollfd
)[i
+ 1].events
= POLLIN
| POLLPRI
;
1270 * Poll on the should_quit pipe and the command socket return -1 on
1271 * error, 1 if should exit, 0 if data is available on the command socket
1273 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
1278 num_rdy
= poll(consumer_sockpoll
, 2, -1);
1279 if (num_rdy
== -1) {
1281 * Restart interrupted system call.
1283 if (errno
== EINTR
) {
1286 PERROR("Poll error");
1289 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
1290 DBG("consumer_should_quit wake up");
1297 * Set the error socket.
1299 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1302 ctx
->consumer_error_socket
= sock
;
1306 * Set the command socket path.
1308 void lttng_consumer_set_command_sock_path(
1309 struct lttng_consumer_local_data
*ctx
, char *sock
)
1311 ctx
->consumer_command_sock_path
= sock
;
1315 * Send return code to the session daemon.
1316 * If the socket is not defined, we return 0, it is not a fatal error
1318 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1320 if (ctx
->consumer_error_socket
> 0) {
1321 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1322 sizeof(enum lttcomm_sessiond_command
));
1329 * Close all the tracefiles and stream fds and MUST be called when all
1330 * instances are destroyed i.e. when all threads were joined and are ended.
1332 void lttng_consumer_cleanup(void)
1334 struct lttng_ht_iter iter
;
1335 struct lttng_consumer_channel
*channel
;
1336 unsigned int trace_chunks_left
;
1340 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1342 consumer_del_channel(channel
);
1347 lttng_ht_destroy(consumer_data
.channel_ht
);
1348 lttng_ht_destroy(consumer_data
.channels_by_session_id_ht
);
1350 cleanup_relayd_ht();
1352 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1355 * This HT contains streams that are freed by either the metadata thread or
1356 * the data thread so we do *nothing* on the hash table and simply destroy
1359 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1362 * Trace chunks in the registry may still exist if the session
1363 * daemon has encountered an internal error and could not
1364 * tear down its sessions and/or trace chunks properly.
1366 * Release the session daemon's implicit reference to any remaining
1367 * trace chunk and print an error if any trace chunk was found. Note
1368 * that there are _no_ legitimate cases for trace chunks to be left,
1369 * it is a leak. However, it can happen following a crash of the
1370 * session daemon and not emptying the registry would cause an assertion
1373 trace_chunks_left
= lttng_trace_chunk_registry_put_each_chunk(
1374 consumer_data
.chunk_registry
);
1375 if (trace_chunks_left
) {
1376 ERR("%u trace chunks are leaked by lttng-consumerd. "
1377 "This can be caused by an internal error of the session daemon.",
1380 /* Run all callbacks freeing each chunk. */
1382 lttng_trace_chunk_registry_destroy(consumer_data
.chunk_registry
);
1386 * Called from signal handler.
1388 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1392 CMM_STORE_SHARED(consumer_quit
, 1);
1393 ret
= lttng_write(ctx
->consumer_should_quit
[1], "4", 1);
1395 PERROR("write consumer quit");
1398 DBG("Consumer flag that it should quit");
1403 * Flush pending writes to trace output disk file.
1406 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1410 int outfd
= stream
->out_fd
;
1413 * This does a blocking write-and-wait on any page that belongs to the
1414 * subbuffer prior to the one we just wrote.
1415 * Don't care about error values, as these are just hints and ways to
1416 * limit the amount of page cache used.
1418 if (orig_offset
< stream
->max_sb_size
) {
1421 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1422 stream
->max_sb_size
,
1423 SYNC_FILE_RANGE_WAIT_BEFORE
1424 | SYNC_FILE_RANGE_WRITE
1425 | SYNC_FILE_RANGE_WAIT_AFTER
);
1427 * Give hints to the kernel about how we access the file:
1428 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1431 * We need to call fadvise again after the file grows because the
1432 * kernel does not seem to apply fadvise to non-existing parts of the
1435 * Call fadvise _after_ having waited for the page writeback to
1436 * complete because the dirty page writeback semantic is not well
1437 * defined. So it can be expected to lead to lower throughput in
1440 ret
= posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1441 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1442 if (ret
&& ret
!= -ENOSYS
) {
1444 PERROR("posix_fadvise on fd %i", outfd
);
1449 * Initialise the necessary environnement :
1450 * - create a new context
1451 * - create the poll_pipe
1452 * - create the should_quit pipe (for signal handler)
1453 * - create the thread pipe (for splice)
1455 * Takes a function pointer as argument, this function is called when data is
1456 * available on a buffer. This function is responsible to do the
1457 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1458 * buffer configuration and then kernctl_put_next_subbuf at the end.
1460 * Returns a pointer to the new context or NULL on error.
1462 struct lttng_consumer_local_data
*lttng_consumer_create(
1463 enum lttng_consumer_type type
,
1464 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1465 struct lttng_consumer_local_data
*ctx
),
1466 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1467 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1468 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1471 struct lttng_consumer_local_data
*ctx
;
1473 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1474 consumer_data
.type
== type
);
1475 consumer_data
.type
= type
;
1477 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1479 PERROR("allocating context");
1483 ctx
->consumer_error_socket
= -1;
1484 ctx
->consumer_metadata_socket
= -1;
1485 pthread_mutex_init(&ctx
->metadata_socket_lock
, NULL
);
1486 /* assign the callbacks */
1487 ctx
->on_buffer_ready
= buffer_ready
;
1488 ctx
->on_recv_channel
= recv_channel
;
1489 ctx
->on_recv_stream
= recv_stream
;
1490 ctx
->on_update_stream
= update_stream
;
1492 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1493 if (!ctx
->consumer_data_pipe
) {
1494 goto error_poll_pipe
;
1497 ctx
->consumer_wakeup_pipe
= lttng_pipe_open(0);
1498 if (!ctx
->consumer_wakeup_pipe
) {
1499 goto error_wakeup_pipe
;
1502 ret
= pipe(ctx
->consumer_should_quit
);
1504 PERROR("Error creating recv pipe");
1505 goto error_quit_pipe
;
1508 ret
= pipe(ctx
->consumer_channel_pipe
);
1510 PERROR("Error creating channel pipe");
1511 goto error_channel_pipe
;
1514 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1515 if (!ctx
->consumer_metadata_pipe
) {
1516 goto error_metadata_pipe
;
1519 ctx
->channel_monitor_pipe
= -1;
1523 error_metadata_pipe
:
1524 utils_close_pipe(ctx
->consumer_channel_pipe
);
1526 utils_close_pipe(ctx
->consumer_should_quit
);
1528 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1530 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1538 * Iterate over all streams of the hashtable and free them properly.
1540 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1542 struct lttng_ht_iter iter
;
1543 struct lttng_consumer_stream
*stream
;
1550 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1552 * Ignore return value since we are currently cleaning up so any error
1555 (void) consumer_del_stream(stream
, ht
);
1559 lttng_ht_destroy(ht
);
1563 * Iterate over all streams of the metadata hashtable and free them
1566 static void destroy_metadata_stream_ht(struct lttng_ht
*ht
)
1568 struct lttng_ht_iter iter
;
1569 struct lttng_consumer_stream
*stream
;
1576 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1578 * Ignore return value since we are currently cleaning up so any error
1581 (void) consumer_del_metadata_stream(stream
, ht
);
1585 lttng_ht_destroy(ht
);
1589 * Close all fds associated with the instance and free the context.
1591 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1595 DBG("Consumer destroying it. Closing everything.");
1601 destroy_data_stream_ht(data_ht
);
1602 destroy_metadata_stream_ht(metadata_ht
);
1604 ret
= close(ctx
->consumer_error_socket
);
1608 ret
= close(ctx
->consumer_metadata_socket
);
1612 utils_close_pipe(ctx
->consumer_channel_pipe
);
1613 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1614 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1615 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1616 utils_close_pipe(ctx
->consumer_should_quit
);
1618 unlink(ctx
->consumer_command_sock_path
);
1623 * Write the metadata stream id on the specified file descriptor.
1625 static int write_relayd_metadata_id(int fd
,
1626 struct lttng_consumer_stream
*stream
,
1627 unsigned long padding
)
1630 struct lttcomm_relayd_metadata_payload hdr
;
1632 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1633 hdr
.padding_size
= htobe32(padding
);
1634 ret
= lttng_write(fd
, (void *) &hdr
, sizeof(hdr
));
1635 if (ret
< sizeof(hdr
)) {
1637 * This error means that the fd's end is closed so ignore the PERROR
1638 * not to clubber the error output since this can happen in a normal
1641 if (errno
!= EPIPE
) {
1642 PERROR("write metadata stream id");
1644 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1646 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1647 * handle writting the missing part so report that as an error and
1648 * don't lie to the caller.
1653 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1654 stream
->relayd_stream_id
, padding
);
1661 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1662 * core function for writing trace buffers to either the local filesystem or
1665 * It must be called with the stream and the channel lock held.
1667 * Careful review MUST be put if any changes occur!
1669 * Returns the number of bytes written
1671 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1672 struct lttng_consumer_local_data
*ctx
,
1673 struct lttng_consumer_stream
*stream
,
1674 const struct lttng_buffer_view
*buffer
,
1675 unsigned long padding
,
1676 struct ctf_packet_index
*index
)
1679 off_t orig_offset
= stream
->out_fd_offset
;
1680 /* Default is on the disk */
1681 int outfd
= stream
->out_fd
;
1682 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1683 unsigned int relayd_hang_up
= 0;
1684 const size_t subbuf_content_size
= buffer
->size
- padding
;
1687 /* RCU lock for the relayd pointer */
1689 assert(stream
->net_seq_idx
!= (uint64_t) -1ULL ||
1690 stream
->trace_chunk
);
1692 /* Flag that the current stream if set for network streaming. */
1693 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1694 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1695 if (relayd
== NULL
) {
1701 /* Handle stream on the relayd if the output is on the network */
1703 unsigned long netlen
= subbuf_content_size
;
1706 * Lock the control socket for the complete duration of the function
1707 * since from this point on we will use the socket.
1709 if (stream
->metadata_flag
) {
1710 /* Metadata requires the control socket. */
1711 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1712 if (stream
->reset_metadata_flag
) {
1713 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1714 stream
->relayd_stream_id
,
1715 stream
->metadata_version
);
1720 stream
->reset_metadata_flag
= 0;
1722 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1725 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1730 /* Use the returned socket. */
1733 /* Write metadata stream id before payload */
1734 if (stream
->metadata_flag
) {
1735 ret
= write_relayd_metadata_id(outfd
, stream
, padding
);
1742 write_len
= subbuf_content_size
;
1744 /* No streaming; we have to write the full padding. */
1745 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1746 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1748 ERR("Reset metadata file");
1751 stream
->reset_metadata_flag
= 0;
1755 * Check if we need to change the tracefile before writing the packet.
1757 if (stream
->chan
->tracefile_size
> 0 &&
1758 (stream
->tracefile_size_current
+ buffer
->size
) >
1759 stream
->chan
->tracefile_size
) {
1760 ret
= consumer_stream_rotate_output_files(stream
);
1764 outfd
= stream
->out_fd
;
1767 stream
->tracefile_size_current
+= buffer
->size
;
1769 index
->offset
= htobe64(stream
->out_fd_offset
);
1772 write_len
= buffer
->size
;
1776 * This call guarantee that len or less is returned. It's impossible to
1777 * receive a ret value that is bigger than len.
1779 ret
= lttng_write(outfd
, buffer
->data
, write_len
);
1780 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, write_len
);
1781 if (ret
< 0 || ((size_t) ret
!= write_len
)) {
1783 * Report error to caller if nothing was written else at least send the
1791 /* Socket operation failed. We consider the relayd dead */
1792 if (errno
== EPIPE
) {
1794 * This is possible if the fd is closed on the other side
1795 * (outfd) or any write problem. It can be verbose a bit for a
1796 * normal execution if for instance the relayd is stopped
1797 * abruptly. This can happen so set this to a DBG statement.
1799 DBG("Consumer mmap write detected relayd hang up");
1801 /* Unhandled error, print it and stop function right now. */
1802 PERROR("Error in write mmap (ret %zd != write_len %zu)", ret
,
1807 stream
->output_written
+= ret
;
1809 /* This call is useless on a socket so better save a syscall. */
1811 /* This won't block, but will start writeout asynchronously */
1812 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, write_len
,
1813 SYNC_FILE_RANGE_WRITE
);
1814 stream
->out_fd_offset
+= write_len
;
1815 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1820 * This is a special case that the relayd has closed its socket. Let's
1821 * cleanup the relayd object and all associated streams.
1823 if (relayd
&& relayd_hang_up
) {
1824 ERR("Relayd hangup. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
1825 lttng_consumer_cleanup_relayd(relayd
);
1829 /* Unlock only if ctrl socket used */
1830 if (relayd
&& stream
->metadata_flag
) {
1831 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1839 * Splice the data from the ring buffer to the tracefile.
1841 * It must be called with the stream lock held.
1843 * Returns the number of bytes spliced.
1845 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1846 struct lttng_consumer_local_data
*ctx
,
1847 struct lttng_consumer_stream
*stream
, unsigned long len
,
1848 unsigned long padding
,
1849 struct ctf_packet_index
*index
)
1851 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1853 off_t orig_offset
= stream
->out_fd_offset
;
1854 int fd
= stream
->wait_fd
;
1855 /* Default is on the disk */
1856 int outfd
= stream
->out_fd
;
1857 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1859 unsigned int relayd_hang_up
= 0;
1861 switch (consumer_data
.type
) {
1862 case LTTNG_CONSUMER_KERNEL
:
1864 case LTTNG_CONSUMER32_UST
:
1865 case LTTNG_CONSUMER64_UST
:
1866 /* Not supported for user space tracing */
1869 ERR("Unknown consumer_data type");
1873 /* RCU lock for the relayd pointer */
1876 /* Flag that the current stream if set for network streaming. */
1877 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1878 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1879 if (relayd
== NULL
) {
1884 splice_pipe
= stream
->splice_pipe
;
1886 /* Write metadata stream id before payload */
1888 unsigned long total_len
= len
;
1890 if (stream
->metadata_flag
) {
1892 * Lock the control socket for the complete duration of the function
1893 * since from this point on we will use the socket.
1895 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1897 if (stream
->reset_metadata_flag
) {
1898 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1899 stream
->relayd_stream_id
,
1900 stream
->metadata_version
);
1905 stream
->reset_metadata_flag
= 0;
1907 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
,
1915 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1918 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1924 /* Use the returned socket. */
1927 /* No streaming, we have to set the len with the full padding */
1930 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1931 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1933 ERR("Reset metadata file");
1936 stream
->reset_metadata_flag
= 0;
1939 * Check if we need to change the tracefile before writing the packet.
1941 if (stream
->chan
->tracefile_size
> 0 &&
1942 (stream
->tracefile_size_current
+ len
) >
1943 stream
->chan
->tracefile_size
) {
1944 ret
= consumer_stream_rotate_output_files(stream
);
1949 outfd
= stream
->out_fd
;
1952 stream
->tracefile_size_current
+= len
;
1953 index
->offset
= htobe64(stream
->out_fd_offset
);
1957 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1958 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1959 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1960 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1961 DBG("splice chan to pipe, ret %zd", ret_splice
);
1962 if (ret_splice
< 0) {
1965 PERROR("Error in relay splice");
1969 /* Handle stream on the relayd if the output is on the network */
1970 if (relayd
&& stream
->metadata_flag
) {
1971 size_t metadata_payload_size
=
1972 sizeof(struct lttcomm_relayd_metadata_payload
);
1974 /* Update counter to fit the spliced data */
1975 ret_splice
+= metadata_payload_size
;
1976 len
+= metadata_payload_size
;
1978 * We do this so the return value can match the len passed as
1979 * argument to this function.
1981 written
-= metadata_payload_size
;
1984 /* Splice data out */
1985 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1986 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1987 DBG("Consumer splice pipe to file (out_fd: %d), ret %zd",
1989 if (ret_splice
< 0) {
1994 } else if (ret_splice
> len
) {
1996 * We don't expect this code path to be executed but you never know
1997 * so this is an extra protection agains a buggy splice().
2000 written
+= ret_splice
;
2001 PERROR("Wrote more data than requested %zd (len: %lu)", ret_splice
,
2005 /* All good, update current len and continue. */
2009 /* This call is useless on a socket so better save a syscall. */
2011 /* This won't block, but will start writeout asynchronously */
2012 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
2013 SYNC_FILE_RANGE_WRITE
);
2014 stream
->out_fd_offset
+= ret_splice
;
2016 stream
->output_written
+= ret_splice
;
2017 written
+= ret_splice
;
2020 lttng_consumer_sync_trace_file(stream
, orig_offset
);
2026 * This is a special case that the relayd has closed its socket. Let's
2027 * cleanup the relayd object and all associated streams.
2029 if (relayd
&& relayd_hang_up
) {
2030 ERR("Relayd hangup. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
2031 lttng_consumer_cleanup_relayd(relayd
);
2032 /* Skip splice error so the consumer does not fail */
2037 /* send the appropriate error description to sessiond */
2040 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
2043 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
2046 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
2051 if (relayd
&& stream
->metadata_flag
) {
2052 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
2060 * Sample the snapshot positions for a specific fd
2062 * Returns 0 on success, < 0 on error
2064 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
)
2066 switch (consumer_data
.type
) {
2067 case LTTNG_CONSUMER_KERNEL
:
2068 return lttng_kconsumer_sample_snapshot_positions(stream
);
2069 case LTTNG_CONSUMER32_UST
:
2070 case LTTNG_CONSUMER64_UST
:
2071 return lttng_ustconsumer_sample_snapshot_positions(stream
);
2073 ERR("Unknown consumer_data type");
2079 * Take a snapshot for a specific fd
2081 * Returns 0 on success, < 0 on error
2083 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2085 switch (consumer_data
.type
) {
2086 case LTTNG_CONSUMER_KERNEL
:
2087 return lttng_kconsumer_take_snapshot(stream
);
2088 case LTTNG_CONSUMER32_UST
:
2089 case LTTNG_CONSUMER64_UST
:
2090 return lttng_ustconsumer_take_snapshot(stream
);
2092 ERR("Unknown consumer_data type");
2099 * Get the produced position
2101 * Returns 0 on success, < 0 on error
2103 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
2106 switch (consumer_data
.type
) {
2107 case LTTNG_CONSUMER_KERNEL
:
2108 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
2109 case LTTNG_CONSUMER32_UST
:
2110 case LTTNG_CONSUMER64_UST
:
2111 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
2113 ERR("Unknown consumer_data type");
2120 * Get the consumed position (free-running counter position in bytes).
2122 * Returns 0 on success, < 0 on error
2124 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
2127 switch (consumer_data
.type
) {
2128 case LTTNG_CONSUMER_KERNEL
:
2129 return lttng_kconsumer_get_consumed_snapshot(stream
, pos
);
2130 case LTTNG_CONSUMER32_UST
:
2131 case LTTNG_CONSUMER64_UST
:
2132 return lttng_ustconsumer_get_consumed_snapshot(stream
, pos
);
2134 ERR("Unknown consumer_data type");
2140 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
2141 int sock
, struct pollfd
*consumer_sockpoll
)
2143 switch (consumer_data
.type
) {
2144 case LTTNG_CONSUMER_KERNEL
:
2145 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2146 case LTTNG_CONSUMER32_UST
:
2147 case LTTNG_CONSUMER64_UST
:
2148 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2150 ERR("Unknown consumer_data type");
2157 void lttng_consumer_close_all_metadata(void)
2159 switch (consumer_data
.type
) {
2160 case LTTNG_CONSUMER_KERNEL
:
2162 * The Kernel consumer has a different metadata scheme so we don't
2163 * close anything because the stream will be closed by the session
2167 case LTTNG_CONSUMER32_UST
:
2168 case LTTNG_CONSUMER64_UST
:
2170 * Close all metadata streams. The metadata hash table is passed and
2171 * this call iterates over it by closing all wakeup fd. This is safe
2172 * because at this point we are sure that the metadata producer is
2173 * either dead or blocked.
2175 lttng_ustconsumer_close_all_metadata(metadata_ht
);
2178 ERR("Unknown consumer_data type");
2184 * Clean up a metadata stream and free its memory.
2186 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
2187 struct lttng_ht
*ht
)
2189 struct lttng_consumer_channel
*channel
= NULL
;
2190 bool free_channel
= false;
2194 * This call should NEVER receive regular stream. It must always be
2195 * metadata stream and this is crucial for data structure synchronization.
2197 assert(stream
->metadata_flag
);
2199 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
2201 pthread_mutex_lock(&consumer_data
.lock
);
2203 * Note that this assumes that a stream's channel is never changed and
2204 * that the stream's lock doesn't need to be taken to sample its
2207 channel
= stream
->chan
;
2208 pthread_mutex_lock(&channel
->lock
);
2209 pthread_mutex_lock(&stream
->lock
);
2210 if (channel
->metadata_cache
) {
2211 /* Only applicable to userspace consumers. */
2212 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
2215 /* Remove any reference to that stream. */
2216 consumer_stream_delete(stream
, ht
);
2218 /* Close down everything including the relayd if one. */
2219 consumer_stream_close(stream
);
2220 /* Destroy tracer buffers of the stream. */
2221 consumer_stream_destroy_buffers(stream
);
2223 /* Atomically decrement channel refcount since other threads can use it. */
2224 if (!uatomic_sub_return(&channel
->refcount
, 1)
2225 && !uatomic_read(&channel
->nb_init_stream_left
)) {
2226 /* Go for channel deletion! */
2227 free_channel
= true;
2229 stream
->chan
= NULL
;
2232 * Nullify the stream reference so it is not used after deletion. The
2233 * channel lock MUST be acquired before being able to check for a NULL
2236 channel
->metadata_stream
= NULL
;
2238 if (channel
->metadata_cache
) {
2239 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
2241 pthread_mutex_unlock(&stream
->lock
);
2242 pthread_mutex_unlock(&channel
->lock
);
2243 pthread_mutex_unlock(&consumer_data
.lock
);
2246 consumer_del_channel(channel
);
2249 lttng_trace_chunk_put(stream
->trace_chunk
);
2250 stream
->trace_chunk
= NULL
;
2251 consumer_stream_free(stream
);
2255 * Action done with the metadata stream when adding it to the consumer internal
2256 * data structures to handle it.
2258 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
)
2260 struct lttng_ht
*ht
= metadata_ht
;
2261 struct lttng_ht_iter iter
;
2262 struct lttng_ht_node_u64
*node
;
2267 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
2269 pthread_mutex_lock(&consumer_data
.lock
);
2270 pthread_mutex_lock(&stream
->chan
->lock
);
2271 pthread_mutex_lock(&stream
->chan
->timer_lock
);
2272 pthread_mutex_lock(&stream
->lock
);
2275 * From here, refcounts are updated so be _careful_ when returning an error
2282 * Lookup the stream just to make sure it does not exist in our internal
2283 * state. This should NEVER happen.
2285 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
2286 node
= lttng_ht_iter_get_node_u64(&iter
);
2290 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2291 * in terms of destroying the associated channel, because the action that
2292 * causes the count to become 0 also causes a stream to be added. The
2293 * channel deletion will thus be triggered by the following removal of this
2296 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2297 /* Increment refcount before decrementing nb_init_stream_left */
2299 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2302 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2304 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
2305 &stream
->node_channel_id
);
2308 * Add stream to the stream_list_ht of the consumer data. No need to steal
2309 * the key since the HT does not use it and we allow to add redundant keys
2312 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2316 pthread_mutex_unlock(&stream
->lock
);
2317 pthread_mutex_unlock(&stream
->chan
->lock
);
2318 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
2319 pthread_mutex_unlock(&consumer_data
.lock
);
2323 * Delete data stream that are flagged for deletion (endpoint_status).
2325 static void validate_endpoint_status_data_stream(void)
2327 struct lttng_ht_iter iter
;
2328 struct lttng_consumer_stream
*stream
;
2330 DBG("Consumer delete flagged data stream");
2333 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2334 /* Validate delete flag of the stream */
2335 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2338 /* Delete it right now */
2339 consumer_del_stream(stream
, data_ht
);
2345 * Delete metadata stream that are flagged for deletion (endpoint_status).
2347 static void validate_endpoint_status_metadata_stream(
2348 struct lttng_poll_event
*pollset
)
2350 struct lttng_ht_iter iter
;
2351 struct lttng_consumer_stream
*stream
;
2353 DBG("Consumer delete flagged metadata stream");
2358 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2359 /* Validate delete flag of the stream */
2360 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2364 * Remove from pollset so the metadata thread can continue without
2365 * blocking on a deleted stream.
2367 lttng_poll_del(pollset
, stream
->wait_fd
);
2369 /* Delete it right now */
2370 consumer_del_metadata_stream(stream
, metadata_ht
);
2376 * Thread polls on metadata file descriptor and write them on disk or on the
2379 void *consumer_thread_metadata_poll(void *data
)
2381 int ret
, i
, pollfd
, err
= -1;
2382 uint32_t revents
, nb_fd
;
2383 struct lttng_consumer_stream
*stream
= NULL
;
2384 struct lttng_ht_iter iter
;
2385 struct lttng_ht_node_u64
*node
;
2386 struct lttng_poll_event events
;
2387 struct lttng_consumer_local_data
*ctx
= data
;
2390 rcu_register_thread();
2392 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_METADATA
);
2394 if (testpoint(consumerd_thread_metadata
)) {
2395 goto error_testpoint
;
2398 health_code_update();
2400 DBG("Thread metadata poll started");
2402 /* Size is set to 1 for the consumer_metadata pipe */
2403 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2405 ERR("Poll set creation failed");
2409 ret
= lttng_poll_add(&events
,
2410 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2416 DBG("Metadata main loop started");
2420 health_code_update();
2421 health_poll_entry();
2422 DBG("Metadata poll wait");
2423 ret
= lttng_poll_wait(&events
, -1);
2424 DBG("Metadata poll return from wait with %d fd(s)",
2425 LTTNG_POLL_GETNB(&events
));
2427 DBG("Metadata event caught in thread");
2429 if (errno
== EINTR
) {
2430 ERR("Poll EINTR caught");
2433 if (LTTNG_POLL_GETNB(&events
) == 0) {
2434 err
= 0; /* All is OK */
2441 /* From here, the event is a metadata wait fd */
2442 for (i
= 0; i
< nb_fd
; i
++) {
2443 health_code_update();
2445 revents
= LTTNG_POLL_GETEV(&events
, i
);
2446 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2448 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2449 if (revents
& LPOLLIN
) {
2452 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2453 &stream
, sizeof(stream
));
2454 if (pipe_len
< sizeof(stream
)) {
2456 PERROR("read metadata stream");
2459 * Remove the pipe from the poll set and continue the loop
2460 * since their might be data to consume.
2462 lttng_poll_del(&events
,
2463 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2464 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2468 /* A NULL stream means that the state has changed. */
2469 if (stream
== NULL
) {
2470 /* Check for deleted streams. */
2471 validate_endpoint_status_metadata_stream(&events
);
2475 DBG("Adding metadata stream %d to poll set",
2478 /* Add metadata stream to the global poll events list */
2479 lttng_poll_add(&events
, stream
->wait_fd
,
2480 LPOLLIN
| LPOLLPRI
| LPOLLHUP
);
2481 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2482 DBG("Metadata thread pipe hung up");
2484 * Remove the pipe from the poll set and continue the loop
2485 * since their might be data to consume.
2487 lttng_poll_del(&events
,
2488 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2489 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2492 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2496 /* Handle other stream */
2502 uint64_t tmp_id
= (uint64_t) pollfd
;
2504 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2506 node
= lttng_ht_iter_get_node_u64(&iter
);
2509 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2512 if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2513 /* Get the data out of the metadata file descriptor */
2514 DBG("Metadata available on fd %d", pollfd
);
2515 assert(stream
->wait_fd
== pollfd
);
2518 health_code_update();
2520 len
= ctx
->on_buffer_ready(stream
, ctx
);
2522 * We don't check the return value here since if we get
2523 * a negative len, it means an error occurred thus we
2524 * simply remove it from the poll set and free the
2529 /* It's ok to have an unavailable sub-buffer */
2530 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2531 /* Clean up stream from consumer and free it. */
2532 lttng_poll_del(&events
, stream
->wait_fd
);
2533 consumer_del_metadata_stream(stream
, metadata_ht
);
2535 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2536 DBG("Metadata fd %d is hup|err.", pollfd
);
2537 if (!stream
->hangup_flush_done
2538 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2539 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2540 DBG("Attempting to flush and consume the UST buffers");
2541 lttng_ustconsumer_on_stream_hangup(stream
);
2543 /* We just flushed the stream now read it. */
2545 health_code_update();
2547 len
= ctx
->on_buffer_ready(stream
, ctx
);
2549 * We don't check the return value here since if we get
2550 * a negative len, it means an error occurred thus we
2551 * simply remove it from the poll set and free the
2557 lttng_poll_del(&events
, stream
->wait_fd
);
2559 * This call update the channel states, closes file descriptors
2560 * and securely free the stream.
2562 consumer_del_metadata_stream(stream
, metadata_ht
);
2564 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2568 /* Release RCU lock for the stream looked up */
2576 DBG("Metadata poll thread exiting");
2578 lttng_poll_clean(&events
);
2583 ERR("Health error occurred in %s", __func__
);
2585 health_unregister(health_consumerd
);
2586 rcu_unregister_thread();
2591 * This thread polls the fds in the set to consume the data and write
2592 * it to tracefile if necessary.
2594 void *consumer_thread_data_poll(void *data
)
2596 int num_rdy
, num_hup
, high_prio
, ret
, i
, err
= -1;
2597 struct pollfd
*pollfd
= NULL
;
2598 /* local view of the streams */
2599 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2600 /* local view of consumer_data.fds_count */
2602 /* 2 for the consumer_data_pipe and wake up pipe */
2603 const int nb_pipes_fd
= 2;
2604 /* Number of FDs with CONSUMER_ENDPOINT_INACTIVE but still open. */
2605 int nb_inactive_fd
= 0;
2606 struct lttng_consumer_local_data
*ctx
= data
;
2609 rcu_register_thread();
2611 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_DATA
);
2613 if (testpoint(consumerd_thread_data
)) {
2614 goto error_testpoint
;
2617 health_code_update();
2619 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
*));
2620 if (local_stream
== NULL
) {
2621 PERROR("local_stream malloc");
2626 health_code_update();
2632 * the fds set has been updated, we need to update our
2633 * local array as well
2635 pthread_mutex_lock(&consumer_data
.lock
);
2636 if (consumer_data
.need_update
) {
2641 local_stream
= NULL
;
2643 /* Allocate for all fds */
2644 pollfd
= zmalloc((consumer_data
.stream_count
+ nb_pipes_fd
) * sizeof(struct pollfd
));
2645 if (pollfd
== NULL
) {
2646 PERROR("pollfd malloc");
2647 pthread_mutex_unlock(&consumer_data
.lock
);
2651 local_stream
= zmalloc((consumer_data
.stream_count
+ nb_pipes_fd
) *
2652 sizeof(struct lttng_consumer_stream
*));
2653 if (local_stream
== NULL
) {
2654 PERROR("local_stream malloc");
2655 pthread_mutex_unlock(&consumer_data
.lock
);
2658 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2659 data_ht
, &nb_inactive_fd
);
2661 ERR("Error in allocating pollfd or local_outfds");
2662 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2663 pthread_mutex_unlock(&consumer_data
.lock
);
2667 consumer_data
.need_update
= 0;
2669 pthread_mutex_unlock(&consumer_data
.lock
);
2671 /* No FDs and consumer_quit, consumer_cleanup the thread */
2672 if (nb_fd
== 0 && nb_inactive_fd
== 0 &&
2673 CMM_LOAD_SHARED(consumer_quit
) == 1) {
2674 err
= 0; /* All is OK */
2677 /* poll on the array of fds */
2679 DBG("polling on %d fd", nb_fd
+ nb_pipes_fd
);
2680 if (testpoint(consumerd_thread_data_poll
)) {
2683 health_poll_entry();
2684 num_rdy
= poll(pollfd
, nb_fd
+ nb_pipes_fd
, -1);
2686 DBG("poll num_rdy : %d", num_rdy
);
2687 if (num_rdy
== -1) {
2689 * Restart interrupted system call.
2691 if (errno
== EINTR
) {
2694 PERROR("Poll error");
2695 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2697 } else if (num_rdy
== 0) {
2698 DBG("Polling thread timed out");
2702 if (caa_unlikely(data_consumption_paused
)) {
2703 DBG("Data consumption paused, sleeping...");
2709 * If the consumer_data_pipe triggered poll go directly to the
2710 * beginning of the loop to update the array. We want to prioritize
2711 * array update over low-priority reads.
2713 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2714 ssize_t pipe_readlen
;
2716 DBG("consumer_data_pipe wake up");
2717 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2718 &new_stream
, sizeof(new_stream
));
2719 if (pipe_readlen
< sizeof(new_stream
)) {
2720 PERROR("Consumer data pipe");
2721 /* Continue so we can at least handle the current stream(s). */
2726 * If the stream is NULL, just ignore it. It's also possible that
2727 * the sessiond poll thread changed the consumer_quit state and is
2728 * waking us up to test it.
2730 if (new_stream
== NULL
) {
2731 validate_endpoint_status_data_stream();
2735 /* Continue to update the local streams and handle prio ones */
2739 /* Handle wakeup pipe. */
2740 if (pollfd
[nb_fd
+ 1].revents
& (POLLIN
| POLLPRI
)) {
2742 ssize_t pipe_readlen
;
2744 pipe_readlen
= lttng_pipe_read(ctx
->consumer_wakeup_pipe
, &dummy
,
2746 if (pipe_readlen
< 0) {
2747 PERROR("Consumer data wakeup pipe");
2749 /* We've been awakened to handle stream(s). */
2750 ctx
->has_wakeup
= 0;
2753 /* Take care of high priority channels first. */
2754 for (i
= 0; i
< nb_fd
; i
++) {
2755 health_code_update();
2757 if (local_stream
[i
] == NULL
) {
2760 if (pollfd
[i
].revents
& POLLPRI
) {
2761 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2763 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2764 /* it's ok to have an unavailable sub-buffer */
2765 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2766 /* Clean the stream and free it. */
2767 consumer_del_stream(local_stream
[i
], data_ht
);
2768 local_stream
[i
] = NULL
;
2769 } else if (len
> 0) {
2770 local_stream
[i
]->data_read
= 1;
2776 * If we read high prio channel in this loop, try again
2777 * for more high prio data.
2783 /* Take care of low priority channels. */
2784 for (i
= 0; i
< nb_fd
; i
++) {
2785 health_code_update();
2787 if (local_stream
[i
] == NULL
) {
2790 if ((pollfd
[i
].revents
& POLLIN
) ||
2791 local_stream
[i
]->hangup_flush_done
||
2792 local_stream
[i
]->has_data
) {
2793 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2794 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2795 /* it's ok to have an unavailable sub-buffer */
2796 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2797 /* Clean the stream and free it. */
2798 consumer_del_stream(local_stream
[i
], data_ht
);
2799 local_stream
[i
] = NULL
;
2800 } else if (len
> 0) {
2801 local_stream
[i
]->data_read
= 1;
2806 /* Handle hangup and errors */
2807 for (i
= 0; i
< nb_fd
; i
++) {
2808 health_code_update();
2810 if (local_stream
[i
] == NULL
) {
2813 if (!local_stream
[i
]->hangup_flush_done
2814 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2815 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2816 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2817 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2819 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2820 /* Attempt read again, for the data we just flushed. */
2821 local_stream
[i
]->data_read
= 1;
2824 * If the poll flag is HUP/ERR/NVAL and we have
2825 * read no data in this pass, we can remove the
2826 * stream from its hash table.
2828 if ((pollfd
[i
].revents
& POLLHUP
)) {
2829 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2830 if (!local_stream
[i
]->data_read
) {
2831 consumer_del_stream(local_stream
[i
], data_ht
);
2832 local_stream
[i
] = NULL
;
2835 } else if (pollfd
[i
].revents
& POLLERR
) {
2836 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2837 if (!local_stream
[i
]->data_read
) {
2838 consumer_del_stream(local_stream
[i
], data_ht
);
2839 local_stream
[i
] = NULL
;
2842 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2843 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2844 if (!local_stream
[i
]->data_read
) {
2845 consumer_del_stream(local_stream
[i
], data_ht
);
2846 local_stream
[i
] = NULL
;
2850 if (local_stream
[i
] != NULL
) {
2851 local_stream
[i
]->data_read
= 0;
2858 DBG("polling thread exiting");
2863 * Close the write side of the pipe so epoll_wait() in
2864 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2865 * read side of the pipe. If we close them both, epoll_wait strangely does
2866 * not return and could create a endless wait period if the pipe is the
2867 * only tracked fd in the poll set. The thread will take care of closing
2870 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2875 ERR("Health error occurred in %s", __func__
);
2877 health_unregister(health_consumerd
);
2879 rcu_unregister_thread();
2884 * Close wake-up end of each stream belonging to the channel. This will
2885 * allow the poll() on the stream read-side to detect when the
2886 * write-side (application) finally closes them.
2889 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2891 struct lttng_ht
*ht
;
2892 struct lttng_consumer_stream
*stream
;
2893 struct lttng_ht_iter iter
;
2895 ht
= consumer_data
.stream_per_chan_id_ht
;
2898 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2899 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2900 ht
->match_fct
, &channel
->key
,
2901 &iter
.iter
, stream
, node_channel_id
.node
) {
2903 * Protect against teardown with mutex.
2905 pthread_mutex_lock(&stream
->lock
);
2906 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2909 switch (consumer_data
.type
) {
2910 case LTTNG_CONSUMER_KERNEL
:
2912 case LTTNG_CONSUMER32_UST
:
2913 case LTTNG_CONSUMER64_UST
:
2914 if (stream
->metadata_flag
) {
2915 /* Safe and protected by the stream lock. */
2916 lttng_ustconsumer_close_metadata(stream
->chan
);
2919 * Note: a mutex is taken internally within
2920 * liblttng-ust-ctl to protect timer wakeup_fd
2921 * use from concurrent close.
2923 lttng_ustconsumer_close_stream_wakeup(stream
);
2927 ERR("Unknown consumer_data type");
2931 pthread_mutex_unlock(&stream
->lock
);
2936 static void destroy_channel_ht(struct lttng_ht
*ht
)
2938 struct lttng_ht_iter iter
;
2939 struct lttng_consumer_channel
*channel
;
2947 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2948 ret
= lttng_ht_del(ht
, &iter
);
2953 lttng_ht_destroy(ht
);
2957 * This thread polls the channel fds to detect when they are being
2958 * closed. It closes all related streams if the channel is detected as
2959 * closed. It is currently only used as a shim layer for UST because the
2960 * consumerd needs to keep the per-stream wakeup end of pipes open for
2963 void *consumer_thread_channel_poll(void *data
)
2965 int ret
, i
, pollfd
, err
= -1;
2966 uint32_t revents
, nb_fd
;
2967 struct lttng_consumer_channel
*chan
= NULL
;
2968 struct lttng_ht_iter iter
;
2969 struct lttng_ht_node_u64
*node
;
2970 struct lttng_poll_event events
;
2971 struct lttng_consumer_local_data
*ctx
= data
;
2972 struct lttng_ht
*channel_ht
;
2974 rcu_register_thread();
2976 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_CHANNEL
);
2978 if (testpoint(consumerd_thread_channel
)) {
2979 goto error_testpoint
;
2982 health_code_update();
2984 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2986 /* ENOMEM at this point. Better to bail out. */
2990 DBG("Thread channel poll started");
2992 /* Size is set to 1 for the consumer_channel pipe */
2993 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2995 ERR("Poll set creation failed");
2999 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
3005 DBG("Channel main loop started");
3009 health_code_update();
3010 DBG("Channel poll wait");
3011 health_poll_entry();
3012 ret
= lttng_poll_wait(&events
, -1);
3013 DBG("Channel poll return from wait with %d fd(s)",
3014 LTTNG_POLL_GETNB(&events
));
3016 DBG("Channel event caught in thread");
3018 if (errno
== EINTR
) {
3019 ERR("Poll EINTR caught");
3022 if (LTTNG_POLL_GETNB(&events
) == 0) {
3023 err
= 0; /* All is OK */
3030 /* From here, the event is a channel wait fd */
3031 for (i
= 0; i
< nb_fd
; i
++) {
3032 health_code_update();
3034 revents
= LTTNG_POLL_GETEV(&events
, i
);
3035 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3037 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
3038 if (revents
& LPOLLIN
) {
3039 enum consumer_channel_action action
;
3042 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
3045 ERR("Error reading channel pipe");
3047 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3052 case CONSUMER_CHANNEL_ADD
:
3053 DBG("Adding channel %d to poll set",
3056 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
3059 lttng_ht_add_unique_u64(channel_ht
,
3060 &chan
->wait_fd_node
);
3062 /* Add channel to the global poll events list */
3063 lttng_poll_add(&events
, chan
->wait_fd
,
3064 LPOLLERR
| LPOLLHUP
);
3066 case CONSUMER_CHANNEL_DEL
:
3069 * This command should never be called if the channel
3070 * has streams monitored by either the data or metadata
3071 * thread. The consumer only notify this thread with a
3072 * channel del. command if it receives a destroy
3073 * channel command from the session daemon that send it
3074 * if a command prior to the GET_CHANNEL failed.
3078 chan
= consumer_find_channel(key
);
3081 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
3084 lttng_poll_del(&events
, chan
->wait_fd
);
3085 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
3086 ret
= lttng_ht_del(channel_ht
, &iter
);
3089 switch (consumer_data
.type
) {
3090 case LTTNG_CONSUMER_KERNEL
:
3092 case LTTNG_CONSUMER32_UST
:
3093 case LTTNG_CONSUMER64_UST
:
3094 health_code_update();
3095 /* Destroy streams that might have been left in the stream list. */
3096 clean_channel_stream_list(chan
);
3099 ERR("Unknown consumer_data type");
3104 * Release our own refcount. Force channel deletion even if
3105 * streams were not initialized.
3107 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
3108 consumer_del_channel(chan
);
3113 case CONSUMER_CHANNEL_QUIT
:
3115 * Remove the pipe from the poll set and continue the loop
3116 * since their might be data to consume.
3118 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3121 ERR("Unknown action");
3124 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
3125 DBG("Channel thread pipe hung up");
3127 * Remove the pipe from the poll set and continue the loop
3128 * since their might be data to consume.
3130 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3133 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3137 /* Handle other stream */
3143 uint64_t tmp_id
= (uint64_t) pollfd
;
3145 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
3147 node
= lttng_ht_iter_get_node_u64(&iter
);
3150 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
3153 /* Check for error event */
3154 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
3155 DBG("Channel fd %d is hup|err.", pollfd
);
3157 lttng_poll_del(&events
, chan
->wait_fd
);
3158 ret
= lttng_ht_del(channel_ht
, &iter
);
3162 * This will close the wait fd for each stream associated to
3163 * this channel AND monitored by the data/metadata thread thus
3164 * will be clean by the right thread.
3166 consumer_close_channel_streams(chan
);
3168 /* Release our own refcount */
3169 if (!uatomic_sub_return(&chan
->refcount
, 1)
3170 && !uatomic_read(&chan
->nb_init_stream_left
)) {
3171 consumer_del_channel(chan
);
3174 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3179 /* Release RCU lock for the channel looked up */
3187 lttng_poll_clean(&events
);
3189 destroy_channel_ht(channel_ht
);
3192 DBG("Channel poll thread exiting");
3195 ERR("Health error occurred in %s", __func__
);
3197 health_unregister(health_consumerd
);
3198 rcu_unregister_thread();
3202 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
3203 struct pollfd
*sockpoll
, int client_socket
)
3210 ret
= lttng_consumer_poll_socket(sockpoll
);
3214 DBG("Metadata connection on client_socket");
3216 /* Blocking call, waiting for transmission */
3217 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
3218 if (ctx
->consumer_metadata_socket
< 0) {
3219 WARN("On accept metadata");
3230 * This thread listens on the consumerd socket and receives the file
3231 * descriptors from the session daemon.
3233 void *consumer_thread_sessiond_poll(void *data
)
3235 int sock
= -1, client_socket
, ret
, err
= -1;
3237 * structure to poll for incoming data on communication socket avoids
3238 * making blocking sockets.
3240 struct pollfd consumer_sockpoll
[2];
3241 struct lttng_consumer_local_data
*ctx
= data
;
3243 rcu_register_thread();
3245 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_SESSIOND
);
3247 if (testpoint(consumerd_thread_sessiond
)) {
3248 goto error_testpoint
;
3251 health_code_update();
3253 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
3254 unlink(ctx
->consumer_command_sock_path
);
3255 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
3256 if (client_socket
< 0) {
3257 ERR("Cannot create command socket");
3261 ret
= lttcomm_listen_unix_sock(client_socket
);
3266 DBG("Sending ready command to lttng-sessiond");
3267 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
3268 /* return < 0 on error, but == 0 is not fatal */
3270 ERR("Error sending ready command to lttng-sessiond");
3274 /* prepare the FDs to poll : to client socket and the should_quit pipe */
3275 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
3276 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
3277 consumer_sockpoll
[1].fd
= client_socket
;
3278 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3280 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3288 DBG("Connection on client_socket");
3290 /* Blocking call, waiting for transmission */
3291 sock
= lttcomm_accept_unix_sock(client_socket
);
3298 * Setup metadata socket which is the second socket connection on the
3299 * command unix socket.
3301 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
3310 /* This socket is not useful anymore. */
3311 ret
= close(client_socket
);
3313 PERROR("close client_socket");
3317 /* update the polling structure to poll on the established socket */
3318 consumer_sockpoll
[1].fd
= sock
;
3319 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3322 health_code_update();
3324 health_poll_entry();
3325 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3334 DBG("Incoming command on sock");
3335 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
3338 * This could simply be a session daemon quitting. Don't output
3341 DBG("Communication interrupted on command socket");
3345 if (CMM_LOAD_SHARED(consumer_quit
)) {
3346 DBG("consumer_thread_receive_fds received quit from signal");
3347 err
= 0; /* All is OK */
3350 DBG("received command on sock");
3356 DBG("Consumer thread sessiond poll exiting");
3359 * Close metadata streams since the producer is the session daemon which
3362 * NOTE: for now, this only applies to the UST tracer.
3364 lttng_consumer_close_all_metadata();
3367 * when all fds have hung up, the polling thread
3370 CMM_STORE_SHARED(consumer_quit
, 1);
3373 * Notify the data poll thread to poll back again and test the
3374 * consumer_quit state that we just set so to quit gracefully.
3376 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
3378 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
3380 notify_health_quit_pipe(health_quit_pipe
);
3382 /* Cleaning up possibly open sockets. */
3386 PERROR("close sock sessiond poll");
3389 if (client_socket
>= 0) {
3390 ret
= close(client_socket
);
3392 PERROR("close client_socket sessiond poll");
3399 ERR("Health error occurred in %s", __func__
);
3401 health_unregister(health_consumerd
);
3403 rcu_unregister_thread();
3407 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
3408 struct lttng_consumer_local_data
*ctx
)
3412 pthread_mutex_lock(&stream
->chan
->lock
);
3413 pthread_mutex_lock(&stream
->lock
);
3414 if (stream
->metadata_flag
) {
3415 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
3418 switch (consumer_data
.type
) {
3419 case LTTNG_CONSUMER_KERNEL
:
3420 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
3422 case LTTNG_CONSUMER32_UST
:
3423 case LTTNG_CONSUMER64_UST
:
3424 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3427 ERR("Unknown consumer_data type");
3433 if (stream
->metadata_flag
) {
3434 pthread_cond_broadcast(&stream
->metadata_rdv
);
3435 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
3437 pthread_mutex_unlock(&stream
->lock
);
3438 pthread_mutex_unlock(&stream
->chan
->lock
);
3443 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3445 switch (consumer_data
.type
) {
3446 case LTTNG_CONSUMER_KERNEL
:
3447 return lttng_kconsumer_on_recv_stream(stream
);
3448 case LTTNG_CONSUMER32_UST
:
3449 case LTTNG_CONSUMER64_UST
:
3450 return lttng_ustconsumer_on_recv_stream(stream
);
3452 ERR("Unknown consumer_data type");
3459 * Allocate and set consumer data hash tables.
3461 int lttng_consumer_init(void)
3463 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3464 if (!consumer_data
.channel_ht
) {
3468 consumer_data
.channels_by_session_id_ht
=
3469 lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3470 if (!consumer_data
.channels_by_session_id_ht
) {
3474 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3475 if (!consumer_data
.relayd_ht
) {
3479 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3480 if (!consumer_data
.stream_list_ht
) {
3484 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3485 if (!consumer_data
.stream_per_chan_id_ht
) {
3489 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3494 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3499 consumer_data
.chunk_registry
= lttng_trace_chunk_registry_create();
3500 if (!consumer_data
.chunk_registry
) {
3511 * Process the ADD_RELAYD command receive by a consumer.
3513 * This will create a relayd socket pair and add it to the relayd hash table.
3514 * The caller MUST acquire a RCU read side lock before calling it.
3516 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3517 struct lttng_consumer_local_data
*ctx
, int sock
,
3518 struct pollfd
*consumer_sockpoll
,
3519 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
,
3520 uint64_t relayd_session_id
)
3522 int fd
= -1, ret
= -1, relayd_created
= 0;
3523 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3524 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3527 assert(relayd_sock
);
3529 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3531 /* Get relayd reference if exists. */
3532 relayd
= consumer_find_relayd(net_seq_idx
);
3533 if (relayd
== NULL
) {
3534 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3535 /* Not found. Allocate one. */
3536 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3537 if (relayd
== NULL
) {
3538 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3541 relayd
->sessiond_session_id
= sessiond_id
;
3546 * This code path MUST continue to the consumer send status message to
3547 * we can notify the session daemon and continue our work without
3548 * killing everything.
3552 * relayd key should never be found for control socket.
3554 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3557 /* First send a status message before receiving the fds. */
3558 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
3560 /* Somehow, the session daemon is not responding anymore. */
3561 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3562 goto error_nosignal
;
3565 /* Poll on consumer socket. */
3566 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3568 /* Needing to exit in the middle of a command: error. */
3569 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3570 goto error_nosignal
;
3573 /* Get relayd socket from session daemon */
3574 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3575 if (ret
!= sizeof(fd
)) {
3576 fd
= -1; /* Just in case it gets set with an invalid value. */
3579 * Failing to receive FDs might indicate a major problem such as
3580 * reaching a fd limit during the receive where the kernel returns a
3581 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3582 * don't take any chances and stop everything.
3584 * XXX: Feature request #558 will fix that and avoid this possible
3585 * issue when reaching the fd limit.
3587 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3588 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3592 /* Copy socket information and received FD */
3593 switch (sock_type
) {
3594 case LTTNG_STREAM_CONTROL
:
3595 /* Copy received lttcomm socket */
3596 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3597 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3598 /* Handle create_sock error. */
3600 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3604 * Close the socket created internally by
3605 * lttcomm_create_sock, so we can replace it by the one
3606 * received from sessiond.
3608 if (close(relayd
->control_sock
.sock
.fd
)) {
3612 /* Assign new file descriptor */
3613 relayd
->control_sock
.sock
.fd
= fd
;
3614 /* Assign version values. */
3615 relayd
->control_sock
.major
= relayd_sock
->major
;
3616 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3618 relayd
->relayd_session_id
= relayd_session_id
;
3621 case LTTNG_STREAM_DATA
:
3622 /* Copy received lttcomm socket */
3623 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3624 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3625 /* Handle create_sock error. */
3627 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3631 * Close the socket created internally by
3632 * lttcomm_create_sock, so we can replace it by the one
3633 * received from sessiond.
3635 if (close(relayd
->data_sock
.sock
.fd
)) {
3639 /* Assign new file descriptor */
3640 relayd
->data_sock
.sock
.fd
= fd
;
3641 /* Assign version values. */
3642 relayd
->data_sock
.major
= relayd_sock
->major
;
3643 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3646 ERR("Unknown relayd socket type (%d)", sock_type
);
3647 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3651 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3652 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3653 relayd
->net_seq_idx
, fd
);
3655 * We gave the ownership of the fd to the relayd structure. Set the
3656 * fd to -1 so we don't call close() on it in the error path below.
3660 /* We successfully added the socket. Send status back. */
3661 ret
= consumer_send_status_msg(sock
, ret_code
);
3663 /* Somehow, the session daemon is not responding anymore. */
3664 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3665 goto error_nosignal
;
3669 * Add relayd socket pair to consumer data hashtable. If object already
3670 * exists or on error, the function gracefully returns.
3679 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3680 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3684 /* Close received socket if valid. */
3687 PERROR("close received socket");
3691 if (relayd_created
) {
3697 * Search for a relayd associated to the session id and return the reference.
3699 * A rcu read side lock MUST be acquire before calling this function and locked
3700 * until the relayd object is no longer necessary.
3702 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3704 struct lttng_ht_iter iter
;
3705 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3707 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3708 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3711 * Check by sessiond id which is unique here where the relayd session
3712 * id might not be when having multiple relayd.
3714 if (relayd
->sessiond_session_id
== id
) {
3715 /* Found the relayd. There can be only one per id. */
3727 * Check if for a given session id there is still data needed to be extract
3730 * Return 1 if data is pending or else 0 meaning ready to be read.
3732 int consumer_data_pending(uint64_t id
)
3735 struct lttng_ht_iter iter
;
3736 struct lttng_ht
*ht
;
3737 struct lttng_consumer_stream
*stream
;
3738 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3739 int (*data_pending
)(struct lttng_consumer_stream
*);
3741 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3744 pthread_mutex_lock(&consumer_data
.lock
);
3746 switch (consumer_data
.type
) {
3747 case LTTNG_CONSUMER_KERNEL
:
3748 data_pending
= lttng_kconsumer_data_pending
;
3750 case LTTNG_CONSUMER32_UST
:
3751 case LTTNG_CONSUMER64_UST
:
3752 data_pending
= lttng_ustconsumer_data_pending
;
3755 ERR("Unknown consumer data type");
3759 /* Ease our life a bit */
3760 ht
= consumer_data
.stream_list_ht
;
3762 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3763 ht
->hash_fct(&id
, lttng_ht_seed
),
3765 &iter
.iter
, stream
, node_session_id
.node
) {
3766 pthread_mutex_lock(&stream
->lock
);
3769 * A removed node from the hash table indicates that the stream has
3770 * been deleted thus having a guarantee that the buffers are closed
3771 * on the consumer side. However, data can still be transmitted
3772 * over the network so don't skip the relayd check.
3774 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3776 /* Check the stream if there is data in the buffers. */
3777 ret
= data_pending(stream
);
3779 pthread_mutex_unlock(&stream
->lock
);
3784 pthread_mutex_unlock(&stream
->lock
);
3787 relayd
= find_relayd_by_session_id(id
);
3789 unsigned int is_data_inflight
= 0;
3791 /* Send init command for data pending. */
3792 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3793 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3794 relayd
->relayd_session_id
);
3796 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3797 /* Communication error thus the relayd so no data pending. */
3798 goto data_not_pending
;
3801 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3802 ht
->hash_fct(&id
, lttng_ht_seed
),
3804 &iter
.iter
, stream
, node_session_id
.node
) {
3805 if (stream
->metadata_flag
) {
3806 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3807 stream
->relayd_stream_id
);
3809 ret
= relayd_data_pending(&relayd
->control_sock
,
3810 stream
->relayd_stream_id
,
3811 stream
->next_net_seq_num
- 1);
3815 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3817 } else if (ret
< 0) {
3818 ERR("Relayd data pending failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
3819 lttng_consumer_cleanup_relayd(relayd
);
3820 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3821 goto data_not_pending
;
3825 /* Send end command for data pending. */
3826 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3827 relayd
->relayd_session_id
, &is_data_inflight
);
3828 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3830 ERR("Relayd end data pending failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
3831 lttng_consumer_cleanup_relayd(relayd
);
3832 goto data_not_pending
;
3834 if (is_data_inflight
) {
3840 * Finding _no_ node in the hash table and no inflight data means that the
3841 * stream(s) have been removed thus data is guaranteed to be available for
3842 * analysis from the trace files.
3846 /* Data is available to be read by a viewer. */
3847 pthread_mutex_unlock(&consumer_data
.lock
);
3852 /* Data is still being extracted from buffers. */
3853 pthread_mutex_unlock(&consumer_data
.lock
);
3859 * Send a ret code status message to the sessiond daemon.
3861 * Return the sendmsg() return value.
3863 int consumer_send_status_msg(int sock
, int ret_code
)
3865 struct lttcomm_consumer_status_msg msg
;
3867 memset(&msg
, 0, sizeof(msg
));
3868 msg
.ret_code
= ret_code
;
3870 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3874 * Send a channel status message to the sessiond daemon.
3876 * Return the sendmsg() return value.
3878 int consumer_send_status_channel(int sock
,
3879 struct lttng_consumer_channel
*channel
)
3881 struct lttcomm_consumer_status_channel msg
;
3885 memset(&msg
, 0, sizeof(msg
));
3887 msg
.ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
3889 msg
.ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3890 msg
.key
= channel
->key
;
3891 msg
.stream_count
= channel
->streams
.count
;
3894 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3897 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
3898 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
3899 uint64_t max_sb_size
)
3901 unsigned long start_pos
;
3903 if (!nb_packets_per_stream
) {
3904 return consumed_pos
; /* Grab everything */
3906 start_pos
= produced_pos
- offset_align_floor(produced_pos
, max_sb_size
);
3907 start_pos
-= max_sb_size
* nb_packets_per_stream
;
3908 if ((long) (start_pos
- consumed_pos
) < 0) {
3909 return consumed_pos
; /* Grab everything */
3915 int consumer_flush_buffer(struct lttng_consumer_stream
*stream
, int producer_active
)
3919 switch (consumer_data
.type
) {
3920 case LTTNG_CONSUMER_KERNEL
:
3921 if (producer_active
) {
3922 ret
= kernctl_buffer_flush(stream
->wait_fd
);
3924 ERR("Failed to flush kernel stream");
3928 ret
= kernctl_buffer_flush_empty(stream
->wait_fd
);
3931 * Doing a buffer flush which does not take into
3932 * account empty packets. This is not perfect,
3933 * but required as a fall-back when
3934 * "flush_empty" is not implemented by
3937 ret
= kernctl_buffer_flush(stream
->wait_fd
);
3939 ERR("Failed to flush kernel stream");
3945 case LTTNG_CONSUMER32_UST
:
3946 case LTTNG_CONSUMER64_UST
:
3947 lttng_ustconsumer_flush_buffer(stream
, producer_active
);
3950 ERR("Unknown consumer_data type");
3959 * Sample the rotate position for all the streams of a channel. If a stream
3960 * is already at the rotate position (produced == consumed), we flag it as
3961 * ready for rotation. The rotation of ready streams occurs after we have
3962 * replied to the session daemon that we have finished sampling the positions.
3963 * Must be called with RCU read-side lock held to ensure existence of channel.
3965 * Returns 0 on success, < 0 on error
3967 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
3968 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
3969 struct lttng_consumer_local_data
*ctx
)
3972 struct lttng_consumer_stream
*stream
;
3973 struct lttng_ht_iter iter
;
3974 struct lttng_ht
*ht
= consumer_data
.stream_per_chan_id_ht
;
3975 struct lttng_dynamic_array stream_rotation_positions
;
3976 uint64_t next_chunk_id
, stream_count
= 0;
3977 enum lttng_trace_chunk_status chunk_status
;
3978 const bool is_local_trace
= relayd_id
== -1ULL;
3979 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3980 bool rotating_to_new_chunk
= true;
3982 DBG("Consumer sample rotate position for channel %" PRIu64
, key
);
3984 lttng_dynamic_array_init(&stream_rotation_positions
,
3985 sizeof(struct relayd_stream_rotation_position
), NULL
);
3989 pthread_mutex_lock(&channel
->lock
);
3990 assert(channel
->trace_chunk
);
3991 chunk_status
= lttng_trace_chunk_get_id(channel
->trace_chunk
,
3993 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3995 goto end_unlock_channel
;
3998 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3999 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4000 ht
->match_fct
, &channel
->key
, &iter
.iter
,
4001 stream
, node_channel_id
.node
) {
4002 unsigned long produced_pos
= 0, consumed_pos
= 0;
4004 health_code_update();
4007 * Lock stream because we are about to change its state.
4009 pthread_mutex_lock(&stream
->lock
);
4011 if (stream
->trace_chunk
== stream
->chan
->trace_chunk
) {
4012 rotating_to_new_chunk
= false;
4016 * Do not flush an empty packet when rotating from a NULL trace
4017 * chunk. The stream has no means to output data, and the prior
4018 * rotation which rotated to NULL performed that side-effect already.
4020 if (stream
->trace_chunk
) {
4022 * For metadata stream, do an active flush, which does not
4023 * produce empty packets. For data streams, empty-flush;
4024 * ensures we have at least one packet in each stream per trace
4025 * chunk, even if no data was produced.
4027 ret
= consumer_flush_buffer(stream
, stream
->metadata_flag
? 1 : 0);
4029 ERR("Failed to flush stream %" PRIu64
" during channel rotation",
4031 goto end_unlock_stream
;
4035 ret
= lttng_consumer_take_snapshot(stream
);
4036 if (ret
< 0 && ret
!= -ENODATA
&& ret
!= -EAGAIN
) {
4037 ERR("Failed to sample snapshot position during channel rotation");
4038 goto end_unlock_stream
;
4041 ret
= lttng_consumer_get_produced_snapshot(stream
,
4044 ERR("Failed to sample produced position during channel rotation");
4045 goto end_unlock_stream
;
4048 ret
= lttng_consumer_get_consumed_snapshot(stream
,
4051 ERR("Failed to sample consumed position during channel rotation");
4052 goto end_unlock_stream
;
4056 * Align produced position on the start-of-packet boundary of the first
4057 * packet going into the next trace chunk.
4059 produced_pos
= ALIGN_FLOOR(produced_pos
, stream
->max_sb_size
);
4060 if (consumed_pos
== produced_pos
) {
4061 DBG("Set rotate ready for stream %" PRIu64
" produced = %lu consumed = %lu",
4062 stream
->key
, produced_pos
, consumed_pos
);
4063 stream
->rotate_ready
= true;
4065 DBG("Different consumed and produced positions "
4066 "for stream %" PRIu64
" produced = %lu consumed = %lu",
4067 stream
->key
, produced_pos
, consumed_pos
);
4070 * The rotation position is based on the packet_seq_num of the
4071 * packet following the last packet that was consumed for this
4072 * stream, incremented by the offset between produced and
4073 * consumed positions. This rotation position is a lower bound
4074 * (inclusive) at which the next trace chunk starts. Since it
4075 * is a lower bound, it is OK if the packet_seq_num does not
4076 * correspond exactly to the same packet identified by the
4077 * consumed_pos, which can happen in overwrite mode.
4079 if (stream
->sequence_number_unavailable
) {
4081 * Rotation should never be performed on a session which
4082 * interacts with a pre-2.8 lttng-modules, which does
4083 * not implement packet sequence number.
4085 ERR("Failure to rotate stream %" PRIu64
": sequence number unavailable",
4088 goto end_unlock_stream
;
4090 stream
->rotate_position
= stream
->last_sequence_number
+ 1 +
4091 ((produced_pos
- consumed_pos
) / stream
->max_sb_size
);
4092 DBG("Set rotation position for stream %" PRIu64
" at position %" PRIu64
,
4093 stream
->key
, stream
->rotate_position
);
4095 if (!is_local_trace
) {
4097 * The relay daemon control protocol expects a rotation
4098 * position as "the sequence number of the first packet
4099 * _after_ the current trace chunk".
4101 const struct relayd_stream_rotation_position position
= {
4102 .stream_id
= stream
->relayd_stream_id
,
4103 .rotate_at_seq_num
= stream
->rotate_position
,
4106 ret
= lttng_dynamic_array_add_element(
4107 &stream_rotation_positions
,
4110 ERR("Failed to allocate stream rotation position");
4111 goto end_unlock_stream
;
4115 pthread_mutex_unlock(&stream
->lock
);
4118 pthread_mutex_unlock(&channel
->lock
);
4120 if (is_local_trace
) {
4125 relayd
= consumer_find_relayd(relayd_id
);
4127 ERR("Failed to find relayd %" PRIu64
, relayd_id
);
4132 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4133 ret
= relayd_rotate_streams(&relayd
->control_sock
, stream_count
,
4134 rotating_to_new_chunk
? &next_chunk_id
: NULL
,
4135 (const struct relayd_stream_rotation_position
*)
4136 stream_rotation_positions
.buffer
.data
);
4137 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4139 ERR("Relayd rotate stream failed. Cleaning up relayd %" PRIu64
,
4140 relayd
->net_seq_idx
);
4141 lttng_consumer_cleanup_relayd(relayd
);
4149 pthread_mutex_unlock(&stream
->lock
);
4151 pthread_mutex_unlock(&channel
->lock
);
4154 lttng_dynamic_array_reset(&stream_rotation_positions
);
4159 int consumer_clear_buffer(struct lttng_consumer_stream
*stream
)
4162 unsigned long consumed_pos_before
, consumed_pos_after
;
4164 ret
= lttng_consumer_sample_snapshot_positions(stream
);
4166 ERR("Taking snapshot positions");
4170 ret
= lttng_consumer_get_consumed_snapshot(stream
, &consumed_pos_before
);
4172 ERR("Consumed snapshot position");
4176 switch (consumer_data
.type
) {
4177 case LTTNG_CONSUMER_KERNEL
:
4178 ret
= kernctl_buffer_clear(stream
->wait_fd
);
4180 ERR("Failed to clear kernel stream (ret = %d)", ret
);
4184 case LTTNG_CONSUMER32_UST
:
4185 case LTTNG_CONSUMER64_UST
:
4186 lttng_ustconsumer_clear_buffer(stream
);
4189 ERR("Unknown consumer_data type");
4193 ret
= lttng_consumer_sample_snapshot_positions(stream
);
4195 ERR("Taking snapshot positions");
4198 ret
= lttng_consumer_get_consumed_snapshot(stream
, &consumed_pos_after
);
4200 ERR("Consumed snapshot position");
4203 DBG("clear: before: %lu after: %lu", consumed_pos_before
, consumed_pos_after
);
4209 int consumer_clear_stream(struct lttng_consumer_stream
*stream
)
4213 ret
= consumer_flush_buffer(stream
, 1);
4215 ERR("Failed to flush stream %" PRIu64
" during channel clear",
4217 ret
= LTTCOMM_CONSUMERD_FATAL
;
4221 ret
= consumer_clear_buffer(stream
);
4223 ERR("Failed to clear stream %" PRIu64
" during channel clear",
4225 ret
= LTTCOMM_CONSUMERD_FATAL
;
4229 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4235 int consumer_clear_unmonitored_channel(struct lttng_consumer_channel
*channel
)
4238 struct lttng_consumer_stream
*stream
;
4241 pthread_mutex_lock(&channel
->lock
);
4242 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
4243 health_code_update();
4244 pthread_mutex_lock(&stream
->lock
);
4245 ret
= consumer_clear_stream(stream
);
4249 pthread_mutex_unlock(&stream
->lock
);
4251 pthread_mutex_unlock(&channel
->lock
);
4256 pthread_mutex_unlock(&stream
->lock
);
4257 pthread_mutex_unlock(&channel
->lock
);
4263 * Check if a stream is ready to be rotated after extracting it.
4265 * Return 1 if it is ready for rotation, 0 if it is not, a negative value on
4266 * error. Stream lock must be held.
4268 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
)
4270 DBG("Check is rotate ready for stream %" PRIu64
4271 " ready %u rotate_position %" PRIu64
4272 " last_sequence_number %" PRIu64
,
4273 stream
->key
, stream
->rotate_ready
,
4274 stream
->rotate_position
, stream
->last_sequence_number
);
4275 if (stream
->rotate_ready
) {
4280 * If packet seq num is unavailable, it means we are interacting
4281 * with a pre-2.8 lttng-modules which does not implement the
4282 * sequence number. Rotation should never be used by sessiond in this
4285 if (stream
->sequence_number_unavailable
) {
4286 ERR("Internal error: rotation used on stream %" PRIu64
4287 " with unavailable sequence number",
4292 if (stream
->rotate_position
== -1ULL ||
4293 stream
->last_sequence_number
== -1ULL) {
4298 * Rotate position not reached yet. The stream rotate position is
4299 * the position of the next packet belonging to the next trace chunk,
4300 * but consumerd considers rotation ready when reaching the last
4301 * packet of the current chunk, hence the "rotate_position - 1".
4304 DBG("Check is rotate ready for stream %" PRIu64
4305 " last_sequence_number %" PRIu64
4306 " rotate_position %" PRIu64
,
4307 stream
->key
, stream
->last_sequence_number
,
4308 stream
->rotate_position
);
4309 if (stream
->last_sequence_number
>= stream
->rotate_position
- 1) {
4317 * Reset the state for a stream after a rotation occurred.
4319 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
)
4321 DBG("lttng_consumer_reset_stream_rotate_state for stream %" PRIu64
,
4323 stream
->rotate_position
= -1ULL;
4324 stream
->rotate_ready
= false;
4328 * Perform the rotation a local stream file.
4331 int rotate_local_stream(struct lttng_consumer_local_data
*ctx
,
4332 struct lttng_consumer_stream
*stream
)
4336 DBG("Rotate local stream: stream key %" PRIu64
", channel key %" PRIu64
,
4339 stream
->tracefile_size_current
= 0;
4340 stream
->tracefile_count_current
= 0;
4342 if (stream
->out_fd
>= 0) {
4343 ret
= close(stream
->out_fd
);
4345 PERROR("Failed to close stream out_fd of channel \"%s\"",
4346 stream
->chan
->name
);
4348 stream
->out_fd
= -1;
4351 if (stream
->index_file
) {
4352 lttng_index_file_put(stream
->index_file
);
4353 stream
->index_file
= NULL
;
4356 if (!stream
->trace_chunk
) {
4360 ret
= consumer_stream_create_output_files(stream
, true);
4366 * Performs the stream rotation for the rotate session feature if needed.
4367 * It must be called with the channel and stream locks held.
4369 * Return 0 on success, a negative number of error.
4371 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
4372 struct lttng_consumer_stream
*stream
)
4376 DBG("Consumer rotate stream %" PRIu64
, stream
->key
);
4379 * Update the stream's 'current' chunk to the session's (channel)
4380 * now-current chunk.
4382 lttng_trace_chunk_put(stream
->trace_chunk
);
4383 if (stream
->chan
->trace_chunk
== stream
->trace_chunk
) {
4385 * A channel can be rotated and not have a "next" chunk
4386 * to transition to. In that case, the channel's "current chunk"
4387 * has not been closed yet, but it has not been updated to
4388 * a "next" trace chunk either. Hence, the stream, like its
4389 * parent channel, becomes part of no chunk and can't output
4390 * anything until a new trace chunk is created.
4392 stream
->trace_chunk
= NULL
;
4393 } else if (stream
->chan
->trace_chunk
&&
4394 !lttng_trace_chunk_get(stream
->chan
->trace_chunk
)) {
4395 ERR("Failed to acquire a reference to channel's trace chunk during stream rotation");
4400 * Update the stream's trace chunk to its parent channel's
4401 * current trace chunk.
4403 stream
->trace_chunk
= stream
->chan
->trace_chunk
;
4406 if (stream
->net_seq_idx
== (uint64_t) -1ULL) {
4407 ret
= rotate_local_stream(ctx
, stream
);
4409 ERR("Failed to rotate stream, ret = %i", ret
);
4414 if (stream
->metadata_flag
&& stream
->trace_chunk
) {
4416 * If the stream has transitioned to a new trace
4417 * chunk, the metadata should be re-dumped to the
4420 * However, it is possible for a stream to transition to
4421 * a "no-chunk" state. This can happen if a rotation
4422 * occurs on an inactive session. In such cases, the metadata
4423 * regeneration will happen when the next trace chunk is
4426 ret
= consumer_metadata_stream_dump(stream
);
4431 lttng_consumer_reset_stream_rotate_state(stream
);
4440 * Rotate all the ready streams now.
4442 * This is especially important for low throughput streams that have already
4443 * been consumed, we cannot wait for their next packet to perform the
4445 * Need to be called with RCU read-side lock held to ensure existence of
4448 * Returns 0 on success, < 0 on error
4450 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
4451 uint64_t key
, struct lttng_consumer_local_data
*ctx
)
4454 struct lttng_consumer_stream
*stream
;
4455 struct lttng_ht_iter iter
;
4456 struct lttng_ht
*ht
= consumer_data
.stream_per_chan_id_ht
;
4460 DBG("Consumer rotate ready streams in channel %" PRIu64
, key
);
4462 cds_lfht_for_each_entry_duplicate(ht
->ht
,
4463 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4464 ht
->match_fct
, &channel
->key
, &iter
.iter
,
4465 stream
, node_channel_id
.node
) {
4466 health_code_update();
4468 pthread_mutex_lock(&stream
->chan
->lock
);
4469 pthread_mutex_lock(&stream
->lock
);
4471 if (!stream
->rotate_ready
) {
4472 pthread_mutex_unlock(&stream
->lock
);
4473 pthread_mutex_unlock(&stream
->chan
->lock
);
4476 DBG("Consumer rotate ready stream %" PRIu64
, stream
->key
);
4478 ret
= lttng_consumer_rotate_stream(ctx
, stream
);
4479 pthread_mutex_unlock(&stream
->lock
);
4480 pthread_mutex_unlock(&stream
->chan
->lock
);
4493 enum lttcomm_return_code
lttng_consumer_init_command(
4494 struct lttng_consumer_local_data
*ctx
,
4495 const lttng_uuid sessiond_uuid
)
4497 enum lttcomm_return_code ret
;
4498 char uuid_str
[LTTNG_UUID_STR_LEN
];
4500 if (ctx
->sessiond_uuid
.is_set
) {
4501 ret
= LTTCOMM_CONSUMERD_ALREADY_SET
;
4505 ctx
->sessiond_uuid
.is_set
= true;
4506 memcpy(ctx
->sessiond_uuid
.value
, sessiond_uuid
, sizeof(lttng_uuid
));
4507 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4508 lttng_uuid_to_str(sessiond_uuid
, uuid_str
);
4509 DBG("Received session daemon UUID: %s", uuid_str
);
4514 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
4515 const uint64_t *relayd_id
, uint64_t session_id
,
4517 time_t chunk_creation_timestamp
,
4518 const char *chunk_override_name
,
4519 const struct lttng_credentials
*credentials
,
4520 struct lttng_directory_handle
*chunk_directory_handle
)
4523 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
4524 struct lttng_trace_chunk
*created_chunk
= NULL
, *published_chunk
= NULL
;
4525 enum lttng_trace_chunk_status chunk_status
;
4526 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4527 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
4528 const char *relayd_id_str
= "(none)";
4529 const char *creation_timestamp_str
;
4530 struct lttng_ht_iter iter
;
4531 struct lttng_consumer_channel
*channel
;
4534 /* Only used for logging purposes. */
4535 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4536 "%" PRIu64
, *relayd_id
);
4537 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4538 relayd_id_str
= relayd_id_buffer
;
4540 relayd_id_str
= "(formatting error)";
4544 /* Local protocol error. */
4545 assert(chunk_creation_timestamp
);
4546 ret
= time_to_iso8601_str(chunk_creation_timestamp
,
4547 creation_timestamp_buffer
,
4548 sizeof(creation_timestamp_buffer
));
4549 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
4550 "(formatting error)";
4552 DBG("Consumer create trace chunk command: relay_id = %s"
4553 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
4554 ", chunk_override_name = %s"
4555 ", chunk_creation_timestamp = %s",
4556 relayd_id_str
, session_id
, chunk_id
,
4557 chunk_override_name
? : "(none)",
4558 creation_timestamp_str
);
4561 * The trace chunk registry, as used by the consumer daemon, implicitly
4562 * owns the trace chunks. This is only needed in the consumer since
4563 * the consumer has no notion of a session beyond session IDs being
4564 * used to identify other objects.
4566 * The lttng_trace_chunk_registry_publish() call below provides a
4567 * reference which is not released; it implicitly becomes the session
4568 * daemon's reference to the chunk in the consumer daemon.
4570 * The lifetime of trace chunks in the consumer daemon is managed by
4571 * the session daemon through the LTTNG_CONSUMER_CREATE_TRACE_CHUNK
4572 * and LTTNG_CONSUMER_DESTROY_TRACE_CHUNK commands.
4574 created_chunk
= lttng_trace_chunk_create(chunk_id
,
4575 chunk_creation_timestamp
, NULL
);
4576 if (!created_chunk
) {
4577 ERR("Failed to create trace chunk");
4578 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4582 if (chunk_override_name
) {
4583 chunk_status
= lttng_trace_chunk_override_name(created_chunk
,
4584 chunk_override_name
);
4585 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4586 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4591 if (chunk_directory_handle
) {
4592 chunk_status
= lttng_trace_chunk_set_credentials(created_chunk
,
4594 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4595 ERR("Failed to set trace chunk credentials");
4596 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4600 * The consumer daemon has no ownership of the chunk output
4603 chunk_status
= lttng_trace_chunk_set_as_user(created_chunk
,
4604 chunk_directory_handle
);
4605 chunk_directory_handle
= NULL
;
4606 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4607 ERR("Failed to set trace chunk's directory handle");
4608 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4613 published_chunk
= lttng_trace_chunk_registry_publish_chunk(
4614 consumer_data
.chunk_registry
, session_id
,
4616 lttng_trace_chunk_put(created_chunk
);
4617 created_chunk
= NULL
;
4618 if (!published_chunk
) {
4619 ERR("Failed to publish trace chunk");
4620 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4625 cds_lfht_for_each_entry_duplicate(consumer_data
.channels_by_session_id_ht
->ht
,
4626 consumer_data
.channels_by_session_id_ht
->hash_fct(
4627 &session_id
, lttng_ht_seed
),
4628 consumer_data
.channels_by_session_id_ht
->match_fct
,
4629 &session_id
, &iter
.iter
, channel
,
4630 channels_by_session_id_ht_node
.node
) {
4631 ret
= lttng_consumer_channel_set_trace_chunk(channel
,
4635 * Roll-back the creation of this chunk.
4637 * This is important since the session daemon will
4638 * assume that the creation of this chunk failed and
4639 * will never ask for it to be closed, resulting
4640 * in a leak and an inconsistent state for some
4643 enum lttcomm_return_code close_ret
;
4644 char path
[LTTNG_PATH_MAX
];
4646 DBG("Failed to set new trace chunk on existing channels, rolling back");
4647 close_ret
= lttng_consumer_close_trace_chunk(relayd_id
,
4648 session_id
, chunk_id
,
4649 chunk_creation_timestamp
, NULL
,
4651 if (close_ret
!= LTTCOMM_CONSUMERD_SUCCESS
) {
4652 ERR("Failed to roll-back the creation of new chunk: session_id = %" PRIu64
", chunk_id = %" PRIu64
,
4653 session_id
, chunk_id
);
4656 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4662 struct consumer_relayd_sock_pair
*relayd
;
4664 relayd
= consumer_find_relayd(*relayd_id
);
4666 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4667 ret
= relayd_create_trace_chunk(
4668 &relayd
->control_sock
, published_chunk
);
4669 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4671 ERR("Failed to find relay daemon socket: relayd_id = %" PRIu64
, *relayd_id
);
4674 if (!relayd
|| ret
) {
4675 enum lttcomm_return_code close_ret
;
4676 char path
[LTTNG_PATH_MAX
];
4678 close_ret
= lttng_consumer_close_trace_chunk(relayd_id
,
4681 chunk_creation_timestamp
,
4683 if (close_ret
!= LTTCOMM_CONSUMERD_SUCCESS
) {
4684 ERR("Failed to roll-back the creation of new chunk: session_id = %" PRIu64
", chunk_id = %" PRIu64
,
4689 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4696 /* Release the reference returned by the "publish" operation. */
4697 lttng_trace_chunk_put(published_chunk
);
4698 lttng_trace_chunk_put(created_chunk
);
4702 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
4703 const uint64_t *relayd_id
, uint64_t session_id
,
4704 uint64_t chunk_id
, time_t chunk_close_timestamp
,
4705 const enum lttng_trace_chunk_command_type
*close_command
,
4708 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
4709 struct lttng_trace_chunk
*chunk
;
4710 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4711 const char *relayd_id_str
= "(none)";
4712 const char *close_command_name
= "none";
4713 struct lttng_ht_iter iter
;
4714 struct lttng_consumer_channel
*channel
;
4715 enum lttng_trace_chunk_status chunk_status
;
4720 /* Only used for logging purposes. */
4721 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4722 "%" PRIu64
, *relayd_id
);
4723 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4724 relayd_id_str
= relayd_id_buffer
;
4726 relayd_id_str
= "(formatting error)";
4729 if (close_command
) {
4730 close_command_name
= lttng_trace_chunk_command_type_get_name(
4734 DBG("Consumer close trace chunk command: relayd_id = %s"
4735 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
4736 ", close command = %s",
4737 relayd_id_str
, session_id
, chunk_id
,
4738 close_command_name
);
4740 chunk
= lttng_trace_chunk_registry_find_chunk(
4741 consumer_data
.chunk_registry
, session_id
, chunk_id
);
4743 ERR("Failed to find chunk: session_id = %" PRIu64
4744 ", chunk_id = %" PRIu64
,
4745 session_id
, chunk_id
);
4746 ret_code
= LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4750 chunk_status
= lttng_trace_chunk_set_close_timestamp(chunk
,
4751 chunk_close_timestamp
);
4752 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4753 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4757 if (close_command
) {
4758 chunk_status
= lttng_trace_chunk_set_close_command(
4759 chunk
, *close_command
);
4760 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4761 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4767 * chunk is now invalid to access as we no longer hold a reference to
4768 * it; it is only kept around to compare it (by address) to the
4769 * current chunk found in the session's channels.
4772 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
,
4773 channel
, node
.node
) {
4777 * Only change the channel's chunk to NULL if it still
4778 * references the chunk being closed. The channel may
4779 * reference a newer channel in the case of a session
4780 * rotation. When a session rotation occurs, the "next"
4781 * chunk is created before the "current" chunk is closed.
4783 if (channel
->trace_chunk
!= chunk
) {
4786 ret
= lttng_consumer_channel_set_trace_chunk(channel
, NULL
);
4789 * Attempt to close the chunk on as many channels as
4792 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4798 struct consumer_relayd_sock_pair
*relayd
;
4800 relayd
= consumer_find_relayd(*relayd_id
);
4802 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4803 ret
= relayd_close_trace_chunk(
4804 &relayd
->control_sock
, chunk
,
4806 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4808 ERR("Failed to find relay daemon socket: relayd_id = %" PRIu64
,
4812 if (!relayd
|| ret
) {
4813 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4821 * Release the reference returned by the "find" operation and
4822 * the session daemon's implicit reference to the chunk.
4824 lttng_trace_chunk_put(chunk
);
4825 lttng_trace_chunk_put(chunk
);
4830 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
4831 const uint64_t *relayd_id
, uint64_t session_id
,
4835 enum lttcomm_return_code ret_code
;
4836 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4837 const char *relayd_id_str
= "(none)";
4838 const bool is_local_trace
= !relayd_id
;
4839 struct consumer_relayd_sock_pair
*relayd
= NULL
;
4840 bool chunk_exists_local
, chunk_exists_remote
;
4845 /* Only used for logging purposes. */
4846 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4847 "%" PRIu64
, *relayd_id
);
4848 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4849 relayd_id_str
= relayd_id_buffer
;
4851 relayd_id_str
= "(formatting error)";
4855 DBG("Consumer trace chunk exists command: relayd_id = %s"
4856 ", chunk_id = %" PRIu64
, relayd_id_str
,
4858 ret
= lttng_trace_chunk_registry_chunk_exists(
4859 consumer_data
.chunk_registry
, session_id
,
4860 chunk_id
, &chunk_exists_local
);
4862 /* Internal error. */
4863 ERR("Failed to query the existence of a trace chunk");
4864 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
4867 DBG("Trace chunk %s locally",
4868 chunk_exists_local
? "exists" : "does not exist");
4869 if (chunk_exists_local
) {
4870 ret_code
= LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
;
4872 } else if (is_local_trace
) {
4873 ret_code
= LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4878 relayd
= consumer_find_relayd(*relayd_id
);
4880 ERR("Failed to find relayd %" PRIu64
, *relayd_id
);
4881 ret_code
= LTTCOMM_CONSUMERD_INVALID_PARAMETERS
;
4882 goto end_rcu_unlock
;
4884 DBG("Looking up existence of trace chunk on relay daemon");
4885 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4886 ret
= relayd_trace_chunk_exists(&relayd
->control_sock
, chunk_id
,
4887 &chunk_exists_remote
);
4888 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4890 ERR("Failed to look-up the existence of trace chunk on relay daemon");
4891 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
4892 goto end_rcu_unlock
;
4895 ret_code
= chunk_exists_remote
?
4896 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
4897 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4898 DBG("Trace chunk %s on relay daemon",
4899 chunk_exists_remote
? "exists" : "does not exist");
4908 int consumer_clear_monitored_channel(struct lttng_consumer_channel
*channel
)
4910 struct lttng_ht
*ht
;
4911 struct lttng_consumer_stream
*stream
;
4912 struct lttng_ht_iter iter
;
4915 ht
= consumer_data
.stream_per_chan_id_ht
;
4918 cds_lfht_for_each_entry_duplicate(ht
->ht
,
4919 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4920 ht
->match_fct
, &channel
->key
,
4921 &iter
.iter
, stream
, node_channel_id
.node
) {
4923 * Protect against teardown with mutex.
4925 pthread_mutex_lock(&stream
->lock
);
4926 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
4929 ret
= consumer_clear_stream(stream
);
4934 pthread_mutex_unlock(&stream
->lock
);
4937 return LTTCOMM_CONSUMERD_SUCCESS
;
4940 pthread_mutex_unlock(&stream
->lock
);
4945 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
)
4949 DBG("Consumer clear channel %" PRIu64
, channel
->key
);
4951 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
4953 * Nothing to do for the metadata channel/stream.
4954 * Snapshot mechanism already take care of the metadata
4955 * handling/generation, and monitored channels only need to
4956 * have their data stream cleared..
4958 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4962 if (!channel
->monitor
) {
4963 ret
= consumer_clear_unmonitored_channel(channel
);
4965 ret
= consumer_clear_monitored_channel(channel
);