2 * Copyright (C) 2011 EfficiOS Inc.
3 * Copyright (C) 2011 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
4 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
6 * SPDX-License-Identifier: GPL-2.0-only
11 #include "consumer-stream.hpp"
13 #include <common/common.hpp>
14 #include <common/consumer/consumer-timer.hpp>
15 #include <common/consumer/consumer.hpp>
16 #include <common/consumer/metadata-bucket.hpp>
17 #include <common/index/index.hpp>
18 #include <common/kernel-consumer/kernel-consumer.hpp>
19 #include <common/kernel-ctl/kernel-ctl.hpp>
20 #include <common/macros.hpp>
21 #include <common/relayd/relayd.hpp>
22 #include <common/urcu.hpp>
23 #include <common/ust-consumer/ust-consumer.hpp>
24 #include <common/utils.hpp>
31 * RCU call to free stream. MUST only be used with call_rcu().
33 static void free_stream_rcu(struct rcu_head
*head
)
35 struct lttng_ht_node_u64
*node
= lttng::utils::container_of(head
, <tng_ht_node_u64::head
);
36 struct lttng_consumer_stream
*stream
=
37 lttng::utils::container_of(node
, <tng_consumer_stream::node
);
39 pthread_mutex_destroy(&stream
->lock
);
43 static void consumer_stream_data_lock_all(struct lttng_consumer_stream
*stream
)
45 pthread_mutex_lock(&stream
->chan
->lock
);
46 pthread_mutex_lock(&stream
->lock
);
49 static void consumer_stream_data_unlock_all(struct lttng_consumer_stream
*stream
)
51 pthread_mutex_unlock(&stream
->lock
);
52 pthread_mutex_unlock(&stream
->chan
->lock
);
55 static void consumer_stream_data_assert_locked_all(struct lttng_consumer_stream
*stream
)
57 ASSERT_LOCKED(stream
->lock
);
58 ASSERT_LOCKED(stream
->chan
->lock
);
61 static void consumer_stream_metadata_lock_all(struct lttng_consumer_stream
*stream
)
63 consumer_stream_data_lock_all(stream
);
64 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
67 static void consumer_stream_metadata_unlock_all(struct lttng_consumer_stream
*stream
)
69 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
70 consumer_stream_data_unlock_all(stream
);
73 static void consumer_stream_metadata_assert_locked_all(struct lttng_consumer_stream
*stream
)
75 ASSERT_LOCKED(stream
->metadata_rdv_lock
);
76 consumer_stream_data_assert_locked_all(stream
);
79 /* Only used for data streams. */
80 static int consumer_stream_update_stats(struct lttng_consumer_stream
*stream
,
81 const struct stream_subbuffer
*subbuf
)
84 uint64_t sequence_number
;
85 const uint64_t discarded_events
= subbuf
->info
.data
.events_discarded
;
87 if (!subbuf
->info
.data
.sequence_number
.is_set
) {
88 /* Command not supported by the tracer. */
89 sequence_number
= -1ULL;
90 stream
->sequence_number_unavailable
= true;
92 sequence_number
= subbuf
->info
.data
.sequence_number
.value
;
96 * Start the sequence when we extract the first packet in case we don't
97 * start at 0 (for example if a consumer is not connected to the
98 * session immediately after the beginning).
100 if (stream
->last_sequence_number
== -1ULL) {
101 stream
->last_sequence_number
= sequence_number
;
102 } else if (sequence_number
> stream
->last_sequence_number
) {
103 stream
->chan
->lost_packets
+= sequence_number
- stream
->last_sequence_number
- 1;
105 /* seq <= last_sequence_number */
106 ERR("Sequence number inconsistent : prev = %" PRIu64
", current = %" PRIu64
,
107 stream
->last_sequence_number
,
112 stream
->last_sequence_number
= sequence_number
;
114 if (discarded_events
< stream
->last_discarded_events
) {
116 * Overflow has occurred. We assume only one wrap-around
119 stream
->chan
->discarded_events
+= (1ULL << (CAA_BITS_PER_LONG
- 1)) -
120 stream
->last_discarded_events
+ discarded_events
;
122 stream
->chan
->discarded_events
+= discarded_events
- stream
->last_discarded_events
;
124 stream
->last_discarded_events
= discarded_events
;
131 static void ctf_packet_index_populate(struct ctf_packet_index
*index
,
133 const struct stream_subbuffer
*subbuffer
)
135 *index
= (typeof(*index
)){
136 .offset
= htobe64(offset
),
137 .packet_size
= htobe64(subbuffer
->info
.data
.packet_size
),
138 .content_size
= htobe64(subbuffer
->info
.data
.content_size
),
139 .timestamp_begin
= htobe64(subbuffer
->info
.data
.timestamp_begin
),
140 .timestamp_end
= htobe64(subbuffer
->info
.data
.timestamp_end
),
141 .events_discarded
= htobe64(subbuffer
->info
.data
.events_discarded
),
142 .stream_id
= htobe64(subbuffer
->info
.data
.stream_id
),
143 .stream_instance_id
=
144 htobe64(subbuffer
->info
.data
.stream_instance_id
.is_set
?
145 subbuffer
->info
.data
.stream_instance_id
.value
:
147 .packet_seq_num
= htobe64(subbuffer
->info
.data
.sequence_number
.is_set
?
148 subbuffer
->info
.data
.sequence_number
.value
:
153 static ssize_t
consumer_stream_consume_mmap(struct lttng_consumer_local_data
*ctx
154 __attribute__((unused
)),
155 struct lttng_consumer_stream
*stream
,
156 const struct stream_subbuffer
*subbuffer
)
158 const unsigned long padding_size
=
159 subbuffer
->info
.data
.padded_subbuf_size
- subbuffer
->info
.data
.subbuf_size
;
160 const ssize_t written_bytes
= lttng_consumer_on_read_subbuffer_mmap(
161 stream
, &subbuffer
->buffer
.buffer
, padding_size
);
163 if (stream
->net_seq_idx
== -1ULL) {
165 * When writing on disk, check that only the subbuffer (no
166 * padding) was written to disk.
168 if (written_bytes
!= subbuffer
->info
.data
.padded_subbuf_size
) {
169 DBG("Failed to write the entire padded subbuffer on disk (written_bytes: %zd, padded subbuffer size %lu)",
171 subbuffer
->info
.data
.padded_subbuf_size
);
175 * When streaming over the network, check that the entire
176 * subbuffer including padding was successfully written.
178 if (written_bytes
!= subbuffer
->info
.data
.subbuf_size
) {
179 DBG("Failed to write only the subbuffer over the network (written_bytes: %zd, subbuffer size %lu)",
181 subbuffer
->info
.data
.subbuf_size
);
186 * If `lttng_consumer_on_read_subbuffer_mmap()` returned an error, pass
187 * it along to the caller, else return zero.
189 if (written_bytes
< 0) {
190 ERR("Error reading mmap subbuffer: %zd", written_bytes
);
193 return written_bytes
;
196 static ssize_t
consumer_stream_consume_splice(struct lttng_consumer_local_data
*ctx
,
197 struct lttng_consumer_stream
*stream
,
198 const struct stream_subbuffer
*subbuffer
)
200 const ssize_t written_bytes
= lttng_consumer_on_read_subbuffer_splice(
201 ctx
, stream
, subbuffer
->info
.data
.padded_subbuf_size
, 0);
203 if (written_bytes
!= subbuffer
->info
.data
.padded_subbuf_size
) {
204 DBG("Failed to write the entire padded subbuffer (written_bytes: %zd, padded subbuffer size %lu)",
206 subbuffer
->info
.data
.padded_subbuf_size
);
210 * If `lttng_consumer_on_read_subbuffer_splice()` returned an error,
211 * pass it along to the caller, else return zero.
213 if (written_bytes
< 0) {
214 ERR("Error reading splice subbuffer: %zd", written_bytes
);
217 return written_bytes
;
220 static int consumer_stream_send_index(struct lttng_consumer_stream
*stream
,
221 const struct stream_subbuffer
*subbuffer
,
222 struct lttng_consumer_local_data
*ctx
__attribute__((unused
)))
224 off_t packet_offset
= 0;
225 struct ctf_packet_index index
= {};
228 * This is called after consuming the sub-buffer; substract the
229 * effect this sub-buffer from the offset.
231 if (stream
->net_seq_idx
== (uint64_t) -1ULL) {
232 packet_offset
= stream
->out_fd_offset
- subbuffer
->info
.data
.padded_subbuf_size
;
235 ctf_packet_index_populate(&index
, packet_offset
, subbuffer
);
236 return consumer_stream_write_index(stream
, &index
);
240 * Actually do the metadata sync using the given metadata stream.
242 * Return 0 on success else a negative value. ENODATA can be returned also
243 * indicating that there is no metadata available for that stream.
245 static int do_sync_metadata(struct lttng_consumer_stream
*metadata
,
246 struct lttng_consumer_local_data
*ctx
)
249 enum sync_metadata_status status
;
251 LTTNG_ASSERT(metadata
);
252 LTTNG_ASSERT(metadata
->metadata_flag
);
256 * In UST, since we have to write the metadata from the cache packet
257 * by packet, we might need to start this procedure multiple times
258 * until all the metadata from the cache has been extracted.
263 * - Lock the metadata stream
264 * - Check if metadata stream node was deleted before locking.
265 * - if yes, release and return success
266 * - Check if new metadata is ready (flush + snapshot pos)
267 * - If nothing : release and return.
268 * - Lock the metadata_rdv_lock
269 * - Unlock the metadata stream
270 * - cond_wait on metadata_rdv to wait the wakeup from the
272 * - Unlock the metadata_rdv_lock
274 pthread_mutex_lock(&metadata
->lock
);
277 * There is a possibility that we were able to acquire a reference on the
278 * stream from the RCU hash table but between then and now, the node might
279 * have been deleted just before the lock is acquired. Thus, after locking,
280 * we make sure the metadata node has not been deleted which means that the
281 * buffers are closed.
283 * In that case, there is no need to sync the metadata hence returning a
284 * success return code.
286 ret
= cds_lfht_is_node_deleted(&metadata
->node
.node
);
289 goto end_unlock_mutex
;
293 case LTTNG_CONSUMER_KERNEL
:
295 * Empty the metadata cache and flush the current stream.
297 status
= lttng_kconsumer_sync_metadata(metadata
);
299 case LTTNG_CONSUMER32_UST
:
300 case LTTNG_CONSUMER64_UST
:
302 * Ask the sessiond if we have new metadata waiting and update the
303 * consumer metadata cache.
305 status
= lttng_ustconsumer_sync_metadata(ctx
, metadata
);
312 case SYNC_METADATA_STATUS_NEW_DATA
:
314 case SYNC_METADATA_STATUS_NO_DATA
:
316 goto end_unlock_mutex
;
317 case SYNC_METADATA_STATUS_ERROR
:
319 goto end_unlock_mutex
;
325 * At this point, new metadata have been flushed, so we wait on the
326 * rendez-vous point for the metadata thread to wake us up when it
327 * finishes consuming the metadata and continue execution.
330 pthread_mutex_lock(&metadata
->metadata_rdv_lock
);
333 * Release metadata stream lock so the metadata thread can process it.
335 pthread_mutex_unlock(&metadata
->lock
);
338 * Wait on the rendez-vous point. Once woken up, it means the metadata was
339 * consumed and thus synchronization is achieved.
341 pthread_cond_wait(&metadata
->metadata_rdv
, &metadata
->metadata_rdv_lock
);
342 pthread_mutex_unlock(&metadata
->metadata_rdv_lock
);
343 } while (status
== SYNC_METADATA_STATUS_NEW_DATA
);
349 pthread_mutex_unlock(&metadata
->lock
);
354 * Synchronize the metadata using a given session ID. A successful acquisition
355 * of a metadata stream will trigger a request to the session daemon and a
356 * snapshot so the metadata thread can consume it.
358 * This function call is a rendez-vous point between the metadata thread and
361 * Return 0 on success or else a negative value.
363 int consumer_stream_sync_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t session_id
)
366 struct lttng_consumer_stream
*stream
= nullptr;
367 struct lttng_ht_iter iter
;
372 /* Ease our life a bit. */
373 ht
= the_consumer_data
.stream_list_ht
;
375 lttng::urcu::read_lock_guard read_lock
;
377 /* Search the metadata associated with the session id of the given stream. */
379 cds_lfht_for_each_entry_duplicate(ht
->ht
,
380 ht
->hash_fct(&session_id
, lttng_ht_seed
),
385 node_session_id
.node
)
387 if (!stream
->metadata_flag
) {
391 ret
= do_sync_metadata(stream
, ctx
);
398 * Force return code to 0 (success) since ret might be ENODATA for instance
399 * which is not an error but rather that we should come back.
407 static int consumer_stream_sync_metadata_index(struct lttng_consumer_stream
*stream
,
408 const struct stream_subbuffer
*subbuffer
,
409 struct lttng_consumer_local_data
*ctx
)
411 bool missed_metadata_flush
;
414 /* Block until all the metadata is sent. */
415 pthread_mutex_lock(&stream
->metadata_timer_lock
);
416 LTTNG_ASSERT(!stream
->missed_metadata_flush
);
417 stream
->waiting_on_metadata
= true;
418 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
420 ret
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
422 pthread_mutex_lock(&stream
->metadata_timer_lock
);
423 stream
->waiting_on_metadata
= false;
424 missed_metadata_flush
= stream
->missed_metadata_flush
;
425 if (missed_metadata_flush
) {
426 stream
->missed_metadata_flush
= false;
428 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
433 ret
= consumer_stream_send_index(stream
, subbuffer
, ctx
);
435 * Send the live inactivity beacon to handle the situation where
436 * the live timer is prevented from sampling this stream
437 * because the stream lock was being held while this stream is
438 * waiting on metadata. This ensures live viewer progress in the
439 * unlikely scenario where a live timer would be prevented from
440 * locking a stream lock repeatedly due to a steady flow of
441 * incoming metadata, for a stream which is mostly inactive.
443 * It is important to send the inactivity beacon packet to
444 * relayd _after_ sending the index associated with the data
445 * that was just sent, otherwise this can cause live viewers to
446 * observe timestamps going backwards between an inactivity
447 * beacon and a following trace packet.
449 if (missed_metadata_flush
) {
450 (void) stream
->read_subbuffer_ops
.send_live_beacon(stream
);
457 * Check if the local version of the metadata stream matches with the version
458 * of the metadata stream in the kernel. If it was updated, set the reset flag
461 static int metadata_stream_check_version(struct lttng_consumer_stream
*stream
,
462 const struct stream_subbuffer
*subbuffer
)
464 if (stream
->metadata_version
== subbuffer
->info
.metadata
.version
) {
468 DBG("New metadata version detected");
469 consumer_stream_metadata_set_version(stream
, subbuffer
->info
.metadata
.version
);
471 if (stream
->read_subbuffer_ops
.reset_metadata
) {
472 stream
->read_subbuffer_ops
.reset_metadata(stream
);
479 static bool stream_is_rotating_to_null_chunk(const struct lttng_consumer_stream
*stream
)
481 bool rotating_to_null_chunk
= false;
483 if (stream
->rotate_position
== -1ULL) {
484 /* No rotation ongoing. */
488 if (stream
->trace_chunk
== stream
->chan
->trace_chunk
|| !stream
->chan
->trace_chunk
) {
489 rotating_to_null_chunk
= true;
492 return rotating_to_null_chunk
;
495 enum consumer_stream_open_packet_status
496 consumer_stream_open_packet(struct lttng_consumer_stream
*stream
)
499 enum consumer_stream_open_packet_status status
;
500 unsigned long produced_pos_before
, produced_pos_after
;
502 ret
= lttng_consumer_sample_snapshot_positions(stream
);
504 ERR("Failed to snapshot positions before post-rotation empty packet flush: stream id = %" PRIu64
505 ", channel name = %s, session id = %" PRIu64
,
508 stream
->chan
->session_id
);
509 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
513 ret
= lttng_consumer_get_produced_snapshot(stream
, &produced_pos_before
);
515 ERR("Failed to read produced position before post-rotation empty packet flush: stream id = %" PRIu64
516 ", channel name = %s, session id = %" PRIu64
,
519 stream
->chan
->session_id
);
520 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
524 ret
= consumer_stream_flush_buffer(stream
, false);
526 ERR("Failed to flush an empty packet at rotation point: stream id = %" PRIu64
527 ", channel name = %s, session id = %" PRIu64
,
530 stream
->chan
->session_id
);
531 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
535 ret
= lttng_consumer_sample_snapshot_positions(stream
);
537 ERR("Failed to snapshot positions after post-rotation empty packet flush: stream id = %" PRIu64
538 ", channel name = %s, session id = %" PRIu64
,
541 stream
->chan
->session_id
);
542 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
546 ret
= lttng_consumer_get_produced_snapshot(stream
, &produced_pos_after
);
548 ERR("Failed to read produced position after post-rotation empty packet flush: stream id = %" PRIu64
549 ", channel name = %s, session id = %" PRIu64
,
552 stream
->chan
->session_id
);
553 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
558 * Determine if the flush had an effect by comparing the produced
559 * positons before and after the flush.
561 status
= produced_pos_before
!= produced_pos_after
?
562 CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
:
563 CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE
;
564 if (status
== CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
) {
565 stream
->opened_packet_in_current_trace_chunk
= true;
573 * An attempt to open a new packet is performed after a rotation completes to
574 * get a begin timestamp as close as possible to the rotation point.
576 * However, that initial attempt at opening a packet can fail due to a full
577 * ring-buffer. In that case, a second attempt is performed after consuming
578 * a packet since that will have freed enough space in the ring-buffer.
580 static int post_consume_open_new_packet(struct lttng_consumer_stream
*stream
,
581 const struct stream_subbuffer
*subbuffer
582 __attribute__((unused
)),
583 struct lttng_consumer_local_data
*ctx
584 __attribute__((unused
)))
588 if (!stream
->opened_packet_in_current_trace_chunk
&& stream
->trace_chunk
&&
589 !stream_is_rotating_to_null_chunk(stream
)) {
590 const enum consumer_stream_open_packet_status status
=
591 consumer_stream_open_packet(stream
);
594 case CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
:
595 DBG("Opened a packet after consuming a packet rotation: stream id = %" PRIu64
596 ", channel name = %s, session id = %" PRIu64
,
599 stream
->chan
->session_id
);
600 stream
->opened_packet_in_current_trace_chunk
= true;
602 case CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE
:
604 * Can't open a packet as there is no space left.
605 * This means that new events were produced, resulting
606 * in a packet being opened, which is what we want
609 DBG("No space left to open a packet after consuming a packet: stream id = %" PRIu64
610 ", channel name = %s, session id = %" PRIu64
,
613 stream
->chan
->session_id
);
614 stream
->opened_packet_in_current_trace_chunk
= true;
616 case CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
:
617 /* Logged by callee. */
624 stream
->opened_packet_in_current_trace_chunk
= true;
631 struct lttng_consumer_stream
*consumer_stream_create(struct lttng_consumer_channel
*channel
,
632 uint64_t channel_key
,
634 const char *channel_name
,
637 struct lttng_trace_chunk
*trace_chunk
,
640 enum consumer_channel_type type
,
641 unsigned int monitor
)
644 struct lttng_consumer_stream
*stream
;
645 lttng::urcu::read_lock_guard read_lock
;
647 stream
= zmalloc
<lttng_consumer_stream
>();
648 if (stream
== nullptr) {
649 PERROR("malloc struct lttng_consumer_stream");
654 if (trace_chunk
&& !lttng_trace_chunk_get(trace_chunk
)) {
655 ERR("Failed to acquire trace chunk reference during the creation of a stream");
660 stream
->send_node
= CDS_LIST_HEAD_INIT(stream
->send_node
);
661 stream
->chan
= channel
;
662 stream
->key
= stream_key
;
663 stream
->trace_chunk
= trace_chunk
;
665 stream
->out_fd_offset
= 0;
666 stream
->output_written
= 0;
667 stream
->net_seq_idx
= relayd_id
;
668 stream
->session_id
= session_id
;
669 stream
->monitor
= monitor
;
670 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
671 stream
->index_file
= nullptr;
672 stream
->last_sequence_number
= -1ULL;
673 stream
->rotate_position
= -1ULL;
674 /* Buffer is created with an open packet. */
675 stream
->opened_packet_in_current_trace_chunk
= true;
676 pthread_mutex_init(&stream
->lock
, nullptr);
677 pthread_mutex_init(&stream
->metadata_timer_lock
, nullptr);
679 /* If channel is the metadata, flag this stream as metadata. */
680 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
681 stream
->metadata_flag
= 1;
682 /* Metadata is flat out. */
683 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
684 /* Live rendez-vous point. */
685 pthread_cond_init(&stream
->metadata_rdv
, nullptr);
686 pthread_mutex_init(&stream
->metadata_rdv_lock
, nullptr);
688 /* Format stream name to <channel_name>_<cpu_number> */
689 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d", channel_name
, cpu
);
691 PERROR("snprintf stream name");
696 switch (channel
->output
) {
697 case CONSUMER_CHANNEL_SPLICE
:
698 stream
->output
= LTTNG_EVENT_SPLICE
;
699 ret
= utils_create_pipe(stream
->splice_pipe
);
704 case CONSUMER_CHANNEL_MMAP
:
705 stream
->output
= LTTNG_EVENT_MMAP
;
711 /* Key is always the wait_fd for streams. */
712 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
714 /* Init node per channel id key */
715 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
717 /* Init session id node with the stream session id */
718 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
720 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
" relayd_id %" PRIu64
721 ", session_id %" PRIu64
,
728 lttng_dynamic_array_init(
729 &stream
->read_subbuffer_ops
.post_consume_cbs
, sizeof(post_consume_cb
), nullptr);
731 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
732 stream
->read_subbuffer_ops
.lock
= consumer_stream_metadata_lock_all
;
733 stream
->read_subbuffer_ops
.unlock
= consumer_stream_metadata_unlock_all
;
734 stream
->read_subbuffer_ops
.assert_locked
=
735 consumer_stream_metadata_assert_locked_all
;
736 stream
->read_subbuffer_ops
.pre_consume_subbuffer
= metadata_stream_check_version
;
738 const post_consume_cb post_consume_index_op
= channel
->is_live
?
739 consumer_stream_sync_metadata_index
:
740 consumer_stream_send_index
;
741 const post_consume_cb post_consume_open_new_packet_
= post_consume_open_new_packet
;
743 ret
= lttng_dynamic_array_add_element(&stream
->read_subbuffer_ops
.post_consume_cbs
,
744 &post_consume_index_op
);
746 PERROR("Failed to add `send index` callback to stream's post consumption callbacks");
750 ret
= lttng_dynamic_array_add_element(&stream
->read_subbuffer_ops
.post_consume_cbs
,
751 &post_consume_open_new_packet_
);
753 PERROR("Failed to add `open new packet` callback to stream's post consumption callbacks");
757 stream
->read_subbuffer_ops
.lock
= consumer_stream_data_lock_all
;
758 stream
->read_subbuffer_ops
.unlock
= consumer_stream_data_unlock_all
;
759 stream
->read_subbuffer_ops
.assert_locked
= consumer_stream_data_assert_locked_all
;
760 stream
->read_subbuffer_ops
.pre_consume_subbuffer
= consumer_stream_update_stats
;
763 if (channel
->output
== CONSUMER_CHANNEL_MMAP
) {
764 stream
->read_subbuffer_ops
.consume_subbuffer
= consumer_stream_consume_mmap
;
766 stream
->read_subbuffer_ops
.consume_subbuffer
= consumer_stream_consume_splice
;
772 lttng_trace_chunk_put(stream
->trace_chunk
);
773 lttng_dynamic_array_reset(&stream
->read_subbuffer_ops
.post_consume_cbs
);
783 * Close stream on the relayd side. This call can destroy a relayd if the
784 * conditions are met.
786 * A RCU read side lock MUST be acquired if the relayd object was looked up in
787 * a hash table before calling this.
789 void consumer_stream_relayd_close(struct lttng_consumer_stream
*stream
,
790 struct consumer_relayd_sock_pair
*relayd
)
794 LTTNG_ASSERT(stream
);
795 LTTNG_ASSERT(relayd
);
797 if (stream
->sent_to_relayd
) {
798 uatomic_dec(&relayd
->refcount
);
799 LTTNG_ASSERT(uatomic_read(&relayd
->refcount
) >= 0);
802 /* Closing streams requires to lock the control socket. */
803 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
804 ret
= relayd_send_close_stream(
805 &relayd
->control_sock
, stream
->relayd_stream_id
, stream
->next_net_seq_num
- 1);
806 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
808 ERR("Relayd send close stream failed. Cleaning up relayd %" PRIu64
".",
809 relayd
->net_seq_idx
);
810 lttng_consumer_cleanup_relayd(relayd
);
813 /* Both conditions are met, we destroy the relayd. */
814 if (uatomic_read(&relayd
->refcount
) == 0 && uatomic_read(&relayd
->destroy_flag
)) {
815 consumer_destroy_relayd(relayd
);
817 stream
->net_seq_idx
= (uint64_t) -1ULL;
818 stream
->sent_to_relayd
= 0;
822 * Close stream's file descriptors and, if needed, close stream also on the
825 * The consumer data lock MUST be acquired.
826 * The stream lock MUST be acquired.
828 void consumer_stream_close_output(struct lttng_consumer_stream
*stream
)
830 struct consumer_relayd_sock_pair
*relayd
;
832 LTTNG_ASSERT(stream
);
834 /* Close output fd. Could be a socket or local file at this point. */
835 if (stream
->out_fd
>= 0) {
836 const auto ret
= close(stream
->out_fd
);
838 PERROR("Failed to close stream output file descriptor");
844 if (stream
->index_file
) {
845 lttng_index_file_put(stream
->index_file
);
846 stream
->index_file
= nullptr;
849 lttng_trace_chunk_put(stream
->trace_chunk
);
850 stream
->trace_chunk
= nullptr;
852 /* Check and cleanup relayd if needed. */
853 lttng::urcu::read_lock_guard read_lock
;
854 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
855 if (relayd
!= nullptr) {
856 consumer_stream_relayd_close(stream
, relayd
);
857 stream
->net_seq_idx
= -1ULL;
862 * Delete the stream from all possible hash tables.
864 * The consumer data lock MUST be acquired.
865 * The stream lock MUST be acquired.
867 void consumer_stream_delete(struct lttng_consumer_stream
*stream
, struct lttng_ht
*ht
)
870 struct lttng_ht_iter iter
;
872 LTTNG_ASSERT(stream
);
873 /* Should NEVER be called not in monitor mode. */
874 LTTNG_ASSERT(stream
->chan
->monitor
);
876 lttng::urcu::read_lock_guard read_lock
;
879 iter
.iter
.node
= &stream
->node
.node
;
880 ret
= lttng_ht_del(ht
, &iter
);
884 /* Delete from stream per channel ID hash table. */
885 iter
.iter
.node
= &stream
->node_channel_id
.node
;
887 * The returned value is of no importance. Even if the node is NOT in the
888 * hash table, we continue since we may have been called by a code path
889 * that did not add the stream to a (all) hash table. Same goes for the
890 * next call ht del call.
892 (void) lttng_ht_del(the_consumer_data
.stream_per_chan_id_ht
, &iter
);
894 /* Delete from the global stream list. */
895 iter
.iter
.node
= &stream
->node_session_id
.node
;
896 /* See the previous ht del on why we ignore the returned value. */
897 (void) lttng_ht_del(the_consumer_data
.stream_list_ht
, &iter
);
899 if (!stream
->metadata_flag
) {
900 /* Decrement the stream count of the global consumer data. */
901 LTTNG_ASSERT(the_consumer_data
.stream_count
> 0);
902 the_consumer_data
.stream_count
--;
907 * Free the given stream within a RCU call.
909 void consumer_stream_free(struct lttng_consumer_stream
*stream
)
911 LTTNG_ASSERT(stream
);
913 metadata_bucket_destroy(stream
->metadata_bucket
);
914 call_rcu(&stream
->node
.head
, free_stream_rcu
);
918 * Destroy the stream's buffers of the tracer.
920 void consumer_stream_destroy_buffers(struct lttng_consumer_stream
*stream
)
922 LTTNG_ASSERT(stream
);
924 switch (the_consumer_data
.type
) {
925 case LTTNG_CONSUMER_KERNEL
:
926 if (stream
->mmap_base
!= nullptr) {
927 const auto ret
= munmap(stream
->mmap_base
, stream
->mmap_len
);
934 if (stream
->wait_fd
>= 0) {
935 const auto ret
= close(stream
->wait_fd
);
941 stream
->wait_fd
= -1;
944 if (stream
->chan
->output
== CONSUMER_CHANNEL_SPLICE
) {
945 utils_close_pipe(stream
->splice_pipe
);
949 case LTTNG_CONSUMER32_UST
:
950 case LTTNG_CONSUMER64_UST
:
952 * Special case for the metadata since the wait fd is an internal pipe
953 * polled in the metadata thread.
955 if (stream
->metadata_flag
&& stream
->chan
->monitor
) {
956 const auto rpipe
= stream
->ust_metadata_poll_pipe
[0];
959 * This will stop the channel timer if one and close the write side
960 * of the metadata poll pipe.
962 lttng_ustconsumer_close_metadata(stream
->chan
);
964 const auto ret
= close(rpipe
);
967 PERROR("closing metadata pipe read side");
970 stream
->ust_metadata_poll_pipe
[0] = -1;
974 lttng_ustconsumer_del_stream(stream
);
977 ERR("Unknown consumer_data type");
983 * Destroy and close a already created stream.
985 static void destroy_close_stream(struct lttng_consumer_stream
*stream
)
987 LTTNG_ASSERT(stream
);
989 DBG("Consumer stream destroy monitored key: %" PRIu64
, stream
->key
);
991 /* Destroy tracer buffers of the stream. */
992 consumer_stream_destroy_buffers(stream
);
993 /* Close down everything including the relayd if one. */
994 consumer_stream_close_output(stream
);
998 * Decrement the stream's channel refcount and if down to 0, return the channel
999 * pointer so it can be destroyed by the caller or NULL if not.
1001 static struct lttng_consumer_channel
*unref_channel(struct lttng_consumer_stream
*stream
)
1003 struct lttng_consumer_channel
*free_chan
= nullptr;
1005 LTTNG_ASSERT(stream
);
1006 LTTNG_ASSERT(stream
->chan
);
1008 /* Update refcount of channel and see if we need to destroy it. */
1009 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1) &&
1010 !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
1011 free_chan
= stream
->chan
;
1018 * Destroy a stream completely. This will delete, close and free the stream.
1019 * Once return, the stream is NO longer usable. Its channel may get destroyed
1020 * if conditions are met for a monitored stream.
1022 * This MUST be called WITHOUT the consumer data and stream lock acquired if
1023 * the stream is in _monitor_ mode else it does not matter.
1025 void consumer_stream_destroy(struct lttng_consumer_stream
*stream
, struct lttng_ht
*ht
)
1027 LTTNG_ASSERT(stream
);
1029 cds_list_del_init(&stream
->send_node
);
1031 /* Stream is in monitor mode. */
1032 if (stream
->monitor
) {
1033 struct lttng_consumer_channel
*free_chan
= nullptr;
1036 * This means that the stream was successfully removed from the streams
1037 * list of the channel and sent to the right thread managing this
1038 * stream thus being globally visible.
1040 if (stream
->globally_visible
) {
1041 pthread_mutex_lock(&the_consumer_data
.lock
);
1042 pthread_mutex_lock(&stream
->chan
->lock
);
1044 pthread_mutex_lock(&stream
->lock
);
1045 /* Remove every reference of the stream in the consumer. */
1046 consumer_stream_delete(stream
, ht
);
1048 destroy_close_stream(stream
);
1050 /* Update channel's refcount of the stream. */
1051 free_chan
= unref_channel(stream
);
1053 /* Indicates that the consumer data state MUST be updated after this. */
1054 the_consumer_data
.need_update
= 1;
1056 pthread_mutex_unlock(&stream
->lock
);
1057 pthread_mutex_unlock(&stream
->chan
->lock
);
1058 pthread_mutex_unlock(&the_consumer_data
.lock
);
1061 * If the stream is not visible globally, this needs to be done
1062 * outside of the consumer data lock section.
1064 destroy_close_stream(stream
);
1065 free_chan
= unref_channel(stream
);
1069 consumer_del_channel(free_chan
);
1072 destroy_close_stream(stream
);
1075 /* Free stream within a RCU call. */
1076 lttng_trace_chunk_put(stream
->trace_chunk
);
1077 stream
->trace_chunk
= nullptr;
1078 lttng_dynamic_array_reset(&stream
->read_subbuffer_ops
.post_consume_cbs
);
1079 consumer_stream_free(stream
);
1083 * Write index of a specific stream either on the relayd or local disk.
1085 * Return 0 on success or else a negative value.
1087 int consumer_stream_write_index(struct lttng_consumer_stream
*stream
,
1088 struct ctf_packet_index
*element
)
1092 LTTNG_ASSERT(stream
);
1093 LTTNG_ASSERT(element
);
1095 lttng::urcu::read_lock_guard read_lock
;
1096 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1097 struct consumer_relayd_sock_pair
*relayd
;
1098 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1100 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1101 ret
= relayd_send_index(&relayd
->control_sock
,
1103 stream
->relayd_stream_id
,
1104 stream
->next_net_seq_num
- 1);
1107 * Communication error with lttng-relayd,
1108 * perform cleanup now
1110 ERR("Relayd send index failed. Cleaning up relayd %" PRIu64
".",
1111 relayd
->net_seq_idx
);
1112 lttng_consumer_cleanup_relayd(relayd
);
1115 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1117 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't write index.",
1119 stream
->net_seq_idx
);
1123 if (lttng_index_file_write(stream
->index_file
, element
)) {
1137 int consumer_stream_create_output_files(struct lttng_consumer_stream
*stream
, bool create_index
)
1140 enum lttng_trace_chunk_status chunk_status
;
1141 const int flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
1142 const mode_t mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
;
1143 char stream_path
[LTTNG_PATH_MAX
];
1145 ASSERT_LOCKED(stream
->lock
);
1146 LTTNG_ASSERT(stream
->trace_chunk
);
1148 ret
= utils_stream_file_path(stream
->chan
->pathname
,
1150 stream
->chan
->tracefile_size
,
1151 stream
->tracefile_count_current
,
1154 sizeof(stream_path
));
1159 if (stream
->out_fd
>= 0) {
1160 ret
= close(stream
->out_fd
);
1162 PERROR("Failed to close stream file \"%s\"", stream
->name
);
1165 stream
->out_fd
= -1;
1168 DBG("Opening stream output file \"%s\"", stream_path
);
1169 chunk_status
= lttng_trace_chunk_open_file(
1170 stream
->trace_chunk
, stream_path
, flags
, mode
, &stream
->out_fd
, false);
1171 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1172 ERR("Failed to open stream file \"%s\"", stream
->name
);
1177 if (!stream
->metadata_flag
&& (create_index
|| stream
->index_file
)) {
1178 if (stream
->index_file
) {
1179 lttng_index_file_put(stream
->index_file
);
1182 lttng_index_file_create_from_trace_chunk(stream
->trace_chunk
,
1183 stream
->chan
->pathname
,
1185 stream
->chan
->tracefile_size
,
1186 stream
->tracefile_count_current
,
1190 &stream
->index_file
);
1191 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1197 /* Reset current size because we just perform a rotation. */
1198 stream
->tracefile_size_current
= 0;
1199 stream
->out_fd_offset
= 0;
1204 int consumer_stream_rotate_output_files(struct lttng_consumer_stream
*stream
)
1208 stream
->tracefile_count_current
++;
1209 if (stream
->chan
->tracefile_count
> 0) {
1210 stream
->tracefile_count_current
%= stream
->chan
->tracefile_count
;
1213 DBG("Rotating output files of stream \"%s\"", stream
->name
);
1214 ret
= consumer_stream_create_output_files(stream
, true);
1223 bool consumer_stream_is_deleted(struct lttng_consumer_stream
*stream
)
1226 * This function does not take a const stream since
1227 * cds_lfht_is_node_deleted was not const before liburcu 0.12.
1229 LTTNG_ASSERT(stream
);
1230 return cds_lfht_is_node_deleted(&stream
->node
.node
);
1233 static ssize_t
metadata_bucket_flush(const struct stream_subbuffer
*buffer
, void *data
)
1236 struct lttng_consumer_stream
*stream
= (lttng_consumer_stream
*) data
;
1238 ret
= consumer_stream_consume_mmap(nullptr, stream
, buffer
);
1246 static ssize_t
metadata_bucket_consume(struct lttng_consumer_local_data
*unused
1247 __attribute__((unused
)),
1248 struct lttng_consumer_stream
*stream
,
1249 const struct stream_subbuffer
*subbuffer
)
1252 enum metadata_bucket_status status
;
1254 status
= metadata_bucket_fill(stream
->metadata_bucket
, subbuffer
);
1256 case METADATA_BUCKET_STATUS_OK
:
1257 /* Return consumed size. */
1258 ret
= subbuffer
->buffer
.buffer
.size
;
1267 int consumer_stream_enable_metadata_bucketization(struct lttng_consumer_stream
*stream
)
1271 LTTNG_ASSERT(stream
->metadata_flag
);
1272 LTTNG_ASSERT(!stream
->metadata_bucket
);
1273 LTTNG_ASSERT(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1275 stream
->metadata_bucket
= metadata_bucket_create(metadata_bucket_flush
, stream
);
1276 if (!stream
->metadata_bucket
) {
1281 stream
->read_subbuffer_ops
.consume_subbuffer
= metadata_bucket_consume
;
1286 void consumer_stream_metadata_set_version(struct lttng_consumer_stream
*stream
,
1287 uint64_t new_version
)
1289 LTTNG_ASSERT(new_version
> stream
->metadata_version
);
1290 stream
->metadata_version
= new_version
;
1291 stream
->reset_metadata_flag
= 1;
1293 if (stream
->metadata_bucket
) {
1294 metadata_bucket_reset(stream
->metadata_bucket
);
1298 int consumer_stream_flush_buffer(struct lttng_consumer_stream
*stream
, bool producer_active
)
1302 switch (the_consumer_data
.type
) {
1303 case LTTNG_CONSUMER_KERNEL
:
1304 if (producer_active
) {
1305 ret
= kernctl_buffer_flush(stream
->wait_fd
);
1307 ERR("Failed to flush kernel stream");
1311 ret
= kernctl_buffer_flush_empty(stream
->wait_fd
);
1314 * Doing a buffer flush which does not take into
1315 * account empty packets. This is not perfect,
1316 * but required as a fall-back when
1317 * "flush_empty" is not implemented by
1320 ret
= kernctl_buffer_flush(stream
->wait_fd
);
1322 ERR("Failed to flush kernel stream");
1328 case LTTNG_CONSUMER32_UST
:
1329 case LTTNG_CONSUMER64_UST
:
1330 ret
= lttng_ustconsumer_flush_buffer(stream
, (int) producer_active
);
1333 ERR("Unknown consumer_data type");