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(
572 struct lttng_consumer_channel
*channel
,
573 uint64_t channel_key
,
575 const char *channel_name
,
578 struct lttng_trace_chunk
*trace_chunk
,
581 enum consumer_channel_type type
,
582 unsigned int monitor
)
585 struct lttng_consumer_stream
*stream
;
587 stream
= zmalloc(sizeof(*stream
));
588 if (stream
== NULL
) {
589 PERROR("malloc struct lttng_consumer_stream");
594 if (trace_chunk
&& !lttng_trace_chunk_get(trace_chunk
)) {
595 ERR("Failed to acquire trace chunk reference during the creation of a stream");
601 stream
->chan
= channel
;
602 stream
->key
= stream_key
;
603 stream
->trace_chunk
= trace_chunk
;
605 stream
->out_fd_offset
= 0;
606 stream
->output_written
= 0;
607 stream
->net_seq_idx
= relayd_id
;
608 stream
->session_id
= session_id
;
609 stream
->monitor
= monitor
;
610 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
611 stream
->index_file
= NULL
;
612 stream
->last_sequence_number
= -1ULL;
613 stream
->rotate_position
= -1ULL;
614 pthread_mutex_init(&stream
->lock
, NULL
);
615 pthread_mutex_init(&stream
->metadata_timer_lock
, NULL
);
617 /* If channel is the metadata, flag this stream as metadata. */
618 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
619 stream
->metadata_flag
= 1;
620 /* Metadata is flat out. */
621 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
622 /* Live rendez-vous point. */
623 pthread_cond_init(&stream
->metadata_rdv
, NULL
);
624 pthread_mutex_init(&stream
->metadata_rdv_lock
, NULL
);
626 /* Format stream name to <channel_name>_<cpu_number> */
627 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d",
630 PERROR("snprintf stream name");
635 /* Key is always the wait_fd for streams. */
636 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
638 /* Init node per channel id key */
639 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
641 /* Init session id node with the stream session id */
642 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
644 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
645 " relayd_id %" PRIu64
", session_id %" PRIu64
,
646 stream
->name
, stream
->key
, channel_key
,
647 stream
->net_seq_idx
, stream
->session_id
);
654 lttng_trace_chunk_put(stream
->trace_chunk
);
664 * Add a stream to the global list protected by a mutex.
666 void consumer_add_data_stream(struct lttng_consumer_stream
*stream
)
668 struct lttng_ht
*ht
= data_ht
;
673 DBG3("Adding consumer stream %" PRIu64
, stream
->key
);
675 pthread_mutex_lock(&consumer_data
.lock
);
676 pthread_mutex_lock(&stream
->chan
->lock
);
677 pthread_mutex_lock(&stream
->chan
->timer_lock
);
678 pthread_mutex_lock(&stream
->lock
);
681 /* Steal stream identifier to avoid having streams with the same key */
682 steal_stream_key(stream
->key
, ht
);
684 lttng_ht_add_unique_u64(ht
, &stream
->node
);
686 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
687 &stream
->node_channel_id
);
690 * Add stream to the stream_list_ht of the consumer data. No need to steal
691 * the key since the HT does not use it and we allow to add redundant keys
694 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
697 * When nb_init_stream_left reaches 0, we don't need to trigger any action
698 * in terms of destroying the associated channel, because the action that
699 * causes the count to become 0 also causes a stream to be added. The
700 * channel deletion will thus be triggered by the following removal of this
703 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
704 /* Increment refcount before decrementing nb_init_stream_left */
706 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
709 /* Update consumer data once the node is inserted. */
710 consumer_data
.stream_count
++;
711 consumer_data
.need_update
= 1;
714 pthread_mutex_unlock(&stream
->lock
);
715 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
716 pthread_mutex_unlock(&stream
->chan
->lock
);
717 pthread_mutex_unlock(&consumer_data
.lock
);
721 * Add relayd socket to global consumer data hashtable. RCU read side lock MUST
722 * be acquired before calling this.
724 static int add_relayd(struct consumer_relayd_sock_pair
*relayd
)
727 struct lttng_ht_node_u64
*node
;
728 struct lttng_ht_iter iter
;
732 lttng_ht_lookup(consumer_data
.relayd_ht
,
733 &relayd
->net_seq_idx
, &iter
);
734 node
= lttng_ht_iter_get_node_u64(&iter
);
738 lttng_ht_add_unique_u64(consumer_data
.relayd_ht
, &relayd
->node
);
745 * Allocate and return a consumer relayd socket.
747 static struct consumer_relayd_sock_pair
*consumer_allocate_relayd_sock_pair(
748 uint64_t net_seq_idx
)
750 struct consumer_relayd_sock_pair
*obj
= NULL
;
752 /* net sequence index of -1 is a failure */
753 if (net_seq_idx
== (uint64_t) -1ULL) {
757 obj
= zmalloc(sizeof(struct consumer_relayd_sock_pair
));
759 PERROR("zmalloc relayd sock");
763 obj
->net_seq_idx
= net_seq_idx
;
765 obj
->destroy_flag
= 0;
766 obj
->control_sock
.sock
.fd
= -1;
767 obj
->data_sock
.sock
.fd
= -1;
768 lttng_ht_node_init_u64(&obj
->node
, obj
->net_seq_idx
);
769 pthread_mutex_init(&obj
->ctrl_sock_mutex
, NULL
);
776 * Find a relayd socket pair in the global consumer data.
778 * Return the object if found else NULL.
779 * RCU read-side lock must be held across this call and while using the
782 struct consumer_relayd_sock_pair
*consumer_find_relayd(uint64_t key
)
784 struct lttng_ht_iter iter
;
785 struct lttng_ht_node_u64
*node
;
786 struct consumer_relayd_sock_pair
*relayd
= NULL
;
788 /* Negative keys are lookup failures */
789 if (key
== (uint64_t) -1ULL) {
793 lttng_ht_lookup(consumer_data
.relayd_ht
, &key
,
795 node
= lttng_ht_iter_get_node_u64(&iter
);
797 relayd
= caa_container_of(node
, struct consumer_relayd_sock_pair
, node
);
805 * Find a relayd and send the stream
807 * Returns 0 on success, < 0 on error
809 int consumer_send_relayd_stream(struct lttng_consumer_stream
*stream
,
813 struct consumer_relayd_sock_pair
*relayd
;
816 assert(stream
->net_seq_idx
!= -1ULL);
819 /* The stream is not metadata. Get relayd reference if exists. */
821 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
822 if (relayd
!= NULL
) {
823 /* Add stream on the relayd */
824 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
825 ret
= relayd_add_stream(&relayd
->control_sock
, stream
->name
,
826 get_consumer_domain(), path
, &stream
->relayd_stream_id
,
827 stream
->chan
->tracefile_size
,
828 stream
->chan
->tracefile_count
,
829 stream
->trace_chunk
);
830 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
832 ERR("Relayd add stream failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
833 lttng_consumer_cleanup_relayd(relayd
);
837 uatomic_inc(&relayd
->refcount
);
838 stream
->sent_to_relayd
= 1;
840 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't send it.",
841 stream
->key
, stream
->net_seq_idx
);
846 DBG("Stream %s with key %" PRIu64
" sent to relayd id %" PRIu64
,
847 stream
->name
, stream
->key
, stream
->net_seq_idx
);
855 * Find a relayd and send the streams sent message
857 * Returns 0 on success, < 0 on error
859 int consumer_send_relayd_streams_sent(uint64_t net_seq_idx
)
862 struct consumer_relayd_sock_pair
*relayd
;
864 assert(net_seq_idx
!= -1ULL);
866 /* The stream is not metadata. Get relayd reference if exists. */
868 relayd
= consumer_find_relayd(net_seq_idx
);
869 if (relayd
!= NULL
) {
870 /* Add stream on the relayd */
871 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
872 ret
= relayd_streams_sent(&relayd
->control_sock
);
873 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
875 ERR("Relayd streams sent failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
876 lttng_consumer_cleanup_relayd(relayd
);
880 ERR("Relayd ID %" PRIu64
" unknown. Can't send streams_sent.",
887 DBG("All streams sent relayd id %" PRIu64
, net_seq_idx
);
895 * Find a relayd and close the stream
897 void close_relayd_stream(struct lttng_consumer_stream
*stream
)
899 struct consumer_relayd_sock_pair
*relayd
;
901 /* The stream is not metadata. Get relayd reference if exists. */
903 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
905 consumer_stream_relayd_close(stream
, relayd
);
911 * Handle stream for relayd transmission if the stream applies for network
912 * streaming where the net sequence index is set.
914 * Return destination file descriptor or negative value on error.
916 static int write_relayd_stream_header(struct lttng_consumer_stream
*stream
,
917 size_t data_size
, unsigned long padding
,
918 struct consumer_relayd_sock_pair
*relayd
)
921 struct lttcomm_relayd_data_hdr data_hdr
;
927 /* Reset data header */
928 memset(&data_hdr
, 0, sizeof(data_hdr
));
930 if (stream
->metadata_flag
) {
931 /* Caller MUST acquire the relayd control socket lock */
932 ret
= relayd_send_metadata(&relayd
->control_sock
, data_size
);
937 /* Metadata are always sent on the control socket. */
938 outfd
= relayd
->control_sock
.sock
.fd
;
940 /* Set header with stream information */
941 data_hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
942 data_hdr
.data_size
= htobe32(data_size
);
943 data_hdr
.padding_size
= htobe32(padding
);
946 * Note that net_seq_num below is assigned with the *current* value of
947 * next_net_seq_num and only after that the next_net_seq_num will be
948 * increment. This is why when issuing a command on the relayd using
949 * this next value, 1 should always be substracted in order to compare
950 * the last seen sequence number on the relayd side to the last sent.
952 data_hdr
.net_seq_num
= htobe64(stream
->next_net_seq_num
);
953 /* Other fields are zeroed previously */
955 ret
= relayd_send_data_hdr(&relayd
->data_sock
, &data_hdr
,
961 ++stream
->next_net_seq_num
;
963 /* Set to go on data socket */
964 outfd
= relayd
->data_sock
.sock
.fd
;
972 * Trigger a dump of the metadata content. Following/during the succesful
973 * completion of this call, the metadata poll thread will start receiving
974 * metadata packets to consume.
976 * The caller must hold the channel and stream locks.
979 int consumer_metadata_stream_dump(struct lttng_consumer_stream
*stream
)
983 ASSERT_LOCKED(stream
->chan
->lock
);
984 ASSERT_LOCKED(stream
->lock
);
985 assert(stream
->metadata_flag
);
986 assert(stream
->chan
->trace_chunk
);
988 switch (consumer_data
.type
) {
989 case LTTNG_CONSUMER_KERNEL
:
991 * Reset the position of what has been read from the
992 * metadata cache to 0 so we can dump it again.
994 ret
= kernctl_metadata_cache_dump(stream
->wait_fd
);
996 case LTTNG_CONSUMER32_UST
:
997 case LTTNG_CONSUMER64_UST
:
999 * Reset the position pushed from the metadata cache so it
1000 * will write from the beginning on the next push.
1002 stream
->ust_metadata_pushed
= 0;
1003 ret
= consumer_metadata_wakeup_pipe(stream
->chan
);
1006 ERR("Unknown consumer_data type");
1010 ERR("Failed to dump the metadata cache");
1016 int lttng_consumer_channel_set_trace_chunk(
1017 struct lttng_consumer_channel
*channel
,
1018 struct lttng_trace_chunk
*new_trace_chunk
)
1020 pthread_mutex_lock(&channel
->lock
);
1021 if (channel
->is_deleted
) {
1023 * The channel has been logically deleted and should no longer
1024 * be used. It has released its reference to its current trace
1025 * chunk and should not acquire a new one.
1027 * Return success as there is nothing for the caller to do.
1033 * The acquisition of the reference cannot fail (barring
1034 * a severe internal error) since a reference to the published
1035 * chunk is already held by the caller.
1037 if (new_trace_chunk
) {
1038 const bool acquired_reference
= lttng_trace_chunk_get(
1041 assert(acquired_reference
);
1044 lttng_trace_chunk_put(channel
->trace_chunk
);
1045 channel
->trace_chunk
= new_trace_chunk
;
1047 pthread_mutex_unlock(&channel
->lock
);
1052 * Allocate and return a new lttng_consumer_channel object using the given key
1053 * to initialize the hash table node.
1055 * On error, return NULL.
1057 struct lttng_consumer_channel
*consumer_allocate_channel(uint64_t key
,
1058 uint64_t session_id
,
1059 const uint64_t *chunk_id
,
1060 const char *pathname
,
1063 enum lttng_event_output output
,
1064 uint64_t tracefile_size
,
1065 uint64_t tracefile_count
,
1066 uint64_t session_id_per_pid
,
1067 unsigned int monitor
,
1068 unsigned int live_timer_interval
,
1069 const char *root_shm_path
,
1070 const char *shm_path
)
1072 struct lttng_consumer_channel
*channel
= NULL
;
1073 struct lttng_trace_chunk
*trace_chunk
= NULL
;
1076 trace_chunk
= lttng_trace_chunk_registry_find_chunk(
1077 consumer_data
.chunk_registry
, session_id
,
1080 ERR("Failed to find trace chunk reference during creation of channel");
1085 channel
= zmalloc(sizeof(*channel
));
1086 if (channel
== NULL
) {
1087 PERROR("malloc struct lttng_consumer_channel");
1092 channel
->refcount
= 0;
1093 channel
->session_id
= session_id
;
1094 channel
->session_id_per_pid
= session_id_per_pid
;
1095 channel
->relayd_id
= relayd_id
;
1096 channel
->tracefile_size
= tracefile_size
;
1097 channel
->tracefile_count
= tracefile_count
;
1098 channel
->monitor
= monitor
;
1099 channel
->live_timer_interval
= live_timer_interval
;
1100 pthread_mutex_init(&channel
->lock
, NULL
);
1101 pthread_mutex_init(&channel
->timer_lock
, NULL
);
1104 case LTTNG_EVENT_SPLICE
:
1105 channel
->output
= CONSUMER_CHANNEL_SPLICE
;
1107 case LTTNG_EVENT_MMAP
:
1108 channel
->output
= CONSUMER_CHANNEL_MMAP
;
1118 * In monitor mode, the streams associated with the channel will be put in
1119 * a special list ONLY owned by this channel. So, the refcount is set to 1
1120 * here meaning that the channel itself has streams that are referenced.
1122 * On a channel deletion, once the channel is no longer visible, the
1123 * refcount is decremented and checked for a zero value to delete it. With
1124 * streams in no monitor mode, it will now be safe to destroy the channel.
1126 if (!channel
->monitor
) {
1127 channel
->refcount
= 1;
1130 strncpy(channel
->pathname
, pathname
, sizeof(channel
->pathname
));
1131 channel
->pathname
[sizeof(channel
->pathname
) - 1] = '\0';
1133 strncpy(channel
->name
, name
, sizeof(channel
->name
));
1134 channel
->name
[sizeof(channel
->name
) - 1] = '\0';
1136 if (root_shm_path
) {
1137 strncpy(channel
->root_shm_path
, root_shm_path
, sizeof(channel
->root_shm_path
));
1138 channel
->root_shm_path
[sizeof(channel
->root_shm_path
) - 1] = '\0';
1141 strncpy(channel
->shm_path
, shm_path
, sizeof(channel
->shm_path
));
1142 channel
->shm_path
[sizeof(channel
->shm_path
) - 1] = '\0';
1145 lttng_ht_node_init_u64(&channel
->node
, channel
->key
);
1146 lttng_ht_node_init_u64(&channel
->channels_by_session_id_ht_node
,
1147 channel
->session_id
);
1149 channel
->wait_fd
= -1;
1150 CDS_INIT_LIST_HEAD(&channel
->streams
.head
);
1153 int ret
= lttng_consumer_channel_set_trace_chunk(channel
,
1160 DBG("Allocated channel (key %" PRIu64
")", channel
->key
);
1163 lttng_trace_chunk_put(trace_chunk
);
1166 consumer_del_channel(channel
);
1172 * Add a channel to the global list protected by a mutex.
1174 * Always return 0 indicating success.
1176 int consumer_add_channel(struct lttng_consumer_channel
*channel
,
1177 struct lttng_consumer_local_data
*ctx
)
1179 pthread_mutex_lock(&consumer_data
.lock
);
1180 pthread_mutex_lock(&channel
->lock
);
1181 pthread_mutex_lock(&channel
->timer_lock
);
1184 * This gives us a guarantee that the channel we are about to add to the
1185 * channel hash table will be unique. See this function comment on the why
1186 * we need to steel the channel key at this stage.
1188 steal_channel_key(channel
->key
);
1191 lttng_ht_add_unique_u64(consumer_data
.channel_ht
, &channel
->node
);
1192 lttng_ht_add_u64(consumer_data
.channels_by_session_id_ht
,
1193 &channel
->channels_by_session_id_ht_node
);
1195 channel
->is_published
= true;
1197 pthread_mutex_unlock(&channel
->timer_lock
);
1198 pthread_mutex_unlock(&channel
->lock
);
1199 pthread_mutex_unlock(&consumer_data
.lock
);
1201 if (channel
->wait_fd
!= -1 && channel
->type
== CONSUMER_CHANNEL_TYPE_DATA
) {
1202 notify_channel_pipe(ctx
, channel
, -1, CONSUMER_CHANNEL_ADD
);
1209 * Allocate the pollfd structure and the local view of the out fds to avoid
1210 * doing a lookup in the linked list and concurrency issues when writing is
1211 * needed. Called with consumer_data.lock held.
1213 * Returns the number of fds in the structures.
1215 static int update_poll_array(struct lttng_consumer_local_data
*ctx
,
1216 struct pollfd
**pollfd
, struct lttng_consumer_stream
**local_stream
,
1217 struct lttng_ht
*ht
, int *nb_inactive_fd
)
1220 struct lttng_ht_iter iter
;
1221 struct lttng_consumer_stream
*stream
;
1226 assert(local_stream
);
1228 DBG("Updating poll fd array");
1229 *nb_inactive_fd
= 0;
1231 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1233 * Only active streams with an active end point can be added to the
1234 * poll set and local stream storage of the thread.
1236 * There is a potential race here for endpoint_status to be updated
1237 * just after the check. However, this is OK since the stream(s) will
1238 * be deleted once the thread is notified that the end point state has
1239 * changed where this function will be called back again.
1241 * We track the number of inactive FDs because they still need to be
1242 * closed by the polling thread after a wakeup on the data_pipe or
1245 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_INACTIVE
) {
1246 (*nb_inactive_fd
)++;
1250 * This clobbers way too much the debug output. Uncomment that if you
1251 * need it for debugging purposes.
1253 (*pollfd
)[i
].fd
= stream
->wait_fd
;
1254 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1255 local_stream
[i
] = stream
;
1261 * Insert the consumer_data_pipe at the end of the array and don't
1262 * increment i so nb_fd is the number of real FD.
1264 (*pollfd
)[i
].fd
= lttng_pipe_get_readfd(ctx
->consumer_data_pipe
);
1265 (*pollfd
)[i
].events
= POLLIN
| POLLPRI
;
1267 (*pollfd
)[i
+ 1].fd
= lttng_pipe_get_readfd(ctx
->consumer_wakeup_pipe
);
1268 (*pollfd
)[i
+ 1].events
= POLLIN
| POLLPRI
;
1273 * Poll on the should_quit pipe and the command socket return -1 on
1274 * error, 1 if should exit, 0 if data is available on the command socket
1276 int lttng_consumer_poll_socket(struct pollfd
*consumer_sockpoll
)
1281 num_rdy
= poll(consumer_sockpoll
, 2, -1);
1282 if (num_rdy
== -1) {
1284 * Restart interrupted system call.
1286 if (errno
== EINTR
) {
1289 PERROR("Poll error");
1292 if (consumer_sockpoll
[0].revents
& (POLLIN
| POLLPRI
)) {
1293 DBG("consumer_should_quit wake up");
1300 * Set the error socket.
1302 void lttng_consumer_set_error_sock(struct lttng_consumer_local_data
*ctx
,
1305 ctx
->consumer_error_socket
= sock
;
1309 * Set the command socket path.
1311 void lttng_consumer_set_command_sock_path(
1312 struct lttng_consumer_local_data
*ctx
, char *sock
)
1314 ctx
->consumer_command_sock_path
= sock
;
1318 * Send return code to the session daemon.
1319 * If the socket is not defined, we return 0, it is not a fatal error
1321 int lttng_consumer_send_error(struct lttng_consumer_local_data
*ctx
, int cmd
)
1323 if (ctx
->consumer_error_socket
> 0) {
1324 return lttcomm_send_unix_sock(ctx
->consumer_error_socket
, &cmd
,
1325 sizeof(enum lttcomm_sessiond_command
));
1332 * Close all the tracefiles and stream fds and MUST be called when all
1333 * instances are destroyed i.e. when all threads were joined and are ended.
1335 void lttng_consumer_cleanup(void)
1337 struct lttng_ht_iter iter
;
1338 struct lttng_consumer_channel
*channel
;
1339 unsigned int trace_chunks_left
;
1343 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
, channel
,
1345 consumer_del_channel(channel
);
1350 lttng_ht_destroy(consumer_data
.channel_ht
);
1351 lttng_ht_destroy(consumer_data
.channels_by_session_id_ht
);
1353 cleanup_relayd_ht();
1355 lttng_ht_destroy(consumer_data
.stream_per_chan_id_ht
);
1358 * This HT contains streams that are freed by either the metadata thread or
1359 * the data thread so we do *nothing* on the hash table and simply destroy
1362 lttng_ht_destroy(consumer_data
.stream_list_ht
);
1365 * Trace chunks in the registry may still exist if the session
1366 * daemon has encountered an internal error and could not
1367 * tear down its sessions and/or trace chunks properly.
1369 * Release the session daemon's implicit reference to any remaining
1370 * trace chunk and print an error if any trace chunk was found. Note
1371 * that there are _no_ legitimate cases for trace chunks to be left,
1372 * it is a leak. However, it can happen following a crash of the
1373 * session daemon and not emptying the registry would cause an assertion
1376 trace_chunks_left
= lttng_trace_chunk_registry_put_each_chunk(
1377 consumer_data
.chunk_registry
);
1378 if (trace_chunks_left
) {
1379 ERR("%u trace chunks are leaked by lttng-consumerd. "
1380 "This can be caused by an internal error of the session daemon.",
1383 /* Run all callbacks freeing each chunk. */
1385 lttng_trace_chunk_registry_destroy(consumer_data
.chunk_registry
);
1389 * Called from signal handler.
1391 void lttng_consumer_should_exit(struct lttng_consumer_local_data
*ctx
)
1395 CMM_STORE_SHARED(consumer_quit
, 1);
1396 ret
= lttng_write(ctx
->consumer_should_quit
[1], "4", 1);
1398 PERROR("write consumer quit");
1401 DBG("Consumer flag that it should quit");
1406 * Flush pending writes to trace output disk file.
1409 void lttng_consumer_sync_trace_file(struct lttng_consumer_stream
*stream
,
1413 int outfd
= stream
->out_fd
;
1416 * This does a blocking write-and-wait on any page that belongs to the
1417 * subbuffer prior to the one we just wrote.
1418 * Don't care about error values, as these are just hints and ways to
1419 * limit the amount of page cache used.
1421 if (orig_offset
< stream
->max_sb_size
) {
1424 lttng_sync_file_range(outfd
, orig_offset
- stream
->max_sb_size
,
1425 stream
->max_sb_size
,
1426 SYNC_FILE_RANGE_WAIT_BEFORE
1427 | SYNC_FILE_RANGE_WRITE
1428 | SYNC_FILE_RANGE_WAIT_AFTER
);
1430 * Give hints to the kernel about how we access the file:
1431 * POSIX_FADV_DONTNEED : we won't re-access data in a near future after
1434 * We need to call fadvise again after the file grows because the
1435 * kernel does not seem to apply fadvise to non-existing parts of the
1438 * Call fadvise _after_ having waited for the page writeback to
1439 * complete because the dirty page writeback semantic is not well
1440 * defined. So it can be expected to lead to lower throughput in
1443 ret
= posix_fadvise(outfd
, orig_offset
- stream
->max_sb_size
,
1444 stream
->max_sb_size
, POSIX_FADV_DONTNEED
);
1445 if (ret
&& ret
!= -ENOSYS
) {
1447 PERROR("posix_fadvise on fd %i", outfd
);
1452 * Initialise the necessary environnement :
1453 * - create a new context
1454 * - create the poll_pipe
1455 * - create the should_quit pipe (for signal handler)
1456 * - create the thread pipe (for splice)
1458 * Takes a function pointer as argument, this function is called when data is
1459 * available on a buffer. This function is responsible to do the
1460 * kernctl_get_next_subbuf, read the data with mmap or splice depending on the
1461 * buffer configuration and then kernctl_put_next_subbuf at the end.
1463 * Returns a pointer to the new context or NULL on error.
1465 struct lttng_consumer_local_data
*lttng_consumer_create(
1466 enum lttng_consumer_type type
,
1467 ssize_t (*buffer_ready
)(struct lttng_consumer_stream
*stream
,
1468 struct lttng_consumer_local_data
*ctx
),
1469 int (*recv_channel
)(struct lttng_consumer_channel
*channel
),
1470 int (*recv_stream
)(struct lttng_consumer_stream
*stream
),
1471 int (*update_stream
)(uint64_t stream_key
, uint32_t state
))
1474 struct lttng_consumer_local_data
*ctx
;
1476 assert(consumer_data
.type
== LTTNG_CONSUMER_UNKNOWN
||
1477 consumer_data
.type
== type
);
1478 consumer_data
.type
= type
;
1480 ctx
= zmalloc(sizeof(struct lttng_consumer_local_data
));
1482 PERROR("allocating context");
1486 ctx
->consumer_error_socket
= -1;
1487 ctx
->consumer_metadata_socket
= -1;
1488 pthread_mutex_init(&ctx
->metadata_socket_lock
, NULL
);
1489 /* assign the callbacks */
1490 ctx
->on_buffer_ready
= buffer_ready
;
1491 ctx
->on_recv_channel
= recv_channel
;
1492 ctx
->on_recv_stream
= recv_stream
;
1493 ctx
->on_update_stream
= update_stream
;
1495 ctx
->consumer_data_pipe
= lttng_pipe_open(0);
1496 if (!ctx
->consumer_data_pipe
) {
1497 goto error_poll_pipe
;
1500 ctx
->consumer_wakeup_pipe
= lttng_pipe_open(0);
1501 if (!ctx
->consumer_wakeup_pipe
) {
1502 goto error_wakeup_pipe
;
1505 ret
= pipe(ctx
->consumer_should_quit
);
1507 PERROR("Error creating recv pipe");
1508 goto error_quit_pipe
;
1511 ret
= pipe(ctx
->consumer_channel_pipe
);
1513 PERROR("Error creating channel pipe");
1514 goto error_channel_pipe
;
1517 ctx
->consumer_metadata_pipe
= lttng_pipe_open(0);
1518 if (!ctx
->consumer_metadata_pipe
) {
1519 goto error_metadata_pipe
;
1522 ctx
->channel_monitor_pipe
= -1;
1526 error_metadata_pipe
:
1527 utils_close_pipe(ctx
->consumer_channel_pipe
);
1529 utils_close_pipe(ctx
->consumer_should_quit
);
1531 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1533 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1541 * Iterate over all streams of the hashtable and free them properly.
1543 static void destroy_data_stream_ht(struct lttng_ht
*ht
)
1545 struct lttng_ht_iter iter
;
1546 struct lttng_consumer_stream
*stream
;
1553 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1555 * Ignore return value since we are currently cleaning up so any error
1558 (void) consumer_del_stream(stream
, ht
);
1562 lttng_ht_destroy(ht
);
1566 * Iterate over all streams of the metadata hashtable and free them
1569 static void destroy_metadata_stream_ht(struct lttng_ht
*ht
)
1571 struct lttng_ht_iter iter
;
1572 struct lttng_consumer_stream
*stream
;
1579 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, stream
, node
.node
) {
1581 * Ignore return value since we are currently cleaning up so any error
1584 (void) consumer_del_metadata_stream(stream
, ht
);
1588 lttng_ht_destroy(ht
);
1592 * Close all fds associated with the instance and free the context.
1594 void lttng_consumer_destroy(struct lttng_consumer_local_data
*ctx
)
1598 DBG("Consumer destroying it. Closing everything.");
1604 destroy_data_stream_ht(data_ht
);
1605 destroy_metadata_stream_ht(metadata_ht
);
1607 ret
= close(ctx
->consumer_error_socket
);
1611 ret
= close(ctx
->consumer_metadata_socket
);
1615 utils_close_pipe(ctx
->consumer_channel_pipe
);
1616 lttng_pipe_destroy(ctx
->consumer_data_pipe
);
1617 lttng_pipe_destroy(ctx
->consumer_metadata_pipe
);
1618 lttng_pipe_destroy(ctx
->consumer_wakeup_pipe
);
1619 utils_close_pipe(ctx
->consumer_should_quit
);
1621 unlink(ctx
->consumer_command_sock_path
);
1626 * Write the metadata stream id on the specified file descriptor.
1628 static int write_relayd_metadata_id(int fd
,
1629 struct lttng_consumer_stream
*stream
,
1630 unsigned long padding
)
1633 struct lttcomm_relayd_metadata_payload hdr
;
1635 hdr
.stream_id
= htobe64(stream
->relayd_stream_id
);
1636 hdr
.padding_size
= htobe32(padding
);
1637 ret
= lttng_write(fd
, (void *) &hdr
, sizeof(hdr
));
1638 if (ret
< sizeof(hdr
)) {
1640 * This error means that the fd's end is closed so ignore the PERROR
1641 * not to clubber the error output since this can happen in a normal
1644 if (errno
!= EPIPE
) {
1645 PERROR("write metadata stream id");
1647 DBG3("Consumer failed to write relayd metadata id (errno: %d)", errno
);
1649 * Set ret to a negative value because if ret != sizeof(hdr), we don't
1650 * handle writting the missing part so report that as an error and
1651 * don't lie to the caller.
1656 DBG("Metadata stream id %" PRIu64
" with padding %lu written before data",
1657 stream
->relayd_stream_id
, padding
);
1664 * Mmap the ring buffer, read it and write the data to the tracefile. This is a
1665 * core function for writing trace buffers to either the local filesystem or
1668 * It must be called with the stream and the channel lock held.
1670 * Careful review MUST be put if any changes occur!
1672 * Returns the number of bytes written
1674 ssize_t
lttng_consumer_on_read_subbuffer_mmap(
1675 struct lttng_consumer_local_data
*ctx
,
1676 struct lttng_consumer_stream
*stream
,
1677 const struct lttng_buffer_view
*buffer
,
1678 unsigned long padding
,
1679 struct ctf_packet_index
*index
)
1682 off_t orig_offset
= stream
->out_fd_offset
;
1683 /* Default is on the disk */
1684 int outfd
= stream
->out_fd
;
1685 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1686 unsigned int relayd_hang_up
= 0;
1687 const size_t subbuf_content_size
= buffer
->size
- padding
;
1690 /* RCU lock for the relayd pointer */
1692 assert(stream
->net_seq_idx
!= (uint64_t) -1ULL ||
1693 stream
->trace_chunk
);
1695 /* Flag that the current stream if set for network streaming. */
1696 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1697 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1698 if (relayd
== NULL
) {
1704 /* Handle stream on the relayd if the output is on the network */
1706 unsigned long netlen
= subbuf_content_size
;
1709 * Lock the control socket for the complete duration of the function
1710 * since from this point on we will use the socket.
1712 if (stream
->metadata_flag
) {
1713 /* Metadata requires the control socket. */
1714 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1715 if (stream
->reset_metadata_flag
) {
1716 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1717 stream
->relayd_stream_id
,
1718 stream
->metadata_version
);
1723 stream
->reset_metadata_flag
= 0;
1725 netlen
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1728 ret
= write_relayd_stream_header(stream
, netlen
, padding
, relayd
);
1733 /* Use the returned socket. */
1736 /* Write metadata stream id before payload */
1737 if (stream
->metadata_flag
) {
1738 ret
= write_relayd_metadata_id(outfd
, stream
, padding
);
1745 write_len
= subbuf_content_size
;
1747 /* No streaming; we have to write the full padding. */
1748 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1749 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1751 ERR("Reset metadata file");
1754 stream
->reset_metadata_flag
= 0;
1758 * Check if we need to change the tracefile before writing the packet.
1760 if (stream
->chan
->tracefile_size
> 0 &&
1761 (stream
->tracefile_size_current
+ buffer
->size
) >
1762 stream
->chan
->tracefile_size
) {
1763 ret
= consumer_stream_rotate_output_files(stream
);
1767 outfd
= stream
->out_fd
;
1770 stream
->tracefile_size_current
+= buffer
->size
;
1772 index
->offset
= htobe64(stream
->out_fd_offset
);
1775 write_len
= buffer
->size
;
1779 * This call guarantee that len or less is returned. It's impossible to
1780 * receive a ret value that is bigger than len.
1782 ret
= lttng_write(outfd
, buffer
->data
, write_len
);
1783 DBG("Consumer mmap write() ret %zd (len %lu)", ret
, write_len
);
1784 if (ret
< 0 || ((size_t) ret
!= write_len
)) {
1786 * Report error to caller if nothing was written else at least send the
1794 /* Socket operation failed. We consider the relayd dead */
1795 if (errno
== EPIPE
) {
1797 * This is possible if the fd is closed on the other side
1798 * (outfd) or any write problem. It can be verbose a bit for a
1799 * normal execution if for instance the relayd is stopped
1800 * abruptly. This can happen so set this to a DBG statement.
1802 DBG("Consumer mmap write detected relayd hang up");
1804 /* Unhandled error, print it and stop function right now. */
1805 PERROR("Error in write mmap (ret %zd != write_len %zu)", ret
,
1810 stream
->output_written
+= ret
;
1812 /* This call is useless on a socket so better save a syscall. */
1814 /* This won't block, but will start writeout asynchronously */
1815 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, write_len
,
1816 SYNC_FILE_RANGE_WRITE
);
1817 stream
->out_fd_offset
+= write_len
;
1818 lttng_consumer_sync_trace_file(stream
, orig_offset
);
1823 * This is a special case that the relayd has closed its socket. Let's
1824 * cleanup the relayd object and all associated streams.
1826 if (relayd
&& relayd_hang_up
) {
1827 ERR("Relayd hangup. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
1828 lttng_consumer_cleanup_relayd(relayd
);
1832 /* Unlock only if ctrl socket used */
1833 if (relayd
&& stream
->metadata_flag
) {
1834 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1842 * Splice the data from the ring buffer to the tracefile.
1844 * It must be called with the stream lock held.
1846 * Returns the number of bytes spliced.
1848 ssize_t
lttng_consumer_on_read_subbuffer_splice(
1849 struct lttng_consumer_local_data
*ctx
,
1850 struct lttng_consumer_stream
*stream
, unsigned long len
,
1851 unsigned long padding
,
1852 struct ctf_packet_index
*index
)
1854 ssize_t ret
= 0, written
= 0, ret_splice
= 0;
1856 off_t orig_offset
= stream
->out_fd_offset
;
1857 int fd
= stream
->wait_fd
;
1858 /* Default is on the disk */
1859 int outfd
= stream
->out_fd
;
1860 struct consumer_relayd_sock_pair
*relayd
= NULL
;
1862 unsigned int relayd_hang_up
= 0;
1864 switch (consumer_data
.type
) {
1865 case LTTNG_CONSUMER_KERNEL
:
1867 case LTTNG_CONSUMER32_UST
:
1868 case LTTNG_CONSUMER64_UST
:
1869 /* Not supported for user space tracing */
1872 ERR("Unknown consumer_data type");
1876 /* RCU lock for the relayd pointer */
1879 /* Flag that the current stream if set for network streaming. */
1880 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1881 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1882 if (relayd
== NULL
) {
1887 splice_pipe
= stream
->splice_pipe
;
1889 /* Write metadata stream id before payload */
1891 unsigned long total_len
= len
;
1893 if (stream
->metadata_flag
) {
1895 * Lock the control socket for the complete duration of the function
1896 * since from this point on we will use the socket.
1898 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1900 if (stream
->reset_metadata_flag
) {
1901 ret
= relayd_reset_metadata(&relayd
->control_sock
,
1902 stream
->relayd_stream_id
,
1903 stream
->metadata_version
);
1908 stream
->reset_metadata_flag
= 0;
1910 ret
= write_relayd_metadata_id(splice_pipe
[1], stream
,
1918 total_len
+= sizeof(struct lttcomm_relayd_metadata_payload
);
1921 ret
= write_relayd_stream_header(stream
, total_len
, padding
, relayd
);
1927 /* Use the returned socket. */
1930 /* No streaming, we have to set the len with the full padding */
1933 if (stream
->metadata_flag
&& stream
->reset_metadata_flag
) {
1934 ret
= utils_truncate_stream_file(stream
->out_fd
, 0);
1936 ERR("Reset metadata file");
1939 stream
->reset_metadata_flag
= 0;
1942 * Check if we need to change the tracefile before writing the packet.
1944 if (stream
->chan
->tracefile_size
> 0 &&
1945 (stream
->tracefile_size_current
+ len
) >
1946 stream
->chan
->tracefile_size
) {
1947 ret
= consumer_stream_rotate_output_files(stream
);
1952 outfd
= stream
->out_fd
;
1955 stream
->tracefile_size_current
+= len
;
1956 index
->offset
= htobe64(stream
->out_fd_offset
);
1960 DBG("splice chan to pipe offset %lu of len %lu (fd : %d, pipe: %d)",
1961 (unsigned long)offset
, len
, fd
, splice_pipe
[1]);
1962 ret_splice
= splice(fd
, &offset
, splice_pipe
[1], NULL
, len
,
1963 SPLICE_F_MOVE
| SPLICE_F_MORE
);
1964 DBG("splice chan to pipe, ret %zd", ret_splice
);
1965 if (ret_splice
< 0) {
1968 PERROR("Error in relay splice");
1972 /* Handle stream on the relayd if the output is on the network */
1973 if (relayd
&& stream
->metadata_flag
) {
1974 size_t metadata_payload_size
=
1975 sizeof(struct lttcomm_relayd_metadata_payload
);
1977 /* Update counter to fit the spliced data */
1978 ret_splice
+= metadata_payload_size
;
1979 len
+= metadata_payload_size
;
1981 * We do this so the return value can match the len passed as
1982 * argument to this function.
1984 written
-= metadata_payload_size
;
1987 /* Splice data out */
1988 ret_splice
= splice(splice_pipe
[0], NULL
, outfd
, NULL
,
1989 ret_splice
, SPLICE_F_MOVE
| SPLICE_F_MORE
);
1990 DBG("Consumer splice pipe to file (out_fd: %d), ret %zd",
1992 if (ret_splice
< 0) {
1997 } else if (ret_splice
> len
) {
1999 * We don't expect this code path to be executed but you never know
2000 * so this is an extra protection agains a buggy splice().
2003 written
+= ret_splice
;
2004 PERROR("Wrote more data than requested %zd (len: %lu)", ret_splice
,
2008 /* All good, update current len and continue. */
2012 /* This call is useless on a socket so better save a syscall. */
2014 /* This won't block, but will start writeout asynchronously */
2015 lttng_sync_file_range(outfd
, stream
->out_fd_offset
, ret_splice
,
2016 SYNC_FILE_RANGE_WRITE
);
2017 stream
->out_fd_offset
+= ret_splice
;
2019 stream
->output_written
+= ret_splice
;
2020 written
+= ret_splice
;
2023 lttng_consumer_sync_trace_file(stream
, orig_offset
);
2029 * This is a special case that the relayd has closed its socket. Let's
2030 * cleanup the relayd object and all associated streams.
2032 if (relayd
&& relayd_hang_up
) {
2033 ERR("Relayd hangup. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
2034 lttng_consumer_cleanup_relayd(relayd
);
2035 /* Skip splice error so the consumer does not fail */
2040 /* send the appropriate error description to sessiond */
2043 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_EINVAL
);
2046 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ENOMEM
);
2049 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_SPLICE_ESPIPE
);
2054 if (relayd
&& stream
->metadata_flag
) {
2055 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
2063 * Sample the snapshot positions for a specific fd
2065 * Returns 0 on success, < 0 on error
2067 int lttng_consumer_sample_snapshot_positions(struct lttng_consumer_stream
*stream
)
2069 switch (consumer_data
.type
) {
2070 case LTTNG_CONSUMER_KERNEL
:
2071 return lttng_kconsumer_sample_snapshot_positions(stream
);
2072 case LTTNG_CONSUMER32_UST
:
2073 case LTTNG_CONSUMER64_UST
:
2074 return lttng_ustconsumer_sample_snapshot_positions(stream
);
2076 ERR("Unknown consumer_data type");
2082 * Take a snapshot for a specific fd
2084 * Returns 0 on success, < 0 on error
2086 int lttng_consumer_take_snapshot(struct lttng_consumer_stream
*stream
)
2088 switch (consumer_data
.type
) {
2089 case LTTNG_CONSUMER_KERNEL
:
2090 return lttng_kconsumer_take_snapshot(stream
);
2091 case LTTNG_CONSUMER32_UST
:
2092 case LTTNG_CONSUMER64_UST
:
2093 return lttng_ustconsumer_take_snapshot(stream
);
2095 ERR("Unknown consumer_data type");
2102 * Get the produced position
2104 * Returns 0 on success, < 0 on error
2106 int lttng_consumer_get_produced_snapshot(struct lttng_consumer_stream
*stream
,
2109 switch (consumer_data
.type
) {
2110 case LTTNG_CONSUMER_KERNEL
:
2111 return lttng_kconsumer_get_produced_snapshot(stream
, pos
);
2112 case LTTNG_CONSUMER32_UST
:
2113 case LTTNG_CONSUMER64_UST
:
2114 return lttng_ustconsumer_get_produced_snapshot(stream
, pos
);
2116 ERR("Unknown consumer_data type");
2123 * Get the consumed position (free-running counter position in bytes).
2125 * Returns 0 on success, < 0 on error
2127 int lttng_consumer_get_consumed_snapshot(struct lttng_consumer_stream
*stream
,
2130 switch (consumer_data
.type
) {
2131 case LTTNG_CONSUMER_KERNEL
:
2132 return lttng_kconsumer_get_consumed_snapshot(stream
, pos
);
2133 case LTTNG_CONSUMER32_UST
:
2134 case LTTNG_CONSUMER64_UST
:
2135 return lttng_ustconsumer_get_consumed_snapshot(stream
, pos
);
2137 ERR("Unknown consumer_data type");
2143 int lttng_consumer_recv_cmd(struct lttng_consumer_local_data
*ctx
,
2144 int sock
, struct pollfd
*consumer_sockpoll
)
2146 switch (consumer_data
.type
) {
2147 case LTTNG_CONSUMER_KERNEL
:
2148 return lttng_kconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2149 case LTTNG_CONSUMER32_UST
:
2150 case LTTNG_CONSUMER64_UST
:
2151 return lttng_ustconsumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
2153 ERR("Unknown consumer_data type");
2160 void lttng_consumer_close_all_metadata(void)
2162 switch (consumer_data
.type
) {
2163 case LTTNG_CONSUMER_KERNEL
:
2165 * The Kernel consumer has a different metadata scheme so we don't
2166 * close anything because the stream will be closed by the session
2170 case LTTNG_CONSUMER32_UST
:
2171 case LTTNG_CONSUMER64_UST
:
2173 * Close all metadata streams. The metadata hash table is passed and
2174 * this call iterates over it by closing all wakeup fd. This is safe
2175 * because at this point we are sure that the metadata producer is
2176 * either dead or blocked.
2178 lttng_ustconsumer_close_all_metadata(metadata_ht
);
2181 ERR("Unknown consumer_data type");
2187 * Clean up a metadata stream and free its memory.
2189 void consumer_del_metadata_stream(struct lttng_consumer_stream
*stream
,
2190 struct lttng_ht
*ht
)
2192 struct lttng_consumer_channel
*channel
= NULL
;
2193 bool free_channel
= false;
2197 * This call should NEVER receive regular stream. It must always be
2198 * metadata stream and this is crucial for data structure synchronization.
2200 assert(stream
->metadata_flag
);
2202 DBG3("Consumer delete metadata stream %d", stream
->wait_fd
);
2204 pthread_mutex_lock(&consumer_data
.lock
);
2206 * Note that this assumes that a stream's channel is never changed and
2207 * that the stream's lock doesn't need to be taken to sample its
2210 channel
= stream
->chan
;
2211 pthread_mutex_lock(&channel
->lock
);
2212 pthread_mutex_lock(&stream
->lock
);
2213 if (channel
->metadata_cache
) {
2214 /* Only applicable to userspace consumers. */
2215 pthread_mutex_lock(&channel
->metadata_cache
->lock
);
2218 /* Remove any reference to that stream. */
2219 consumer_stream_delete(stream
, ht
);
2221 /* Close down everything including the relayd if one. */
2222 consumer_stream_close(stream
);
2223 /* Destroy tracer buffers of the stream. */
2224 consumer_stream_destroy_buffers(stream
);
2226 /* Atomically decrement channel refcount since other threads can use it. */
2227 if (!uatomic_sub_return(&channel
->refcount
, 1)
2228 && !uatomic_read(&channel
->nb_init_stream_left
)) {
2229 /* Go for channel deletion! */
2230 free_channel
= true;
2232 stream
->chan
= NULL
;
2235 * Nullify the stream reference so it is not used after deletion. The
2236 * channel lock MUST be acquired before being able to check for a NULL
2239 channel
->metadata_stream
= NULL
;
2241 if (channel
->metadata_cache
) {
2242 pthread_mutex_unlock(&channel
->metadata_cache
->lock
);
2244 pthread_mutex_unlock(&stream
->lock
);
2245 pthread_mutex_unlock(&channel
->lock
);
2246 pthread_mutex_unlock(&consumer_data
.lock
);
2249 consumer_del_channel(channel
);
2252 lttng_trace_chunk_put(stream
->trace_chunk
);
2253 stream
->trace_chunk
= NULL
;
2254 consumer_stream_free(stream
);
2258 * Action done with the metadata stream when adding it to the consumer internal
2259 * data structures to handle it.
2261 void consumer_add_metadata_stream(struct lttng_consumer_stream
*stream
)
2263 struct lttng_ht
*ht
= metadata_ht
;
2264 struct lttng_ht_iter iter
;
2265 struct lttng_ht_node_u64
*node
;
2270 DBG3("Adding metadata stream %" PRIu64
" to hash table", stream
->key
);
2272 pthread_mutex_lock(&consumer_data
.lock
);
2273 pthread_mutex_lock(&stream
->chan
->lock
);
2274 pthread_mutex_lock(&stream
->chan
->timer_lock
);
2275 pthread_mutex_lock(&stream
->lock
);
2278 * From here, refcounts are updated so be _careful_ when returning an error
2285 * Lookup the stream just to make sure it does not exist in our internal
2286 * state. This should NEVER happen.
2288 lttng_ht_lookup(ht
, &stream
->key
, &iter
);
2289 node
= lttng_ht_iter_get_node_u64(&iter
);
2293 * When nb_init_stream_left reaches 0, we don't need to trigger any action
2294 * in terms of destroying the associated channel, because the action that
2295 * causes the count to become 0 also causes a stream to be added. The
2296 * channel deletion will thus be triggered by the following removal of this
2299 if (uatomic_read(&stream
->chan
->nb_init_stream_left
) > 0) {
2300 /* Increment refcount before decrementing nb_init_stream_left */
2302 uatomic_dec(&stream
->chan
->nb_init_stream_left
);
2305 lttng_ht_add_unique_u64(ht
, &stream
->node
);
2307 lttng_ht_add_u64(consumer_data
.stream_per_chan_id_ht
,
2308 &stream
->node_channel_id
);
2311 * Add stream to the stream_list_ht of the consumer data. No need to steal
2312 * the key since the HT does not use it and we allow to add redundant keys
2315 lttng_ht_add_u64(consumer_data
.stream_list_ht
, &stream
->node_session_id
);
2319 pthread_mutex_unlock(&stream
->lock
);
2320 pthread_mutex_unlock(&stream
->chan
->lock
);
2321 pthread_mutex_unlock(&stream
->chan
->timer_lock
);
2322 pthread_mutex_unlock(&consumer_data
.lock
);
2326 * Delete data stream that are flagged for deletion (endpoint_status).
2328 static void validate_endpoint_status_data_stream(void)
2330 struct lttng_ht_iter iter
;
2331 struct lttng_consumer_stream
*stream
;
2333 DBG("Consumer delete flagged data stream");
2336 cds_lfht_for_each_entry(data_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2337 /* Validate delete flag of the stream */
2338 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2341 /* Delete it right now */
2342 consumer_del_stream(stream
, data_ht
);
2348 * Delete metadata stream that are flagged for deletion (endpoint_status).
2350 static void validate_endpoint_status_metadata_stream(
2351 struct lttng_poll_event
*pollset
)
2353 struct lttng_ht_iter iter
;
2354 struct lttng_consumer_stream
*stream
;
2356 DBG("Consumer delete flagged metadata stream");
2361 cds_lfht_for_each_entry(metadata_ht
->ht
, &iter
.iter
, stream
, node
.node
) {
2362 /* Validate delete flag of the stream */
2363 if (stream
->endpoint_status
== CONSUMER_ENDPOINT_ACTIVE
) {
2367 * Remove from pollset so the metadata thread can continue without
2368 * blocking on a deleted stream.
2370 lttng_poll_del(pollset
, stream
->wait_fd
);
2372 /* Delete it right now */
2373 consumer_del_metadata_stream(stream
, metadata_ht
);
2379 * Thread polls on metadata file descriptor and write them on disk or on the
2382 void *consumer_thread_metadata_poll(void *data
)
2384 int ret
, i
, pollfd
, err
= -1;
2385 uint32_t revents
, nb_fd
;
2386 struct lttng_consumer_stream
*stream
= NULL
;
2387 struct lttng_ht_iter iter
;
2388 struct lttng_ht_node_u64
*node
;
2389 struct lttng_poll_event events
;
2390 struct lttng_consumer_local_data
*ctx
= data
;
2393 rcu_register_thread();
2395 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_METADATA
);
2397 if (testpoint(consumerd_thread_metadata
)) {
2398 goto error_testpoint
;
2401 health_code_update();
2403 DBG("Thread metadata poll started");
2405 /* Size is set to 1 for the consumer_metadata pipe */
2406 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2408 ERR("Poll set creation failed");
2412 ret
= lttng_poll_add(&events
,
2413 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
), LPOLLIN
);
2419 DBG("Metadata main loop started");
2423 health_code_update();
2424 health_poll_entry();
2425 DBG("Metadata poll wait");
2426 ret
= lttng_poll_wait(&events
, -1);
2427 DBG("Metadata poll return from wait with %d fd(s)",
2428 LTTNG_POLL_GETNB(&events
));
2430 DBG("Metadata event caught in thread");
2432 if (errno
== EINTR
) {
2433 ERR("Poll EINTR caught");
2436 if (LTTNG_POLL_GETNB(&events
) == 0) {
2437 err
= 0; /* All is OK */
2444 /* From here, the event is a metadata wait fd */
2445 for (i
= 0; i
< nb_fd
; i
++) {
2446 health_code_update();
2448 revents
= LTTNG_POLL_GETEV(&events
, i
);
2449 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
2451 if (pollfd
== lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
)) {
2452 if (revents
& LPOLLIN
) {
2455 pipe_len
= lttng_pipe_read(ctx
->consumer_metadata_pipe
,
2456 &stream
, sizeof(stream
));
2457 if (pipe_len
< sizeof(stream
)) {
2459 PERROR("read metadata stream");
2462 * Remove the pipe from the poll set and continue the loop
2463 * since their might be data to consume.
2465 lttng_poll_del(&events
,
2466 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2467 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2471 /* A NULL stream means that the state has changed. */
2472 if (stream
== NULL
) {
2473 /* Check for deleted streams. */
2474 validate_endpoint_status_metadata_stream(&events
);
2478 DBG("Adding metadata stream %d to poll set",
2481 /* Add metadata stream to the global poll events list */
2482 lttng_poll_add(&events
, stream
->wait_fd
,
2483 LPOLLIN
| LPOLLPRI
| LPOLLHUP
);
2484 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2485 DBG("Metadata thread pipe hung up");
2487 * Remove the pipe from the poll set and continue the loop
2488 * since their might be data to consume.
2490 lttng_poll_del(&events
,
2491 lttng_pipe_get_readfd(ctx
->consumer_metadata_pipe
));
2492 lttng_pipe_read_close(ctx
->consumer_metadata_pipe
);
2495 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2499 /* Handle other stream */
2505 uint64_t tmp_id
= (uint64_t) pollfd
;
2507 lttng_ht_lookup(metadata_ht
, &tmp_id
, &iter
);
2509 node
= lttng_ht_iter_get_node_u64(&iter
);
2512 stream
= caa_container_of(node
, struct lttng_consumer_stream
,
2515 if (revents
& (LPOLLIN
| LPOLLPRI
)) {
2516 /* Get the data out of the metadata file descriptor */
2517 DBG("Metadata available on fd %d", pollfd
);
2518 assert(stream
->wait_fd
== pollfd
);
2521 health_code_update();
2523 len
= ctx
->on_buffer_ready(stream
, ctx
);
2525 * We don't check the return value here since if we get
2526 * a negative len, it means an error occurred thus we
2527 * simply remove it from the poll set and free the
2532 /* It's ok to have an unavailable sub-buffer */
2533 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2534 /* Clean up stream from consumer and free it. */
2535 lttng_poll_del(&events
, stream
->wait_fd
);
2536 consumer_del_metadata_stream(stream
, metadata_ht
);
2538 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
2539 DBG("Metadata fd %d is hup|err.", pollfd
);
2540 if (!stream
->hangup_flush_done
2541 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2542 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2543 DBG("Attempting to flush and consume the UST buffers");
2544 lttng_ustconsumer_on_stream_hangup(stream
);
2546 /* We just flushed the stream now read it. */
2548 health_code_update();
2550 len
= ctx
->on_buffer_ready(stream
, ctx
);
2552 * We don't check the return value here since if we get
2553 * a negative len, it means an error occurred thus we
2554 * simply remove it from the poll set and free the
2560 lttng_poll_del(&events
, stream
->wait_fd
);
2562 * This call update the channel states, closes file descriptors
2563 * and securely free the stream.
2565 consumer_del_metadata_stream(stream
, metadata_ht
);
2567 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
2571 /* Release RCU lock for the stream looked up */
2579 DBG("Metadata poll thread exiting");
2581 lttng_poll_clean(&events
);
2586 ERR("Health error occurred in %s", __func__
);
2588 health_unregister(health_consumerd
);
2589 rcu_unregister_thread();
2594 * This thread polls the fds in the set to consume the data and write
2595 * it to tracefile if necessary.
2597 void *consumer_thread_data_poll(void *data
)
2599 int num_rdy
, num_hup
, high_prio
, ret
, i
, err
= -1;
2600 struct pollfd
*pollfd
= NULL
;
2601 /* local view of the streams */
2602 struct lttng_consumer_stream
**local_stream
= NULL
, *new_stream
= NULL
;
2603 /* local view of consumer_data.fds_count */
2605 /* 2 for the consumer_data_pipe and wake up pipe */
2606 const int nb_pipes_fd
= 2;
2607 /* Number of FDs with CONSUMER_ENDPOINT_INACTIVE but still open. */
2608 int nb_inactive_fd
= 0;
2609 struct lttng_consumer_local_data
*ctx
= data
;
2612 rcu_register_thread();
2614 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_DATA
);
2616 if (testpoint(consumerd_thread_data
)) {
2617 goto error_testpoint
;
2620 health_code_update();
2622 local_stream
= zmalloc(sizeof(struct lttng_consumer_stream
*));
2623 if (local_stream
== NULL
) {
2624 PERROR("local_stream malloc");
2629 health_code_update();
2635 * the fds set has been updated, we need to update our
2636 * local array as well
2638 pthread_mutex_lock(&consumer_data
.lock
);
2639 if (consumer_data
.need_update
) {
2644 local_stream
= NULL
;
2646 /* Allocate for all fds */
2647 pollfd
= zmalloc((consumer_data
.stream_count
+ nb_pipes_fd
) * sizeof(struct pollfd
));
2648 if (pollfd
== NULL
) {
2649 PERROR("pollfd malloc");
2650 pthread_mutex_unlock(&consumer_data
.lock
);
2654 local_stream
= zmalloc((consumer_data
.stream_count
+ nb_pipes_fd
) *
2655 sizeof(struct lttng_consumer_stream
*));
2656 if (local_stream
== NULL
) {
2657 PERROR("local_stream malloc");
2658 pthread_mutex_unlock(&consumer_data
.lock
);
2661 ret
= update_poll_array(ctx
, &pollfd
, local_stream
,
2662 data_ht
, &nb_inactive_fd
);
2664 ERR("Error in allocating pollfd or local_outfds");
2665 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2666 pthread_mutex_unlock(&consumer_data
.lock
);
2670 consumer_data
.need_update
= 0;
2672 pthread_mutex_unlock(&consumer_data
.lock
);
2674 /* No FDs and consumer_quit, consumer_cleanup the thread */
2675 if (nb_fd
== 0 && nb_inactive_fd
== 0 &&
2676 CMM_LOAD_SHARED(consumer_quit
) == 1) {
2677 err
= 0; /* All is OK */
2680 /* poll on the array of fds */
2682 DBG("polling on %d fd", nb_fd
+ nb_pipes_fd
);
2683 if (testpoint(consumerd_thread_data_poll
)) {
2686 health_poll_entry();
2687 num_rdy
= poll(pollfd
, nb_fd
+ nb_pipes_fd
, -1);
2689 DBG("poll num_rdy : %d", num_rdy
);
2690 if (num_rdy
== -1) {
2692 * Restart interrupted system call.
2694 if (errno
== EINTR
) {
2697 PERROR("Poll error");
2698 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
2700 } else if (num_rdy
== 0) {
2701 DBG("Polling thread timed out");
2705 if (caa_unlikely(data_consumption_paused
)) {
2706 DBG("Data consumption paused, sleeping...");
2712 * If the consumer_data_pipe triggered poll go directly to the
2713 * beginning of the loop to update the array. We want to prioritize
2714 * array update over low-priority reads.
2716 if (pollfd
[nb_fd
].revents
& (POLLIN
| POLLPRI
)) {
2717 ssize_t pipe_readlen
;
2719 DBG("consumer_data_pipe wake up");
2720 pipe_readlen
= lttng_pipe_read(ctx
->consumer_data_pipe
,
2721 &new_stream
, sizeof(new_stream
));
2722 if (pipe_readlen
< sizeof(new_stream
)) {
2723 PERROR("Consumer data pipe");
2724 /* Continue so we can at least handle the current stream(s). */
2729 * If the stream is NULL, just ignore it. It's also possible that
2730 * the sessiond poll thread changed the consumer_quit state and is
2731 * waking us up to test it.
2733 if (new_stream
== NULL
) {
2734 validate_endpoint_status_data_stream();
2738 /* Continue to update the local streams and handle prio ones */
2742 /* Handle wakeup pipe. */
2743 if (pollfd
[nb_fd
+ 1].revents
& (POLLIN
| POLLPRI
)) {
2745 ssize_t pipe_readlen
;
2747 pipe_readlen
= lttng_pipe_read(ctx
->consumer_wakeup_pipe
, &dummy
,
2749 if (pipe_readlen
< 0) {
2750 PERROR("Consumer data wakeup pipe");
2752 /* We've been awakened to handle stream(s). */
2753 ctx
->has_wakeup
= 0;
2756 /* Take care of high priority channels first. */
2757 for (i
= 0; i
< nb_fd
; i
++) {
2758 health_code_update();
2760 if (local_stream
[i
] == NULL
) {
2763 if (pollfd
[i
].revents
& POLLPRI
) {
2764 DBG("Urgent read on fd %d", pollfd
[i
].fd
);
2766 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2767 /* it's ok to have an unavailable sub-buffer */
2768 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2769 /* Clean the stream and free it. */
2770 consumer_del_stream(local_stream
[i
], data_ht
);
2771 local_stream
[i
] = NULL
;
2772 } else if (len
> 0) {
2773 local_stream
[i
]->data_read
= 1;
2779 * If we read high prio channel in this loop, try again
2780 * for more high prio data.
2786 /* Take care of low priority channels. */
2787 for (i
= 0; i
< nb_fd
; i
++) {
2788 health_code_update();
2790 if (local_stream
[i
] == NULL
) {
2793 if ((pollfd
[i
].revents
& POLLIN
) ||
2794 local_stream
[i
]->hangup_flush_done
||
2795 local_stream
[i
]->has_data
) {
2796 DBG("Normal read on fd %d", pollfd
[i
].fd
);
2797 len
= ctx
->on_buffer_ready(local_stream
[i
], ctx
);
2798 /* it's ok to have an unavailable sub-buffer */
2799 if (len
< 0 && len
!= -EAGAIN
&& len
!= -ENODATA
) {
2800 /* Clean the stream and free it. */
2801 consumer_del_stream(local_stream
[i
], data_ht
);
2802 local_stream
[i
] = NULL
;
2803 } else if (len
> 0) {
2804 local_stream
[i
]->data_read
= 1;
2809 /* Handle hangup and errors */
2810 for (i
= 0; i
< nb_fd
; i
++) {
2811 health_code_update();
2813 if (local_stream
[i
] == NULL
) {
2816 if (!local_stream
[i
]->hangup_flush_done
2817 && (pollfd
[i
].revents
& (POLLHUP
| POLLERR
| POLLNVAL
))
2818 && (consumer_data
.type
== LTTNG_CONSUMER32_UST
2819 || consumer_data
.type
== LTTNG_CONSUMER64_UST
)) {
2820 DBG("fd %d is hup|err|nval. Attempting flush and read.",
2822 lttng_ustconsumer_on_stream_hangup(local_stream
[i
]);
2823 /* Attempt read again, for the data we just flushed. */
2824 local_stream
[i
]->data_read
= 1;
2827 * If the poll flag is HUP/ERR/NVAL and we have
2828 * read no data in this pass, we can remove the
2829 * stream from its hash table.
2831 if ((pollfd
[i
].revents
& POLLHUP
)) {
2832 DBG("Polling fd %d tells it has hung up.", pollfd
[i
].fd
);
2833 if (!local_stream
[i
]->data_read
) {
2834 consumer_del_stream(local_stream
[i
], data_ht
);
2835 local_stream
[i
] = NULL
;
2838 } else if (pollfd
[i
].revents
& POLLERR
) {
2839 ERR("Error returned in polling fd %d.", pollfd
[i
].fd
);
2840 if (!local_stream
[i
]->data_read
) {
2841 consumer_del_stream(local_stream
[i
], data_ht
);
2842 local_stream
[i
] = NULL
;
2845 } else if (pollfd
[i
].revents
& POLLNVAL
) {
2846 ERR("Polling fd %d tells fd is not open.", pollfd
[i
].fd
);
2847 if (!local_stream
[i
]->data_read
) {
2848 consumer_del_stream(local_stream
[i
], data_ht
);
2849 local_stream
[i
] = NULL
;
2853 if (local_stream
[i
] != NULL
) {
2854 local_stream
[i
]->data_read
= 0;
2861 DBG("polling thread exiting");
2866 * Close the write side of the pipe so epoll_wait() in
2867 * consumer_thread_metadata_poll can catch it. The thread is monitoring the
2868 * read side of the pipe. If we close them both, epoll_wait strangely does
2869 * not return and could create a endless wait period if the pipe is the
2870 * only tracked fd in the poll set. The thread will take care of closing
2873 (void) lttng_pipe_write_close(ctx
->consumer_metadata_pipe
);
2878 ERR("Health error occurred in %s", __func__
);
2880 health_unregister(health_consumerd
);
2882 rcu_unregister_thread();
2887 * Close wake-up end of each stream belonging to the channel. This will
2888 * allow the poll() on the stream read-side to detect when the
2889 * write-side (application) finally closes them.
2892 void consumer_close_channel_streams(struct lttng_consumer_channel
*channel
)
2894 struct lttng_ht
*ht
;
2895 struct lttng_consumer_stream
*stream
;
2896 struct lttng_ht_iter iter
;
2898 ht
= consumer_data
.stream_per_chan_id_ht
;
2901 cds_lfht_for_each_entry_duplicate(ht
->ht
,
2902 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
2903 ht
->match_fct
, &channel
->key
,
2904 &iter
.iter
, stream
, node_channel_id
.node
) {
2906 * Protect against teardown with mutex.
2908 pthread_mutex_lock(&stream
->lock
);
2909 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
2912 switch (consumer_data
.type
) {
2913 case LTTNG_CONSUMER_KERNEL
:
2915 case LTTNG_CONSUMER32_UST
:
2916 case LTTNG_CONSUMER64_UST
:
2917 if (stream
->metadata_flag
) {
2918 /* Safe and protected by the stream lock. */
2919 lttng_ustconsumer_close_metadata(stream
->chan
);
2922 * Note: a mutex is taken internally within
2923 * liblttng-ust-ctl to protect timer wakeup_fd
2924 * use from concurrent close.
2926 lttng_ustconsumer_close_stream_wakeup(stream
);
2930 ERR("Unknown consumer_data type");
2934 pthread_mutex_unlock(&stream
->lock
);
2939 static void destroy_channel_ht(struct lttng_ht
*ht
)
2941 struct lttng_ht_iter iter
;
2942 struct lttng_consumer_channel
*channel
;
2950 cds_lfht_for_each_entry(ht
->ht
, &iter
.iter
, channel
, wait_fd_node
.node
) {
2951 ret
= lttng_ht_del(ht
, &iter
);
2956 lttng_ht_destroy(ht
);
2960 * This thread polls the channel fds to detect when they are being
2961 * closed. It closes all related streams if the channel is detected as
2962 * closed. It is currently only used as a shim layer for UST because the
2963 * consumerd needs to keep the per-stream wakeup end of pipes open for
2966 void *consumer_thread_channel_poll(void *data
)
2968 int ret
, i
, pollfd
, err
= -1;
2969 uint32_t revents
, nb_fd
;
2970 struct lttng_consumer_channel
*chan
= NULL
;
2971 struct lttng_ht_iter iter
;
2972 struct lttng_ht_node_u64
*node
;
2973 struct lttng_poll_event events
;
2974 struct lttng_consumer_local_data
*ctx
= data
;
2975 struct lttng_ht
*channel_ht
;
2977 rcu_register_thread();
2979 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_CHANNEL
);
2981 if (testpoint(consumerd_thread_channel
)) {
2982 goto error_testpoint
;
2985 health_code_update();
2987 channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
2989 /* ENOMEM at this point. Better to bail out. */
2993 DBG("Thread channel poll started");
2995 /* Size is set to 1 for the consumer_channel pipe */
2996 ret
= lttng_poll_create(&events
, 2, LTTNG_CLOEXEC
);
2998 ERR("Poll set creation failed");
3002 ret
= lttng_poll_add(&events
, ctx
->consumer_channel_pipe
[0], LPOLLIN
);
3008 DBG("Channel main loop started");
3012 health_code_update();
3013 DBG("Channel poll wait");
3014 health_poll_entry();
3015 ret
= lttng_poll_wait(&events
, -1);
3016 DBG("Channel poll return from wait with %d fd(s)",
3017 LTTNG_POLL_GETNB(&events
));
3019 DBG("Channel event caught in thread");
3021 if (errno
== EINTR
) {
3022 ERR("Poll EINTR caught");
3025 if (LTTNG_POLL_GETNB(&events
) == 0) {
3026 err
= 0; /* All is OK */
3033 /* From here, the event is a channel wait fd */
3034 for (i
= 0; i
< nb_fd
; i
++) {
3035 health_code_update();
3037 revents
= LTTNG_POLL_GETEV(&events
, i
);
3038 pollfd
= LTTNG_POLL_GETFD(&events
, i
);
3040 if (pollfd
== ctx
->consumer_channel_pipe
[0]) {
3041 if (revents
& LPOLLIN
) {
3042 enum consumer_channel_action action
;
3045 ret
= read_channel_pipe(ctx
, &chan
, &key
, &action
);
3048 ERR("Error reading channel pipe");
3050 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3055 case CONSUMER_CHANNEL_ADD
:
3056 DBG("Adding channel %d to poll set",
3059 lttng_ht_node_init_u64(&chan
->wait_fd_node
,
3062 lttng_ht_add_unique_u64(channel_ht
,
3063 &chan
->wait_fd_node
);
3065 /* Add channel to the global poll events list */
3066 lttng_poll_add(&events
, chan
->wait_fd
,
3067 LPOLLERR
| LPOLLHUP
);
3069 case CONSUMER_CHANNEL_DEL
:
3072 * This command should never be called if the channel
3073 * has streams monitored by either the data or metadata
3074 * thread. The consumer only notify this thread with a
3075 * channel del. command if it receives a destroy
3076 * channel command from the session daemon that send it
3077 * if a command prior to the GET_CHANNEL failed.
3081 chan
= consumer_find_channel(key
);
3084 ERR("UST consumer get channel key %" PRIu64
" not found for del channel", key
);
3087 lttng_poll_del(&events
, chan
->wait_fd
);
3088 iter
.iter
.node
= &chan
->wait_fd_node
.node
;
3089 ret
= lttng_ht_del(channel_ht
, &iter
);
3092 switch (consumer_data
.type
) {
3093 case LTTNG_CONSUMER_KERNEL
:
3095 case LTTNG_CONSUMER32_UST
:
3096 case LTTNG_CONSUMER64_UST
:
3097 health_code_update();
3098 /* Destroy streams that might have been left in the stream list. */
3099 clean_channel_stream_list(chan
);
3102 ERR("Unknown consumer_data type");
3107 * Release our own refcount. Force channel deletion even if
3108 * streams were not initialized.
3110 if (!uatomic_sub_return(&chan
->refcount
, 1)) {
3111 consumer_del_channel(chan
);
3116 case CONSUMER_CHANNEL_QUIT
:
3118 * Remove the pipe from the poll set and continue the loop
3119 * since their might be data to consume.
3121 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3124 ERR("Unknown action");
3127 } else if (revents
& (LPOLLERR
| LPOLLHUP
)) {
3128 DBG("Channel thread pipe hung up");
3130 * Remove the pipe from the poll set and continue the loop
3131 * since their might be data to consume.
3133 lttng_poll_del(&events
, ctx
->consumer_channel_pipe
[0]);
3136 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3140 /* Handle other stream */
3146 uint64_t tmp_id
= (uint64_t) pollfd
;
3148 lttng_ht_lookup(channel_ht
, &tmp_id
, &iter
);
3150 node
= lttng_ht_iter_get_node_u64(&iter
);
3153 chan
= caa_container_of(node
, struct lttng_consumer_channel
,
3156 /* Check for error event */
3157 if (revents
& (LPOLLERR
| LPOLLHUP
)) {
3158 DBG("Channel fd %d is hup|err.", pollfd
);
3160 lttng_poll_del(&events
, chan
->wait_fd
);
3161 ret
= lttng_ht_del(channel_ht
, &iter
);
3165 * This will close the wait fd for each stream associated to
3166 * this channel AND monitored by the data/metadata thread thus
3167 * will be clean by the right thread.
3169 consumer_close_channel_streams(chan
);
3171 /* Release our own refcount */
3172 if (!uatomic_sub_return(&chan
->refcount
, 1)
3173 && !uatomic_read(&chan
->nb_init_stream_left
)) {
3174 consumer_del_channel(chan
);
3177 ERR("Unexpected poll events %u for sock %d", revents
, pollfd
);
3182 /* Release RCU lock for the channel looked up */
3190 lttng_poll_clean(&events
);
3192 destroy_channel_ht(channel_ht
);
3195 DBG("Channel poll thread exiting");
3198 ERR("Health error occurred in %s", __func__
);
3200 health_unregister(health_consumerd
);
3201 rcu_unregister_thread();
3205 static int set_metadata_socket(struct lttng_consumer_local_data
*ctx
,
3206 struct pollfd
*sockpoll
, int client_socket
)
3213 ret
= lttng_consumer_poll_socket(sockpoll
);
3217 DBG("Metadata connection on client_socket");
3219 /* Blocking call, waiting for transmission */
3220 ctx
->consumer_metadata_socket
= lttcomm_accept_unix_sock(client_socket
);
3221 if (ctx
->consumer_metadata_socket
< 0) {
3222 WARN("On accept metadata");
3233 * This thread listens on the consumerd socket and receives the file
3234 * descriptors from the session daemon.
3236 void *consumer_thread_sessiond_poll(void *data
)
3238 int sock
= -1, client_socket
, ret
, err
= -1;
3240 * structure to poll for incoming data on communication socket avoids
3241 * making blocking sockets.
3243 struct pollfd consumer_sockpoll
[2];
3244 struct lttng_consumer_local_data
*ctx
= data
;
3246 rcu_register_thread();
3248 health_register(health_consumerd
, HEALTH_CONSUMERD_TYPE_SESSIOND
);
3250 if (testpoint(consumerd_thread_sessiond
)) {
3251 goto error_testpoint
;
3254 health_code_update();
3256 DBG("Creating command socket %s", ctx
->consumer_command_sock_path
);
3257 unlink(ctx
->consumer_command_sock_path
);
3258 client_socket
= lttcomm_create_unix_sock(ctx
->consumer_command_sock_path
);
3259 if (client_socket
< 0) {
3260 ERR("Cannot create command socket");
3264 ret
= lttcomm_listen_unix_sock(client_socket
);
3269 DBG("Sending ready command to lttng-sessiond");
3270 ret
= lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_COMMAND_SOCK_READY
);
3271 /* return < 0 on error, but == 0 is not fatal */
3273 ERR("Error sending ready command to lttng-sessiond");
3277 /* prepare the FDs to poll : to client socket and the should_quit pipe */
3278 consumer_sockpoll
[0].fd
= ctx
->consumer_should_quit
[0];
3279 consumer_sockpoll
[0].events
= POLLIN
| POLLPRI
;
3280 consumer_sockpoll
[1].fd
= client_socket
;
3281 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3283 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3291 DBG("Connection on client_socket");
3293 /* Blocking call, waiting for transmission */
3294 sock
= lttcomm_accept_unix_sock(client_socket
);
3301 * Setup metadata socket which is the second socket connection on the
3302 * command unix socket.
3304 ret
= set_metadata_socket(ctx
, consumer_sockpoll
, client_socket
);
3313 /* This socket is not useful anymore. */
3314 ret
= close(client_socket
);
3316 PERROR("close client_socket");
3320 /* update the polling structure to poll on the established socket */
3321 consumer_sockpoll
[1].fd
= sock
;
3322 consumer_sockpoll
[1].events
= POLLIN
| POLLPRI
;
3325 health_code_update();
3327 health_poll_entry();
3328 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3337 DBG("Incoming command on sock");
3338 ret
= lttng_consumer_recv_cmd(ctx
, sock
, consumer_sockpoll
);
3341 * This could simply be a session daemon quitting. Don't output
3344 DBG("Communication interrupted on command socket");
3348 if (CMM_LOAD_SHARED(consumer_quit
)) {
3349 DBG("consumer_thread_receive_fds received quit from signal");
3350 err
= 0; /* All is OK */
3353 DBG("received command on sock");
3359 DBG("Consumer thread sessiond poll exiting");
3362 * Close metadata streams since the producer is the session daemon which
3365 * NOTE: for now, this only applies to the UST tracer.
3367 lttng_consumer_close_all_metadata();
3370 * when all fds have hung up, the polling thread
3373 CMM_STORE_SHARED(consumer_quit
, 1);
3376 * Notify the data poll thread to poll back again and test the
3377 * consumer_quit state that we just set so to quit gracefully.
3379 notify_thread_lttng_pipe(ctx
->consumer_data_pipe
);
3381 notify_channel_pipe(ctx
, NULL
, -1, CONSUMER_CHANNEL_QUIT
);
3383 notify_health_quit_pipe(health_quit_pipe
);
3385 /* Cleaning up possibly open sockets. */
3389 PERROR("close sock sessiond poll");
3392 if (client_socket
>= 0) {
3393 ret
= close(client_socket
);
3395 PERROR("close client_socket sessiond poll");
3402 ERR("Health error occurred in %s", __func__
);
3404 health_unregister(health_consumerd
);
3406 rcu_unregister_thread();
3410 ssize_t
lttng_consumer_read_subbuffer(struct lttng_consumer_stream
*stream
,
3411 struct lttng_consumer_local_data
*ctx
)
3415 pthread_mutex_lock(&stream
->chan
->lock
);
3416 pthread_mutex_lock(&stream
->lock
);
3417 if (stream
->metadata_flag
) {
3418 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
3421 switch (consumer_data
.type
) {
3422 case LTTNG_CONSUMER_KERNEL
:
3423 ret
= lttng_kconsumer_read_subbuffer(stream
, ctx
);
3425 case LTTNG_CONSUMER32_UST
:
3426 case LTTNG_CONSUMER64_UST
:
3427 ret
= lttng_ustconsumer_read_subbuffer(stream
, ctx
);
3430 ERR("Unknown consumer_data type");
3436 if (stream
->metadata_flag
) {
3437 pthread_cond_broadcast(&stream
->metadata_rdv
);
3438 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
3440 pthread_mutex_unlock(&stream
->lock
);
3441 pthread_mutex_unlock(&stream
->chan
->lock
);
3446 int lttng_consumer_on_recv_stream(struct lttng_consumer_stream
*stream
)
3448 switch (consumer_data
.type
) {
3449 case LTTNG_CONSUMER_KERNEL
:
3450 return lttng_kconsumer_on_recv_stream(stream
);
3451 case LTTNG_CONSUMER32_UST
:
3452 case LTTNG_CONSUMER64_UST
:
3453 return lttng_ustconsumer_on_recv_stream(stream
);
3455 ERR("Unknown consumer_data type");
3462 * Allocate and set consumer data hash tables.
3464 int lttng_consumer_init(void)
3466 consumer_data
.channel_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3467 if (!consumer_data
.channel_ht
) {
3471 consumer_data
.channels_by_session_id_ht
=
3472 lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3473 if (!consumer_data
.channels_by_session_id_ht
) {
3477 consumer_data
.relayd_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3478 if (!consumer_data
.relayd_ht
) {
3482 consumer_data
.stream_list_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3483 if (!consumer_data
.stream_list_ht
) {
3487 consumer_data
.stream_per_chan_id_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3488 if (!consumer_data
.stream_per_chan_id_ht
) {
3492 data_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3497 metadata_ht
= lttng_ht_new(0, LTTNG_HT_TYPE_U64
);
3502 consumer_data
.chunk_registry
= lttng_trace_chunk_registry_create();
3503 if (!consumer_data
.chunk_registry
) {
3514 * Process the ADD_RELAYD command receive by a consumer.
3516 * This will create a relayd socket pair and add it to the relayd hash table.
3517 * The caller MUST acquire a RCU read side lock before calling it.
3519 void consumer_add_relayd_socket(uint64_t net_seq_idx
, int sock_type
,
3520 struct lttng_consumer_local_data
*ctx
, int sock
,
3521 struct pollfd
*consumer_sockpoll
,
3522 struct lttcomm_relayd_sock
*relayd_sock
, uint64_t sessiond_id
,
3523 uint64_t relayd_session_id
)
3525 int fd
= -1, ret
= -1, relayd_created
= 0;
3526 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3527 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3530 assert(relayd_sock
);
3532 DBG("Consumer adding relayd socket (idx: %" PRIu64
")", net_seq_idx
);
3534 /* Get relayd reference if exists. */
3535 relayd
= consumer_find_relayd(net_seq_idx
);
3536 if (relayd
== NULL
) {
3537 assert(sock_type
== LTTNG_STREAM_CONTROL
);
3538 /* Not found. Allocate one. */
3539 relayd
= consumer_allocate_relayd_sock_pair(net_seq_idx
);
3540 if (relayd
== NULL
) {
3541 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3544 relayd
->sessiond_session_id
= sessiond_id
;
3549 * This code path MUST continue to the consumer send status message to
3550 * we can notify the session daemon and continue our work without
3551 * killing everything.
3555 * relayd key should never be found for control socket.
3557 assert(sock_type
!= LTTNG_STREAM_CONTROL
);
3560 /* First send a status message before receiving the fds. */
3561 ret
= consumer_send_status_msg(sock
, LTTCOMM_CONSUMERD_SUCCESS
);
3563 /* Somehow, the session daemon is not responding anymore. */
3564 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3565 goto error_nosignal
;
3568 /* Poll on consumer socket. */
3569 ret
= lttng_consumer_poll_socket(consumer_sockpoll
);
3571 /* Needing to exit in the middle of a command: error. */
3572 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_POLL_ERROR
);
3573 goto error_nosignal
;
3576 /* Get relayd socket from session daemon */
3577 ret
= lttcomm_recv_fds_unix_sock(sock
, &fd
, 1);
3578 if (ret
!= sizeof(fd
)) {
3579 fd
= -1; /* Just in case it gets set with an invalid value. */
3582 * Failing to receive FDs might indicate a major problem such as
3583 * reaching a fd limit during the receive where the kernel returns a
3584 * MSG_CTRUNC and fails to cleanup the fd in the queue. Any case, we
3585 * don't take any chances and stop everything.
3587 * XXX: Feature request #558 will fix that and avoid this possible
3588 * issue when reaching the fd limit.
3590 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_ERROR_RECV_FD
);
3591 ret_code
= LTTCOMM_CONSUMERD_ERROR_RECV_FD
;
3595 /* Copy socket information and received FD */
3596 switch (sock_type
) {
3597 case LTTNG_STREAM_CONTROL
:
3598 /* Copy received lttcomm socket */
3599 lttcomm_copy_sock(&relayd
->control_sock
.sock
, &relayd_sock
->sock
);
3600 ret
= lttcomm_create_sock(&relayd
->control_sock
.sock
);
3601 /* Handle create_sock error. */
3603 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3607 * Close the socket created internally by
3608 * lttcomm_create_sock, so we can replace it by the one
3609 * received from sessiond.
3611 if (close(relayd
->control_sock
.sock
.fd
)) {
3615 /* Assign new file descriptor */
3616 relayd
->control_sock
.sock
.fd
= fd
;
3617 /* Assign version values. */
3618 relayd
->control_sock
.major
= relayd_sock
->major
;
3619 relayd
->control_sock
.minor
= relayd_sock
->minor
;
3621 relayd
->relayd_session_id
= relayd_session_id
;
3624 case LTTNG_STREAM_DATA
:
3625 /* Copy received lttcomm socket */
3626 lttcomm_copy_sock(&relayd
->data_sock
.sock
, &relayd_sock
->sock
);
3627 ret
= lttcomm_create_sock(&relayd
->data_sock
.sock
);
3628 /* Handle create_sock error. */
3630 ret_code
= LTTCOMM_CONSUMERD_ENOMEM
;
3634 * Close the socket created internally by
3635 * lttcomm_create_sock, so we can replace it by the one
3636 * received from sessiond.
3638 if (close(relayd
->data_sock
.sock
.fd
)) {
3642 /* Assign new file descriptor */
3643 relayd
->data_sock
.sock
.fd
= fd
;
3644 /* Assign version values. */
3645 relayd
->data_sock
.major
= relayd_sock
->major
;
3646 relayd
->data_sock
.minor
= relayd_sock
->minor
;
3649 ERR("Unknown relayd socket type (%d)", sock_type
);
3650 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
3654 DBG("Consumer %s socket created successfully with net idx %" PRIu64
" (fd: %d)",
3655 sock_type
== LTTNG_STREAM_CONTROL
? "control" : "data",
3656 relayd
->net_seq_idx
, fd
);
3658 * We gave the ownership of the fd to the relayd structure. Set the
3659 * fd to -1 so we don't call close() on it in the error path below.
3663 /* We successfully added the socket. Send status back. */
3664 ret
= consumer_send_status_msg(sock
, ret_code
);
3666 /* Somehow, the session daemon is not responding anymore. */
3667 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3668 goto error_nosignal
;
3672 * Add relayd socket pair to consumer data hashtable. If object already
3673 * exists or on error, the function gracefully returns.
3682 if (consumer_send_status_msg(sock
, ret_code
) < 0) {
3683 lttng_consumer_send_error(ctx
, LTTCOMM_CONSUMERD_FATAL
);
3687 /* Close received socket if valid. */
3690 PERROR("close received socket");
3694 if (relayd_created
) {
3700 * Search for a relayd associated to the session id and return the reference.
3702 * A rcu read side lock MUST be acquire before calling this function and locked
3703 * until the relayd object is no longer necessary.
3705 static struct consumer_relayd_sock_pair
*find_relayd_by_session_id(uint64_t id
)
3707 struct lttng_ht_iter iter
;
3708 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3710 /* Iterate over all relayd since they are indexed by net_seq_idx. */
3711 cds_lfht_for_each_entry(consumer_data
.relayd_ht
->ht
, &iter
.iter
, relayd
,
3714 * Check by sessiond id which is unique here where the relayd session
3715 * id might not be when having multiple relayd.
3717 if (relayd
->sessiond_session_id
== id
) {
3718 /* Found the relayd. There can be only one per id. */
3730 * Check if for a given session id there is still data needed to be extract
3733 * Return 1 if data is pending or else 0 meaning ready to be read.
3735 int consumer_data_pending(uint64_t id
)
3738 struct lttng_ht_iter iter
;
3739 struct lttng_ht
*ht
;
3740 struct lttng_consumer_stream
*stream
;
3741 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3742 int (*data_pending
)(struct lttng_consumer_stream
*);
3744 DBG("Consumer data pending command on session id %" PRIu64
, id
);
3747 pthread_mutex_lock(&consumer_data
.lock
);
3749 switch (consumer_data
.type
) {
3750 case LTTNG_CONSUMER_KERNEL
:
3751 data_pending
= lttng_kconsumer_data_pending
;
3753 case LTTNG_CONSUMER32_UST
:
3754 case LTTNG_CONSUMER64_UST
:
3755 data_pending
= lttng_ustconsumer_data_pending
;
3758 ERR("Unknown consumer data type");
3762 /* Ease our life a bit */
3763 ht
= consumer_data
.stream_list_ht
;
3765 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3766 ht
->hash_fct(&id
, lttng_ht_seed
),
3768 &iter
.iter
, stream
, node_session_id
.node
) {
3769 pthread_mutex_lock(&stream
->lock
);
3772 * A removed node from the hash table indicates that the stream has
3773 * been deleted thus having a guarantee that the buffers are closed
3774 * on the consumer side. However, data can still be transmitted
3775 * over the network so don't skip the relayd check.
3777 ret
= cds_lfht_is_node_deleted(&stream
->node
.node
);
3779 /* Check the stream if there is data in the buffers. */
3780 ret
= data_pending(stream
);
3782 pthread_mutex_unlock(&stream
->lock
);
3787 pthread_mutex_unlock(&stream
->lock
);
3790 relayd
= find_relayd_by_session_id(id
);
3792 unsigned int is_data_inflight
= 0;
3794 /* Send init command for data pending. */
3795 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
3796 ret
= relayd_begin_data_pending(&relayd
->control_sock
,
3797 relayd
->relayd_session_id
);
3799 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3800 /* Communication error thus the relayd so no data pending. */
3801 goto data_not_pending
;
3804 cds_lfht_for_each_entry_duplicate(ht
->ht
,
3805 ht
->hash_fct(&id
, lttng_ht_seed
),
3807 &iter
.iter
, stream
, node_session_id
.node
) {
3808 if (stream
->metadata_flag
) {
3809 ret
= relayd_quiescent_control(&relayd
->control_sock
,
3810 stream
->relayd_stream_id
);
3812 ret
= relayd_data_pending(&relayd
->control_sock
,
3813 stream
->relayd_stream_id
,
3814 stream
->next_net_seq_num
- 1);
3818 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3820 } else if (ret
< 0) {
3821 ERR("Relayd data pending failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
3822 lttng_consumer_cleanup_relayd(relayd
);
3823 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3824 goto data_not_pending
;
3828 /* Send end command for data pending. */
3829 ret
= relayd_end_data_pending(&relayd
->control_sock
,
3830 relayd
->relayd_session_id
, &is_data_inflight
);
3831 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
3833 ERR("Relayd end data pending failed. Cleaning up relayd %" PRIu64
".", relayd
->net_seq_idx
);
3834 lttng_consumer_cleanup_relayd(relayd
);
3835 goto data_not_pending
;
3837 if (is_data_inflight
) {
3843 * Finding _no_ node in the hash table and no inflight data means that the
3844 * stream(s) have been removed thus data is guaranteed to be available for
3845 * analysis from the trace files.
3849 /* Data is available to be read by a viewer. */
3850 pthread_mutex_unlock(&consumer_data
.lock
);
3855 /* Data is still being extracted from buffers. */
3856 pthread_mutex_unlock(&consumer_data
.lock
);
3862 * Send a ret code status message to the sessiond daemon.
3864 * Return the sendmsg() return value.
3866 int consumer_send_status_msg(int sock
, int ret_code
)
3868 struct lttcomm_consumer_status_msg msg
;
3870 memset(&msg
, 0, sizeof(msg
));
3871 msg
.ret_code
= ret_code
;
3873 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3877 * Send a channel status message to the sessiond daemon.
3879 * Return the sendmsg() return value.
3881 int consumer_send_status_channel(int sock
,
3882 struct lttng_consumer_channel
*channel
)
3884 struct lttcomm_consumer_status_channel msg
;
3888 memset(&msg
, 0, sizeof(msg
));
3890 msg
.ret_code
= LTTCOMM_CONSUMERD_CHANNEL_FAIL
;
3892 msg
.ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
3893 msg
.key
= channel
->key
;
3894 msg
.stream_count
= channel
->streams
.count
;
3897 return lttcomm_send_unix_sock(sock
, &msg
, sizeof(msg
));
3900 unsigned long consumer_get_consume_start_pos(unsigned long consumed_pos
,
3901 unsigned long produced_pos
, uint64_t nb_packets_per_stream
,
3902 uint64_t max_sb_size
)
3904 unsigned long start_pos
;
3906 if (!nb_packets_per_stream
) {
3907 return consumed_pos
; /* Grab everything */
3909 start_pos
= produced_pos
- offset_align_floor(produced_pos
, max_sb_size
);
3910 start_pos
-= max_sb_size
* nb_packets_per_stream
;
3911 if ((long) (start_pos
- consumed_pos
) < 0) {
3912 return consumed_pos
; /* Grab everything */
3918 int consumer_flush_buffer(struct lttng_consumer_stream
*stream
, int producer_active
)
3922 switch (consumer_data
.type
) {
3923 case LTTNG_CONSUMER_KERNEL
:
3924 if (producer_active
) {
3925 ret
= kernctl_buffer_flush(stream
->wait_fd
);
3927 ERR("Failed to flush kernel stream");
3931 ret
= kernctl_buffer_flush_empty(stream
->wait_fd
);
3934 * Doing a buffer flush which does not take into
3935 * account empty packets. This is not perfect,
3936 * but required as a fall-back when
3937 * "flush_empty" is not implemented by
3940 ret
= kernctl_buffer_flush(stream
->wait_fd
);
3942 ERR("Failed to flush kernel stream");
3948 case LTTNG_CONSUMER32_UST
:
3949 case LTTNG_CONSUMER64_UST
:
3950 lttng_ustconsumer_flush_buffer(stream
, producer_active
);
3953 ERR("Unknown consumer_data type");
3962 * Sample the rotate position for all the streams of a channel. If a stream
3963 * is already at the rotate position (produced == consumed), we flag it as
3964 * ready for rotation. The rotation of ready streams occurs after we have
3965 * replied to the session daemon that we have finished sampling the positions.
3966 * Must be called with RCU read-side lock held to ensure existence of channel.
3968 * Returns 0 on success, < 0 on error
3970 int lttng_consumer_rotate_channel(struct lttng_consumer_channel
*channel
,
3971 uint64_t key
, uint64_t relayd_id
, uint32_t metadata
,
3972 struct lttng_consumer_local_data
*ctx
)
3975 struct lttng_consumer_stream
*stream
;
3976 struct lttng_ht_iter iter
;
3977 struct lttng_ht
*ht
= consumer_data
.stream_per_chan_id_ht
;
3978 struct lttng_dynamic_array stream_rotation_positions
;
3979 uint64_t next_chunk_id
, stream_count
= 0;
3980 enum lttng_trace_chunk_status chunk_status
;
3981 const bool is_local_trace
= relayd_id
== -1ULL;
3982 struct consumer_relayd_sock_pair
*relayd
= NULL
;
3983 bool rotating_to_new_chunk
= true;
3985 DBG("Consumer sample rotate position for channel %" PRIu64
, key
);
3987 lttng_dynamic_array_init(&stream_rotation_positions
,
3988 sizeof(struct relayd_stream_rotation_position
), NULL
);
3992 pthread_mutex_lock(&channel
->lock
);
3993 assert(channel
->trace_chunk
);
3994 chunk_status
= lttng_trace_chunk_get_id(channel
->trace_chunk
,
3996 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
3998 goto end_unlock_channel
;
4001 cds_lfht_for_each_entry_duplicate(ht
->ht
,
4002 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4003 ht
->match_fct
, &channel
->key
, &iter
.iter
,
4004 stream
, node_channel_id
.node
) {
4005 unsigned long produced_pos
= 0, consumed_pos
= 0;
4007 health_code_update();
4010 * Lock stream because we are about to change its state.
4012 pthread_mutex_lock(&stream
->lock
);
4014 if (stream
->trace_chunk
== stream
->chan
->trace_chunk
) {
4015 rotating_to_new_chunk
= false;
4019 * Do not flush an empty packet when rotating from a NULL trace
4020 * chunk. The stream has no means to output data, and the prior
4021 * rotation which rotated to NULL performed that side-effect already.
4023 if (stream
->trace_chunk
) {
4025 * For metadata stream, do an active flush, which does not
4026 * produce empty packets. For data streams, empty-flush;
4027 * ensures we have at least one packet in each stream per trace
4028 * chunk, even if no data was produced.
4030 ret
= consumer_flush_buffer(stream
, stream
->metadata_flag
? 1 : 0);
4032 ERR("Failed to flush stream %" PRIu64
" during channel rotation",
4034 goto end_unlock_stream
;
4038 ret
= lttng_consumer_take_snapshot(stream
);
4039 if (ret
< 0 && ret
!= -ENODATA
&& ret
!= -EAGAIN
) {
4040 ERR("Failed to sample snapshot position during channel rotation");
4041 goto end_unlock_stream
;
4044 ret
= lttng_consumer_get_produced_snapshot(stream
,
4047 ERR("Failed to sample produced position during channel rotation");
4048 goto end_unlock_stream
;
4051 ret
= lttng_consumer_get_consumed_snapshot(stream
,
4054 ERR("Failed to sample consumed position during channel rotation");
4055 goto end_unlock_stream
;
4059 * Align produced position on the start-of-packet boundary of the first
4060 * packet going into the next trace chunk.
4062 produced_pos
= ALIGN_FLOOR(produced_pos
, stream
->max_sb_size
);
4063 if (consumed_pos
== produced_pos
) {
4064 DBG("Set rotate ready for stream %" PRIu64
" produced = %lu consumed = %lu",
4065 stream
->key
, produced_pos
, consumed_pos
);
4066 stream
->rotate_ready
= true;
4068 DBG("Different consumed and produced positions "
4069 "for stream %" PRIu64
" produced = %lu consumed = %lu",
4070 stream
->key
, produced_pos
, consumed_pos
);
4073 * The rotation position is based on the packet_seq_num of the
4074 * packet following the last packet that was consumed for this
4075 * stream, incremented by the offset between produced and
4076 * consumed positions. This rotation position is a lower bound
4077 * (inclusive) at which the next trace chunk starts. Since it
4078 * is a lower bound, it is OK if the packet_seq_num does not
4079 * correspond exactly to the same packet identified by the
4080 * consumed_pos, which can happen in overwrite mode.
4082 if (stream
->sequence_number_unavailable
) {
4084 * Rotation should never be performed on a session which
4085 * interacts with a pre-2.8 lttng-modules, which does
4086 * not implement packet sequence number.
4088 ERR("Failure to rotate stream %" PRIu64
": sequence number unavailable",
4091 goto end_unlock_stream
;
4093 stream
->rotate_position
= stream
->last_sequence_number
+ 1 +
4094 ((produced_pos
- consumed_pos
) / stream
->max_sb_size
);
4095 DBG("Set rotation position for stream %" PRIu64
" at position %" PRIu64
,
4096 stream
->key
, stream
->rotate_position
);
4098 if (!is_local_trace
) {
4100 * The relay daemon control protocol expects a rotation
4101 * position as "the sequence number of the first packet
4102 * _after_ the current trace chunk".
4104 const struct relayd_stream_rotation_position position
= {
4105 .stream_id
= stream
->relayd_stream_id
,
4106 .rotate_at_seq_num
= stream
->rotate_position
,
4109 ret
= lttng_dynamic_array_add_element(
4110 &stream_rotation_positions
,
4113 ERR("Failed to allocate stream rotation position");
4114 goto end_unlock_stream
;
4118 pthread_mutex_unlock(&stream
->lock
);
4121 pthread_mutex_unlock(&channel
->lock
);
4123 if (is_local_trace
) {
4128 relayd
= consumer_find_relayd(relayd_id
);
4130 ERR("Failed to find relayd %" PRIu64
, relayd_id
);
4135 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4136 ret
= relayd_rotate_streams(&relayd
->control_sock
, stream_count
,
4137 rotating_to_new_chunk
? &next_chunk_id
: NULL
,
4138 (const struct relayd_stream_rotation_position
*)
4139 stream_rotation_positions
.buffer
.data
);
4140 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4142 ERR("Relayd rotate stream failed. Cleaning up relayd %" PRIu64
,
4143 relayd
->net_seq_idx
);
4144 lttng_consumer_cleanup_relayd(relayd
);
4152 pthread_mutex_unlock(&stream
->lock
);
4154 pthread_mutex_unlock(&channel
->lock
);
4157 lttng_dynamic_array_reset(&stream_rotation_positions
);
4162 int consumer_clear_buffer(struct lttng_consumer_stream
*stream
)
4165 unsigned long consumed_pos_before
, consumed_pos_after
;
4167 ret
= lttng_consumer_sample_snapshot_positions(stream
);
4169 ERR("Taking snapshot positions");
4173 ret
= lttng_consumer_get_consumed_snapshot(stream
, &consumed_pos_before
);
4175 ERR("Consumed snapshot position");
4179 switch (consumer_data
.type
) {
4180 case LTTNG_CONSUMER_KERNEL
:
4181 ret
= kernctl_buffer_clear(stream
->wait_fd
);
4183 ERR("Failed to clear kernel stream (ret = %d)", ret
);
4187 case LTTNG_CONSUMER32_UST
:
4188 case LTTNG_CONSUMER64_UST
:
4189 lttng_ustconsumer_clear_buffer(stream
);
4192 ERR("Unknown consumer_data type");
4196 ret
= lttng_consumer_sample_snapshot_positions(stream
);
4198 ERR("Taking snapshot positions");
4201 ret
= lttng_consumer_get_consumed_snapshot(stream
, &consumed_pos_after
);
4203 ERR("Consumed snapshot position");
4206 DBG("clear: before: %lu after: %lu", consumed_pos_before
, consumed_pos_after
);
4212 int consumer_clear_stream(struct lttng_consumer_stream
*stream
)
4216 ret
= consumer_flush_buffer(stream
, 1);
4218 ERR("Failed to flush stream %" PRIu64
" during channel clear",
4220 ret
= LTTCOMM_CONSUMERD_FATAL
;
4224 ret
= consumer_clear_buffer(stream
);
4226 ERR("Failed to clear stream %" PRIu64
" during channel clear",
4228 ret
= LTTCOMM_CONSUMERD_FATAL
;
4232 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4238 int consumer_clear_unmonitored_channel(struct lttng_consumer_channel
*channel
)
4241 struct lttng_consumer_stream
*stream
;
4244 pthread_mutex_lock(&channel
->lock
);
4245 cds_list_for_each_entry(stream
, &channel
->streams
.head
, send_node
) {
4246 health_code_update();
4247 pthread_mutex_lock(&stream
->lock
);
4248 ret
= consumer_clear_stream(stream
);
4252 pthread_mutex_unlock(&stream
->lock
);
4254 pthread_mutex_unlock(&channel
->lock
);
4259 pthread_mutex_unlock(&stream
->lock
);
4260 pthread_mutex_unlock(&channel
->lock
);
4266 * Check if a stream is ready to be rotated after extracting it.
4268 * Return 1 if it is ready for rotation, 0 if it is not, a negative value on
4269 * error. Stream lock must be held.
4271 int lttng_consumer_stream_is_rotate_ready(struct lttng_consumer_stream
*stream
)
4273 DBG("Check is rotate ready for stream %" PRIu64
4274 " ready %u rotate_position %" PRIu64
4275 " last_sequence_number %" PRIu64
,
4276 stream
->key
, stream
->rotate_ready
,
4277 stream
->rotate_position
, stream
->last_sequence_number
);
4278 if (stream
->rotate_ready
) {
4283 * If packet seq num is unavailable, it means we are interacting
4284 * with a pre-2.8 lttng-modules which does not implement the
4285 * sequence number. Rotation should never be used by sessiond in this
4288 if (stream
->sequence_number_unavailable
) {
4289 ERR("Internal error: rotation used on stream %" PRIu64
4290 " with unavailable sequence number",
4295 if (stream
->rotate_position
== -1ULL ||
4296 stream
->last_sequence_number
== -1ULL) {
4301 * Rotate position not reached yet. The stream rotate position is
4302 * the position of the next packet belonging to the next trace chunk,
4303 * but consumerd considers rotation ready when reaching the last
4304 * packet of the current chunk, hence the "rotate_position - 1".
4307 DBG("Check is rotate ready for stream %" PRIu64
4308 " last_sequence_number %" PRIu64
4309 " rotate_position %" PRIu64
,
4310 stream
->key
, stream
->last_sequence_number
,
4311 stream
->rotate_position
);
4312 if (stream
->last_sequence_number
>= stream
->rotate_position
- 1) {
4320 * Reset the state for a stream after a rotation occurred.
4322 void lttng_consumer_reset_stream_rotate_state(struct lttng_consumer_stream
*stream
)
4324 DBG("lttng_consumer_reset_stream_rotate_state for stream %" PRIu64
,
4326 stream
->rotate_position
= -1ULL;
4327 stream
->rotate_ready
= false;
4331 * Perform the rotation a local stream file.
4334 int rotate_local_stream(struct lttng_consumer_local_data
*ctx
,
4335 struct lttng_consumer_stream
*stream
)
4339 DBG("Rotate local stream: stream key %" PRIu64
", channel key %" PRIu64
,
4342 stream
->tracefile_size_current
= 0;
4343 stream
->tracefile_count_current
= 0;
4345 if (stream
->out_fd
>= 0) {
4346 ret
= close(stream
->out_fd
);
4348 PERROR("Failed to close stream out_fd of channel \"%s\"",
4349 stream
->chan
->name
);
4351 stream
->out_fd
= -1;
4354 if (stream
->index_file
) {
4355 lttng_index_file_put(stream
->index_file
);
4356 stream
->index_file
= NULL
;
4359 if (!stream
->trace_chunk
) {
4363 ret
= consumer_stream_create_output_files(stream
, true);
4369 * Performs the stream rotation for the rotate session feature if needed.
4370 * It must be called with the channel and stream locks held.
4372 * Return 0 on success, a negative number of error.
4374 int lttng_consumer_rotate_stream(struct lttng_consumer_local_data
*ctx
,
4375 struct lttng_consumer_stream
*stream
)
4379 DBG("Consumer rotate stream %" PRIu64
, stream
->key
);
4382 * Update the stream's 'current' chunk to the session's (channel)
4383 * now-current chunk.
4385 lttng_trace_chunk_put(stream
->trace_chunk
);
4386 if (stream
->chan
->trace_chunk
== stream
->trace_chunk
) {
4388 * A channel can be rotated and not have a "next" chunk
4389 * to transition to. In that case, the channel's "current chunk"
4390 * has not been closed yet, but it has not been updated to
4391 * a "next" trace chunk either. Hence, the stream, like its
4392 * parent channel, becomes part of no chunk and can't output
4393 * anything until a new trace chunk is created.
4395 stream
->trace_chunk
= NULL
;
4396 } else if (stream
->chan
->trace_chunk
&&
4397 !lttng_trace_chunk_get(stream
->chan
->trace_chunk
)) {
4398 ERR("Failed to acquire a reference to channel's trace chunk during stream rotation");
4403 * Update the stream's trace chunk to its parent channel's
4404 * current trace chunk.
4406 stream
->trace_chunk
= stream
->chan
->trace_chunk
;
4409 if (stream
->net_seq_idx
== (uint64_t) -1ULL) {
4410 ret
= rotate_local_stream(ctx
, stream
);
4412 ERR("Failed to rotate stream, ret = %i", ret
);
4417 if (stream
->metadata_flag
&& stream
->trace_chunk
) {
4419 * If the stream has transitioned to a new trace
4420 * chunk, the metadata should be re-dumped to the
4423 * However, it is possible for a stream to transition to
4424 * a "no-chunk" state. This can happen if a rotation
4425 * occurs on an inactive session. In such cases, the metadata
4426 * regeneration will happen when the next trace chunk is
4429 ret
= consumer_metadata_stream_dump(stream
);
4434 lttng_consumer_reset_stream_rotate_state(stream
);
4443 * Rotate all the ready streams now.
4445 * This is especially important for low throughput streams that have already
4446 * been consumed, we cannot wait for their next packet to perform the
4448 * Need to be called with RCU read-side lock held to ensure existence of
4451 * Returns 0 on success, < 0 on error
4453 int lttng_consumer_rotate_ready_streams(struct lttng_consumer_channel
*channel
,
4454 uint64_t key
, struct lttng_consumer_local_data
*ctx
)
4457 struct lttng_consumer_stream
*stream
;
4458 struct lttng_ht_iter iter
;
4459 struct lttng_ht
*ht
= consumer_data
.stream_per_chan_id_ht
;
4463 DBG("Consumer rotate ready streams in channel %" PRIu64
, key
);
4465 cds_lfht_for_each_entry_duplicate(ht
->ht
,
4466 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4467 ht
->match_fct
, &channel
->key
, &iter
.iter
,
4468 stream
, node_channel_id
.node
) {
4469 health_code_update();
4471 pthread_mutex_lock(&stream
->chan
->lock
);
4472 pthread_mutex_lock(&stream
->lock
);
4474 if (!stream
->rotate_ready
) {
4475 pthread_mutex_unlock(&stream
->lock
);
4476 pthread_mutex_unlock(&stream
->chan
->lock
);
4479 DBG("Consumer rotate ready stream %" PRIu64
, stream
->key
);
4481 ret
= lttng_consumer_rotate_stream(ctx
, stream
);
4482 pthread_mutex_unlock(&stream
->lock
);
4483 pthread_mutex_unlock(&stream
->chan
->lock
);
4496 enum lttcomm_return_code
lttng_consumer_init_command(
4497 struct lttng_consumer_local_data
*ctx
,
4498 const lttng_uuid sessiond_uuid
)
4500 enum lttcomm_return_code ret
;
4501 char uuid_str
[LTTNG_UUID_STR_LEN
];
4503 if (ctx
->sessiond_uuid
.is_set
) {
4504 ret
= LTTCOMM_CONSUMERD_ALREADY_SET
;
4508 ctx
->sessiond_uuid
.is_set
= true;
4509 memcpy(ctx
->sessiond_uuid
.value
, sessiond_uuid
, sizeof(lttng_uuid
));
4510 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4511 lttng_uuid_to_str(sessiond_uuid
, uuid_str
);
4512 DBG("Received session daemon UUID: %s", uuid_str
);
4517 enum lttcomm_return_code
lttng_consumer_create_trace_chunk(
4518 const uint64_t *relayd_id
, uint64_t session_id
,
4520 time_t chunk_creation_timestamp
,
4521 const char *chunk_override_name
,
4522 const struct lttng_credentials
*credentials
,
4523 struct lttng_directory_handle
*chunk_directory_handle
)
4526 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
4527 struct lttng_trace_chunk
*created_chunk
= NULL
, *published_chunk
= NULL
;
4528 enum lttng_trace_chunk_status chunk_status
;
4529 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4530 char creation_timestamp_buffer
[ISO8601_STR_LEN
];
4531 const char *relayd_id_str
= "(none)";
4532 const char *creation_timestamp_str
;
4533 struct lttng_ht_iter iter
;
4534 struct lttng_consumer_channel
*channel
;
4537 /* Only used for logging purposes. */
4538 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4539 "%" PRIu64
, *relayd_id
);
4540 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4541 relayd_id_str
= relayd_id_buffer
;
4543 relayd_id_str
= "(formatting error)";
4547 /* Local protocol error. */
4548 assert(chunk_creation_timestamp
);
4549 ret
= time_to_iso8601_str(chunk_creation_timestamp
,
4550 creation_timestamp_buffer
,
4551 sizeof(creation_timestamp_buffer
));
4552 creation_timestamp_str
= !ret
? creation_timestamp_buffer
:
4553 "(formatting error)";
4555 DBG("Consumer create trace chunk command: relay_id = %s"
4556 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
4557 ", chunk_override_name = %s"
4558 ", chunk_creation_timestamp = %s",
4559 relayd_id_str
, session_id
, chunk_id
,
4560 chunk_override_name
? : "(none)",
4561 creation_timestamp_str
);
4564 * The trace chunk registry, as used by the consumer daemon, implicitly
4565 * owns the trace chunks. This is only needed in the consumer since
4566 * the consumer has no notion of a session beyond session IDs being
4567 * used to identify other objects.
4569 * The lttng_trace_chunk_registry_publish() call below provides a
4570 * reference which is not released; it implicitly becomes the session
4571 * daemon's reference to the chunk in the consumer daemon.
4573 * The lifetime of trace chunks in the consumer daemon is managed by
4574 * the session daemon through the LTTNG_CONSUMER_CREATE_TRACE_CHUNK
4575 * and LTTNG_CONSUMER_DESTROY_TRACE_CHUNK commands.
4577 created_chunk
= lttng_trace_chunk_create(chunk_id
,
4578 chunk_creation_timestamp
, NULL
);
4579 if (!created_chunk
) {
4580 ERR("Failed to create trace chunk");
4581 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4585 if (chunk_override_name
) {
4586 chunk_status
= lttng_trace_chunk_override_name(created_chunk
,
4587 chunk_override_name
);
4588 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4589 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4594 if (chunk_directory_handle
) {
4595 chunk_status
= lttng_trace_chunk_set_credentials(created_chunk
,
4597 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4598 ERR("Failed to set trace chunk credentials");
4599 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4603 * The consumer daemon has no ownership of the chunk output
4606 chunk_status
= lttng_trace_chunk_set_as_user(created_chunk
,
4607 chunk_directory_handle
);
4608 chunk_directory_handle
= NULL
;
4609 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4610 ERR("Failed to set trace chunk's directory handle");
4611 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4616 published_chunk
= lttng_trace_chunk_registry_publish_chunk(
4617 consumer_data
.chunk_registry
, session_id
,
4619 lttng_trace_chunk_put(created_chunk
);
4620 created_chunk
= NULL
;
4621 if (!published_chunk
) {
4622 ERR("Failed to publish trace chunk");
4623 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4628 cds_lfht_for_each_entry_duplicate(consumer_data
.channels_by_session_id_ht
->ht
,
4629 consumer_data
.channels_by_session_id_ht
->hash_fct(
4630 &session_id
, lttng_ht_seed
),
4631 consumer_data
.channels_by_session_id_ht
->match_fct
,
4632 &session_id
, &iter
.iter
, channel
,
4633 channels_by_session_id_ht_node
.node
) {
4634 ret
= lttng_consumer_channel_set_trace_chunk(channel
,
4638 * Roll-back the creation of this chunk.
4640 * This is important since the session daemon will
4641 * assume that the creation of this chunk failed and
4642 * will never ask for it to be closed, resulting
4643 * in a leak and an inconsistent state for some
4646 enum lttcomm_return_code close_ret
;
4647 char path
[LTTNG_PATH_MAX
];
4649 DBG("Failed to set new trace chunk on existing channels, rolling back");
4650 close_ret
= lttng_consumer_close_trace_chunk(relayd_id
,
4651 session_id
, chunk_id
,
4652 chunk_creation_timestamp
, NULL
,
4654 if (close_ret
!= LTTCOMM_CONSUMERD_SUCCESS
) {
4655 ERR("Failed to roll-back the creation of new chunk: session_id = %" PRIu64
", chunk_id = %" PRIu64
,
4656 session_id
, chunk_id
);
4659 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4665 struct consumer_relayd_sock_pair
*relayd
;
4667 relayd
= consumer_find_relayd(*relayd_id
);
4669 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4670 ret
= relayd_create_trace_chunk(
4671 &relayd
->control_sock
, published_chunk
);
4672 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4674 ERR("Failed to find relay daemon socket: relayd_id = %" PRIu64
, *relayd_id
);
4677 if (!relayd
|| ret
) {
4678 enum lttcomm_return_code close_ret
;
4679 char path
[LTTNG_PATH_MAX
];
4681 close_ret
= lttng_consumer_close_trace_chunk(relayd_id
,
4684 chunk_creation_timestamp
,
4686 if (close_ret
!= LTTCOMM_CONSUMERD_SUCCESS
) {
4687 ERR("Failed to roll-back the creation of new chunk: session_id = %" PRIu64
", chunk_id = %" PRIu64
,
4692 ret_code
= LTTCOMM_CONSUMERD_CREATE_TRACE_CHUNK_FAILED
;
4699 /* Release the reference returned by the "publish" operation. */
4700 lttng_trace_chunk_put(published_chunk
);
4701 lttng_trace_chunk_put(created_chunk
);
4705 enum lttcomm_return_code
lttng_consumer_close_trace_chunk(
4706 const uint64_t *relayd_id
, uint64_t session_id
,
4707 uint64_t chunk_id
, time_t chunk_close_timestamp
,
4708 const enum lttng_trace_chunk_command_type
*close_command
,
4711 enum lttcomm_return_code ret_code
= LTTCOMM_CONSUMERD_SUCCESS
;
4712 struct lttng_trace_chunk
*chunk
;
4713 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4714 const char *relayd_id_str
= "(none)";
4715 const char *close_command_name
= "none";
4716 struct lttng_ht_iter iter
;
4717 struct lttng_consumer_channel
*channel
;
4718 enum lttng_trace_chunk_status chunk_status
;
4723 /* Only used for logging purposes. */
4724 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4725 "%" PRIu64
, *relayd_id
);
4726 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4727 relayd_id_str
= relayd_id_buffer
;
4729 relayd_id_str
= "(formatting error)";
4732 if (close_command
) {
4733 close_command_name
= lttng_trace_chunk_command_type_get_name(
4737 DBG("Consumer close trace chunk command: relayd_id = %s"
4738 ", session_id = %" PRIu64
", chunk_id = %" PRIu64
4739 ", close command = %s",
4740 relayd_id_str
, session_id
, chunk_id
,
4741 close_command_name
);
4743 chunk
= lttng_trace_chunk_registry_find_chunk(
4744 consumer_data
.chunk_registry
, session_id
, chunk_id
);
4746 ERR("Failed to find chunk: session_id = %" PRIu64
4747 ", chunk_id = %" PRIu64
,
4748 session_id
, chunk_id
);
4749 ret_code
= LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4753 chunk_status
= lttng_trace_chunk_set_close_timestamp(chunk
,
4754 chunk_close_timestamp
);
4755 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4756 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4760 if (close_command
) {
4761 chunk_status
= lttng_trace_chunk_set_close_command(
4762 chunk
, *close_command
);
4763 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
4764 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4770 * chunk is now invalid to access as we no longer hold a reference to
4771 * it; it is only kept around to compare it (by address) to the
4772 * current chunk found in the session's channels.
4775 cds_lfht_for_each_entry(consumer_data
.channel_ht
->ht
, &iter
.iter
,
4776 channel
, node
.node
) {
4780 * Only change the channel's chunk to NULL if it still
4781 * references the chunk being closed. The channel may
4782 * reference a newer channel in the case of a session
4783 * rotation. When a session rotation occurs, the "next"
4784 * chunk is created before the "current" chunk is closed.
4786 if (channel
->trace_chunk
!= chunk
) {
4789 ret
= lttng_consumer_channel_set_trace_chunk(channel
, NULL
);
4792 * Attempt to close the chunk on as many channels as
4795 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4801 struct consumer_relayd_sock_pair
*relayd
;
4803 relayd
= consumer_find_relayd(*relayd_id
);
4805 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4806 ret
= relayd_close_trace_chunk(
4807 &relayd
->control_sock
, chunk
,
4809 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4811 ERR("Failed to find relay daemon socket: relayd_id = %" PRIu64
,
4815 if (!relayd
|| ret
) {
4816 ret_code
= LTTCOMM_CONSUMERD_CLOSE_TRACE_CHUNK_FAILED
;
4824 * Release the reference returned by the "find" operation and
4825 * the session daemon's implicit reference to the chunk.
4827 lttng_trace_chunk_put(chunk
);
4828 lttng_trace_chunk_put(chunk
);
4833 enum lttcomm_return_code
lttng_consumer_trace_chunk_exists(
4834 const uint64_t *relayd_id
, uint64_t session_id
,
4838 enum lttcomm_return_code ret_code
;
4839 char relayd_id_buffer
[MAX_INT_DEC_LEN(*relayd_id
)];
4840 const char *relayd_id_str
= "(none)";
4841 const bool is_local_trace
= !relayd_id
;
4842 struct consumer_relayd_sock_pair
*relayd
= NULL
;
4843 bool chunk_exists_local
, chunk_exists_remote
;
4848 /* Only used for logging purposes. */
4849 ret
= snprintf(relayd_id_buffer
, sizeof(relayd_id_buffer
),
4850 "%" PRIu64
, *relayd_id
);
4851 if (ret
> 0 && ret
< sizeof(relayd_id_buffer
)) {
4852 relayd_id_str
= relayd_id_buffer
;
4854 relayd_id_str
= "(formatting error)";
4858 DBG("Consumer trace chunk exists command: relayd_id = %s"
4859 ", chunk_id = %" PRIu64
, relayd_id_str
,
4861 ret
= lttng_trace_chunk_registry_chunk_exists(
4862 consumer_data
.chunk_registry
, session_id
,
4863 chunk_id
, &chunk_exists_local
);
4865 /* Internal error. */
4866 ERR("Failed to query the existence of a trace chunk");
4867 ret_code
= LTTCOMM_CONSUMERD_FATAL
;
4870 DBG("Trace chunk %s locally",
4871 chunk_exists_local
? "exists" : "does not exist");
4872 if (chunk_exists_local
) {
4873 ret_code
= LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_LOCAL
;
4875 } else if (is_local_trace
) {
4876 ret_code
= LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4881 relayd
= consumer_find_relayd(*relayd_id
);
4883 ERR("Failed to find relayd %" PRIu64
, *relayd_id
);
4884 ret_code
= LTTCOMM_CONSUMERD_INVALID_PARAMETERS
;
4885 goto end_rcu_unlock
;
4887 DBG("Looking up existence of trace chunk on relay daemon");
4888 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
4889 ret
= relayd_trace_chunk_exists(&relayd
->control_sock
, chunk_id
,
4890 &chunk_exists_remote
);
4891 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
4893 ERR("Failed to look-up the existence of trace chunk on relay daemon");
4894 ret_code
= LTTCOMM_CONSUMERD_RELAYD_FAIL
;
4895 goto end_rcu_unlock
;
4898 ret_code
= chunk_exists_remote
?
4899 LTTCOMM_CONSUMERD_TRACE_CHUNK_EXISTS_REMOTE
:
4900 LTTCOMM_CONSUMERD_UNKNOWN_TRACE_CHUNK
;
4901 DBG("Trace chunk %s on relay daemon",
4902 chunk_exists_remote
? "exists" : "does not exist");
4911 int consumer_clear_monitored_channel(struct lttng_consumer_channel
*channel
)
4913 struct lttng_ht
*ht
;
4914 struct lttng_consumer_stream
*stream
;
4915 struct lttng_ht_iter iter
;
4918 ht
= consumer_data
.stream_per_chan_id_ht
;
4921 cds_lfht_for_each_entry_duplicate(ht
->ht
,
4922 ht
->hash_fct(&channel
->key
, lttng_ht_seed
),
4923 ht
->match_fct
, &channel
->key
,
4924 &iter
.iter
, stream
, node_channel_id
.node
) {
4926 * Protect against teardown with mutex.
4928 pthread_mutex_lock(&stream
->lock
);
4929 if (cds_lfht_is_node_deleted(&stream
->node
.node
)) {
4932 ret
= consumer_clear_stream(stream
);
4937 pthread_mutex_unlock(&stream
->lock
);
4940 return LTTCOMM_CONSUMERD_SUCCESS
;
4943 pthread_mutex_unlock(&stream
->lock
);
4948 int lttng_consumer_clear_channel(struct lttng_consumer_channel
*channel
)
4952 DBG("Consumer clear channel %" PRIu64
, channel
->key
);
4954 if (channel
->type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
4956 * Nothing to do for the metadata channel/stream.
4957 * Snapshot mechanism already take care of the metadata
4958 * handling/generation, and monitored channels only need to
4959 * have their data stream cleared..
4961 ret
= LTTCOMM_CONSUMERD_SUCCESS
;
4965 if (!channel
->monitor
) {
4966 ret
= consumer_clear_unmonitored_channel(channel
);
4968 ret
= consumer_clear_monitored_channel(channel
);