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>
32 * RCU call to free stream. MUST only be used with call_rcu().
34 static void free_stream_rcu(struct rcu_head
*head
)
36 struct lttng_ht_node_u64
*node
= lttng::utils::container_of(head
, <tng_ht_node_u64::head
);
37 struct lttng_consumer_stream
*stream
=
38 lttng::utils::container_of(node
, <tng_consumer_stream::node
);
40 pthread_mutex_destroy(&stream
->lock
);
44 static void consumer_stream_data_lock_all(struct lttng_consumer_stream
*stream
)
46 pthread_mutex_lock(&stream
->chan
->lock
);
47 pthread_mutex_lock(&stream
->lock
);
50 static void consumer_stream_data_unlock_all(struct lttng_consumer_stream
*stream
)
52 pthread_mutex_unlock(&stream
->lock
);
53 pthread_mutex_unlock(&stream
->chan
->lock
);
56 static void consumer_stream_data_assert_locked_all(struct lttng_consumer_stream
*stream
)
58 ASSERT_LOCKED(stream
->lock
);
59 ASSERT_LOCKED(stream
->chan
->lock
);
62 static void consumer_stream_metadata_lock_all(struct lttng_consumer_stream
*stream
)
64 consumer_stream_data_lock_all(stream
);
65 pthread_mutex_lock(&stream
->metadata_rdv_lock
);
68 static void consumer_stream_metadata_unlock_all(struct lttng_consumer_stream
*stream
)
70 pthread_mutex_unlock(&stream
->metadata_rdv_lock
);
71 consumer_stream_data_unlock_all(stream
);
74 static void consumer_stream_metadata_assert_locked_all(struct lttng_consumer_stream
*stream
)
76 ASSERT_LOCKED(stream
->metadata_rdv_lock
);
77 consumer_stream_data_assert_locked_all(stream
);
80 /* Only used for data streams. */
81 static int consumer_stream_update_stats(struct lttng_consumer_stream
*stream
,
82 const struct stream_subbuffer
*subbuf
)
85 uint64_t sequence_number
;
86 const uint64_t discarded_events
= subbuf
->info
.data
.events_discarded
;
88 if (!subbuf
->info
.data
.sequence_number
.is_set
) {
89 /* Command not supported by the tracer. */
90 sequence_number
= -1ULL;
91 stream
->sequence_number_unavailable
= true;
93 sequence_number
= subbuf
->info
.data
.sequence_number
.value
;
97 * Start the sequence when we extract the first packet in case we don't
98 * start at 0 (for example if a consumer is not connected to the
99 * session immediately after the beginning).
101 if (stream
->last_sequence_number
== -1ULL) {
102 stream
->last_sequence_number
= sequence_number
;
103 } else if (sequence_number
> stream
->last_sequence_number
) {
104 stream
->chan
->lost_packets
+= sequence_number
- stream
->last_sequence_number
- 1;
106 /* seq <= last_sequence_number */
107 ERR("Sequence number inconsistent : prev = %" PRIu64
", current = %" PRIu64
,
108 stream
->last_sequence_number
,
113 stream
->last_sequence_number
= sequence_number
;
115 if (discarded_events
< stream
->last_discarded_events
) {
117 * Overflow has occurred. We assume only one wrap-around
120 stream
->chan
->discarded_events
+= (1ULL << (CAA_BITS_PER_LONG
- 1)) -
121 stream
->last_discarded_events
+ discarded_events
;
123 stream
->chan
->discarded_events
+= discarded_events
- stream
->last_discarded_events
;
125 stream
->last_discarded_events
= discarded_events
;
132 static void ctf_packet_index_populate(struct ctf_packet_index
*index
,
134 const struct stream_subbuffer
*subbuffer
)
136 *index
= (typeof(*index
)){
137 .offset
= htobe64(offset
),
138 .packet_size
= htobe64(subbuffer
->info
.data
.packet_size
),
139 .content_size
= htobe64(subbuffer
->info
.data
.content_size
),
140 .timestamp_begin
= htobe64(subbuffer
->info
.data
.timestamp_begin
),
141 .timestamp_end
= htobe64(subbuffer
->info
.data
.timestamp_end
),
142 .events_discarded
= htobe64(subbuffer
->info
.data
.events_discarded
),
143 .stream_id
= htobe64(subbuffer
->info
.data
.stream_id
),
144 .stream_instance_id
=
145 htobe64(subbuffer
->info
.data
.stream_instance_id
.is_set
?
146 subbuffer
->info
.data
.stream_instance_id
.value
:
148 .packet_seq_num
= htobe64(subbuffer
->info
.data
.sequence_number
.is_set
?
149 subbuffer
->info
.data
.sequence_number
.value
:
154 static ssize_t
consumer_stream_consume_mmap(struct lttng_consumer_local_data
*ctx
155 __attribute__((unused
)),
156 struct lttng_consumer_stream
*stream
,
157 const struct stream_subbuffer
*subbuffer
)
159 const unsigned long padding_size
=
160 subbuffer
->info
.data
.padded_subbuf_size
- subbuffer
->info
.data
.subbuf_size
;
161 const ssize_t written_bytes
= lttng_consumer_on_read_subbuffer_mmap(
162 stream
, &subbuffer
->buffer
.buffer
, padding_size
);
164 if (stream
->net_seq_idx
== -1ULL) {
166 * When writing on disk, check that only the subbuffer (no
167 * padding) was written to disk.
169 if (written_bytes
!= subbuffer
->info
.data
.padded_subbuf_size
) {
170 DBG("Failed to write the entire padded subbuffer on disk (written_bytes: %zd, padded subbuffer size %lu)",
172 subbuffer
->info
.data
.padded_subbuf_size
);
176 * When streaming over the network, check that the entire
177 * subbuffer including padding was successfully written.
179 if (written_bytes
!= subbuffer
->info
.data
.subbuf_size
) {
180 DBG("Failed to write only the subbuffer over the network (written_bytes: %zd, subbuffer size %lu)",
182 subbuffer
->info
.data
.subbuf_size
);
187 * If `lttng_consumer_on_read_subbuffer_mmap()` returned an error, pass
188 * it along to the caller, else return zero.
190 if (written_bytes
< 0) {
191 ERR("Error reading mmap subbuffer: %zd", written_bytes
);
194 return written_bytes
;
197 static ssize_t
consumer_stream_consume_splice(struct lttng_consumer_local_data
*ctx
,
198 struct lttng_consumer_stream
*stream
,
199 const struct stream_subbuffer
*subbuffer
)
201 const ssize_t written_bytes
= lttng_consumer_on_read_subbuffer_splice(
202 ctx
, stream
, subbuffer
->info
.data
.padded_subbuf_size
, 0);
204 if (written_bytes
!= subbuffer
->info
.data
.padded_subbuf_size
) {
205 DBG("Failed to write the entire padded subbuffer (written_bytes: %zd, padded subbuffer size %lu)",
207 subbuffer
->info
.data
.padded_subbuf_size
);
211 * If `lttng_consumer_on_read_subbuffer_splice()` returned an error,
212 * pass it along to the caller, else return zero.
214 if (written_bytes
< 0) {
215 ERR("Error reading splice subbuffer: %zd", written_bytes
);
218 return written_bytes
;
221 static int consumer_stream_send_index(struct lttng_consumer_stream
*stream
,
222 const struct stream_subbuffer
*subbuffer
,
223 struct lttng_consumer_local_data
*ctx
__attribute__((unused
)))
225 off_t packet_offset
= 0;
226 struct ctf_packet_index index
= {};
229 * This is called after consuming the sub-buffer; substract the
230 * effect this sub-buffer from the offset.
232 if (stream
->net_seq_idx
== (uint64_t) -1ULL) {
233 packet_offset
= stream
->out_fd_offset
- subbuffer
->info
.data
.padded_subbuf_size
;
236 ctf_packet_index_populate(&index
, packet_offset
, subbuffer
);
237 return consumer_stream_write_index(stream
, &index
);
241 * Actually do the metadata sync using the given metadata stream.
243 * Return 0 on success else a negative value. ENODATA can be returned also
244 * indicating that there is no metadata available for that stream.
246 static int do_sync_metadata(struct lttng_consumer_stream
*metadata
,
247 struct lttng_consumer_local_data
*ctx
)
250 enum sync_metadata_status status
;
252 LTTNG_ASSERT(metadata
);
253 LTTNG_ASSERT(metadata
->metadata_flag
);
257 * In UST, since we have to write the metadata from the cache packet
258 * by packet, we might need to start this procedure multiple times
259 * until all the metadata from the cache has been extracted.
264 * - Lock the metadata stream
265 * - Check if metadata stream node was deleted before locking.
266 * - if yes, release and return success
267 * - Check if new metadata is ready (flush + snapshot pos)
268 * - If nothing : release and return.
269 * - Lock the metadata_rdv_lock
270 * - Unlock the metadata stream
271 * - cond_wait on metadata_rdv to wait the wakeup from the
273 * - Unlock the metadata_rdv_lock
275 pthread_mutex_lock(&metadata
->lock
);
278 * There is a possibility that we were able to acquire a reference on the
279 * stream from the RCU hash table but between then and now, the node might
280 * have been deleted just before the lock is acquired. Thus, after locking,
281 * we make sure the metadata node has not been deleted which means that the
282 * buffers are closed.
284 * In that case, there is no need to sync the metadata hence returning a
285 * success return code.
287 ret
= cds_lfht_is_node_deleted(&metadata
->node
.node
);
290 goto end_unlock_mutex
;
294 case LTTNG_CONSUMER_KERNEL
:
296 * Empty the metadata cache and flush the current stream.
298 status
= lttng_kconsumer_sync_metadata(metadata
);
300 case LTTNG_CONSUMER32_UST
:
301 case LTTNG_CONSUMER64_UST
:
303 * Ask the sessiond if we have new metadata waiting and update the
304 * consumer metadata cache.
306 status
= lttng_ustconsumer_sync_metadata(ctx
, metadata
);
313 case SYNC_METADATA_STATUS_NEW_DATA
:
315 case SYNC_METADATA_STATUS_NO_DATA
:
317 goto end_unlock_mutex
;
318 case SYNC_METADATA_STATUS_ERROR
:
320 goto end_unlock_mutex
;
326 * At this point, new metadata have been flushed, so we wait on the
327 * rendez-vous point for the metadata thread to wake us up when it
328 * finishes consuming the metadata and continue execution.
331 pthread_mutex_lock(&metadata
->metadata_rdv_lock
);
334 * Release metadata stream lock so the metadata thread can process it.
336 pthread_mutex_unlock(&metadata
->lock
);
339 * Wait on the rendez-vous point. Once woken up, it means the metadata was
340 * consumed and thus synchronization is achieved.
342 pthread_cond_wait(&metadata
->metadata_rdv
, &metadata
->metadata_rdv_lock
);
343 pthread_mutex_unlock(&metadata
->metadata_rdv_lock
);
344 } while (status
== SYNC_METADATA_STATUS_NEW_DATA
);
350 pthread_mutex_unlock(&metadata
->lock
);
355 * Synchronize the metadata using a given session ID. A successful acquisition
356 * of a metadata stream will trigger a request to the session daemon and a
357 * snapshot so the metadata thread can consume it.
359 * This function call is a rendez-vous point between the metadata thread and
362 * Return 0 on success or else a negative value.
364 int consumer_stream_sync_metadata(struct lttng_consumer_local_data
*ctx
, uint64_t session_id
)
367 struct lttng_consumer_stream
*stream
= nullptr;
368 struct lttng_ht_iter iter
;
373 /* Ease our life a bit. */
374 ht
= the_consumer_data
.stream_list_ht
;
376 lttng::urcu::read_lock_guard read_lock
;
378 /* Search the metadata associated with the session id of the given stream. */
380 cds_lfht_for_each_entry_duplicate(ht
->ht
,
381 ht
->hash_fct(&session_id
, lttng_ht_seed
),
386 node_session_id
.node
)
388 if (!stream
->metadata_flag
) {
392 ret
= do_sync_metadata(stream
, ctx
);
399 * Force return code to 0 (success) since ret might be ENODATA for instance
400 * which is not an error but rather that we should come back.
408 static int consumer_stream_sync_metadata_index(struct lttng_consumer_stream
*stream
,
409 const struct stream_subbuffer
*subbuffer
,
410 struct lttng_consumer_local_data
*ctx
)
412 bool missed_metadata_flush
;
415 /* Block until all the metadata is sent. */
416 pthread_mutex_lock(&stream
->metadata_timer_lock
);
417 LTTNG_ASSERT(!stream
->missed_metadata_flush
);
418 stream
->waiting_on_metadata
= true;
419 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
421 ret
= consumer_stream_sync_metadata(ctx
, stream
->session_id
);
423 pthread_mutex_lock(&stream
->metadata_timer_lock
);
424 stream
->waiting_on_metadata
= false;
425 missed_metadata_flush
= stream
->missed_metadata_flush
;
426 if (missed_metadata_flush
) {
427 stream
->missed_metadata_flush
= false;
429 pthread_mutex_unlock(&stream
->metadata_timer_lock
);
434 ret
= consumer_stream_send_index(stream
, subbuffer
, ctx
);
436 * Send the live inactivity beacon to handle the situation where
437 * the live timer is prevented from sampling this stream
438 * because the stream lock was being held while this stream is
439 * waiting on metadata. This ensures live viewer progress in the
440 * unlikely scenario where a live timer would be prevented from
441 * locking a stream lock repeatedly due to a steady flow of
442 * incoming metadata, for a stream which is mostly inactive.
444 * It is important to send the inactivity beacon packet to
445 * relayd _after_ sending the index associated with the data
446 * that was just sent, otherwise this can cause live viewers to
447 * observe timestamps going backwards between an inactivity
448 * beacon and a following trace packet.
450 if (missed_metadata_flush
) {
451 (void) stream
->read_subbuffer_ops
.send_live_beacon(stream
);
458 * Check if the local version of the metadata stream matches with the version
459 * of the metadata stream in the kernel. If it was updated, set the reset flag
462 static int metadata_stream_check_version(struct lttng_consumer_stream
*stream
,
463 const struct stream_subbuffer
*subbuffer
)
465 if (stream
->metadata_version
== subbuffer
->info
.metadata
.version
) {
469 DBG("New metadata version detected");
470 consumer_stream_metadata_set_version(stream
, subbuffer
->info
.metadata
.version
);
472 if (stream
->read_subbuffer_ops
.reset_metadata
) {
473 stream
->read_subbuffer_ops
.reset_metadata(stream
);
480 static bool stream_is_rotating_to_null_chunk(const struct lttng_consumer_stream
*stream
)
482 bool rotating_to_null_chunk
= false;
484 if (stream
->rotate_position
== -1ULL) {
485 /* No rotation ongoing. */
489 if (stream
->trace_chunk
== stream
->chan
->trace_chunk
|| !stream
->chan
->trace_chunk
) {
490 rotating_to_null_chunk
= true;
493 return rotating_to_null_chunk
;
496 enum consumer_stream_open_packet_status
497 consumer_stream_open_packet(struct lttng_consumer_stream
*stream
)
500 enum consumer_stream_open_packet_status status
;
501 unsigned long produced_pos_before
, produced_pos_after
;
503 ret
= lttng_consumer_sample_snapshot_positions(stream
);
505 ERR("Failed to snapshot positions before post-rotation empty packet flush: stream id = %" PRIu64
506 ", channel name = %s, session id = %" PRIu64
,
509 stream
->chan
->session_id
);
510 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
514 ret
= lttng_consumer_get_produced_snapshot(stream
, &produced_pos_before
);
516 ERR("Failed to read produced position before post-rotation empty packet flush: stream id = %" PRIu64
517 ", channel name = %s, session id = %" PRIu64
,
520 stream
->chan
->session_id
);
521 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
525 ret
= consumer_stream_flush_buffer(stream
, false);
527 ERR("Failed to flush an empty packet at rotation point: stream id = %" PRIu64
528 ", channel name = %s, session id = %" PRIu64
,
531 stream
->chan
->session_id
);
532 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
536 ret
= lttng_consumer_sample_snapshot_positions(stream
);
538 ERR("Failed to snapshot positions after post-rotation empty packet flush: stream id = %" PRIu64
539 ", channel name = %s, session id = %" PRIu64
,
542 stream
->chan
->session_id
);
543 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
547 ret
= lttng_consumer_get_produced_snapshot(stream
, &produced_pos_after
);
549 ERR("Failed to read produced position after post-rotation empty packet flush: stream id = %" PRIu64
550 ", channel name = %s, session id = %" PRIu64
,
553 stream
->chan
->session_id
);
554 status
= CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
;
559 * Determine if the flush had an effect by comparing the produced
560 * positons before and after the flush.
562 status
= produced_pos_before
!= produced_pos_after
?
563 CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
:
564 CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE
;
565 if (status
== CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
) {
566 stream
->opened_packet_in_current_trace_chunk
= true;
574 * An attempt to open a new packet is performed after a rotation completes to
575 * get a begin timestamp as close as possible to the rotation point.
577 * However, that initial attempt at opening a packet can fail due to a full
578 * ring-buffer. In that case, a second attempt is performed after consuming
579 * a packet since that will have freed enough space in the ring-buffer.
581 static int post_consume_open_new_packet(struct lttng_consumer_stream
*stream
,
582 const struct stream_subbuffer
*subbuffer
583 __attribute__((unused
)),
584 struct lttng_consumer_local_data
*ctx
585 __attribute__((unused
)))
589 if (!stream
->opened_packet_in_current_trace_chunk
&& stream
->trace_chunk
&&
590 !stream_is_rotating_to_null_chunk(stream
)) {
591 const enum consumer_stream_open_packet_status status
=
592 consumer_stream_open_packet(stream
);
595 case CONSUMER_STREAM_OPEN_PACKET_STATUS_OPENED
:
596 DBG("Opened a packet after consuming a packet rotation: stream id = %" PRIu64
597 ", channel name = %s, session id = %" PRIu64
,
600 stream
->chan
->session_id
);
601 stream
->opened_packet_in_current_trace_chunk
= true;
603 case CONSUMER_STREAM_OPEN_PACKET_STATUS_NO_SPACE
:
605 * Can't open a packet as there is no space left.
606 * This means that new events were produced, resulting
607 * in a packet being opened, which is what we want
610 DBG("No space left to open a packet after consuming a packet: stream id = %" PRIu64
611 ", channel name = %s, session id = %" PRIu64
,
614 stream
->chan
->session_id
);
615 stream
->opened_packet_in_current_trace_chunk
= true;
617 case CONSUMER_STREAM_OPEN_PACKET_STATUS_ERROR
:
618 /* Logged by callee. */
625 stream
->opened_packet_in_current_trace_chunk
= true;
632 struct lttng_consumer_stream
*consumer_stream_create(struct lttng_consumer_channel
*channel
,
633 uint64_t channel_key
,
635 const char *channel_name
,
638 struct lttng_trace_chunk
*trace_chunk
,
641 enum consumer_channel_type type
,
642 unsigned int monitor
)
645 struct lttng_consumer_stream
*stream
;
646 lttng::urcu::read_lock_guard read_lock
;
648 stream
= zmalloc
<lttng_consumer_stream
>();
649 if (stream
== nullptr) {
650 PERROR("malloc struct lttng_consumer_stream");
655 if (trace_chunk
&& !lttng_trace_chunk_get(trace_chunk
)) {
656 ERR("Failed to acquire trace chunk reference during the creation of a stream");
661 stream
->send_node
= CDS_LIST_HEAD_INIT(stream
->send_node
);
662 stream
->chan
= channel
;
663 stream
->key
= stream_key
;
664 stream
->trace_chunk
= trace_chunk
;
666 stream
->out_fd_offset
= 0;
667 stream
->output_written
= 0;
668 stream
->net_seq_idx
= relayd_id
;
669 stream
->session_id
= session_id
;
670 stream
->monitor
= monitor
;
671 stream
->endpoint_status
= CONSUMER_ENDPOINT_ACTIVE
;
672 stream
->index_file
= nullptr;
673 stream
->last_sequence_number
= -1ULL;
674 stream
->rotate_position
= -1ULL;
675 /* Buffer is created with an open packet. */
676 stream
->opened_packet_in_current_trace_chunk
= true;
677 pthread_mutex_init(&stream
->lock
, nullptr);
678 pthread_mutex_init(&stream
->metadata_timer_lock
, nullptr);
680 /* If channel is the metadata, flag this stream as metadata. */
681 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
682 stream
->metadata_flag
= 1;
683 /* Metadata is flat out. */
684 strncpy(stream
->name
, DEFAULT_METADATA_NAME
, sizeof(stream
->name
));
685 /* Live rendez-vous point. */
686 pthread_cond_init(&stream
->metadata_rdv
, nullptr);
687 pthread_mutex_init(&stream
->metadata_rdv_lock
, nullptr);
689 /* Format stream name to <channel_name>_<cpu_number> */
690 ret
= snprintf(stream
->name
, sizeof(stream
->name
), "%s_%d", channel_name
, cpu
);
692 PERROR("snprintf stream name");
697 switch (channel
->output
) {
698 case CONSUMER_CHANNEL_SPLICE
:
699 stream
->output
= LTTNG_EVENT_SPLICE
;
700 ret
= utils_create_pipe(stream
->splice_pipe
);
705 case CONSUMER_CHANNEL_MMAP
:
706 stream
->output
= LTTNG_EVENT_MMAP
;
712 /* Key is always the wait_fd for streams. */
713 lttng_ht_node_init_u64(&stream
->node
, stream
->key
);
715 /* Init node per channel id key */
716 lttng_ht_node_init_u64(&stream
->node_channel_id
, channel_key
);
718 /* Init session id node with the stream session id */
719 lttng_ht_node_init_u64(&stream
->node_session_id
, stream
->session_id
);
721 DBG3("Allocated stream %s (key %" PRIu64
", chan_key %" PRIu64
" relayd_id %" PRIu64
722 ", session_id %" PRIu64
,
729 lttng_dynamic_array_init(
730 &stream
->read_subbuffer_ops
.post_consume_cbs
, sizeof(post_consume_cb
), nullptr);
732 if (type
== CONSUMER_CHANNEL_TYPE_METADATA
) {
733 stream
->read_subbuffer_ops
.lock
= consumer_stream_metadata_lock_all
;
734 stream
->read_subbuffer_ops
.unlock
= consumer_stream_metadata_unlock_all
;
735 stream
->read_subbuffer_ops
.assert_locked
=
736 consumer_stream_metadata_assert_locked_all
;
737 stream
->read_subbuffer_ops
.pre_consume_subbuffer
= metadata_stream_check_version
;
739 const post_consume_cb post_consume_index_op
= channel
->is_live
?
740 consumer_stream_sync_metadata_index
:
741 consumer_stream_send_index
;
742 const post_consume_cb post_consume_open_new_packet_
= post_consume_open_new_packet
;
744 ret
= lttng_dynamic_array_add_element(&stream
->read_subbuffer_ops
.post_consume_cbs
,
745 &post_consume_index_op
);
747 PERROR("Failed to add `send index` callback to stream's post consumption callbacks");
751 ret
= lttng_dynamic_array_add_element(&stream
->read_subbuffer_ops
.post_consume_cbs
,
752 &post_consume_open_new_packet_
);
754 PERROR("Failed to add `open new packet` callback to stream's post consumption callbacks");
758 stream
->read_subbuffer_ops
.lock
= consumer_stream_data_lock_all
;
759 stream
->read_subbuffer_ops
.unlock
= consumer_stream_data_unlock_all
;
760 stream
->read_subbuffer_ops
.assert_locked
= consumer_stream_data_assert_locked_all
;
761 stream
->read_subbuffer_ops
.pre_consume_subbuffer
= consumer_stream_update_stats
;
764 if (channel
->output
== CONSUMER_CHANNEL_MMAP
) {
765 stream
->read_subbuffer_ops
.consume_subbuffer
= consumer_stream_consume_mmap
;
767 stream
->read_subbuffer_ops
.consume_subbuffer
= consumer_stream_consume_splice
;
773 lttng_trace_chunk_put(stream
->trace_chunk
);
774 lttng_dynamic_array_reset(&stream
->read_subbuffer_ops
.post_consume_cbs
);
784 * Close stream on the relayd side. This call can destroy a relayd if the
785 * conditions are met.
787 * A RCU read side lock MUST be acquired if the relayd object was looked up in
788 * a hash table before calling this.
790 void consumer_stream_relayd_close(struct lttng_consumer_stream
*stream
,
791 struct consumer_relayd_sock_pair
*relayd
)
795 LTTNG_ASSERT(stream
);
796 LTTNG_ASSERT(relayd
);
798 if (stream
->sent_to_relayd
) {
799 uatomic_dec(&relayd
->refcount
);
800 LTTNG_ASSERT(uatomic_read(&relayd
->refcount
) >= 0);
803 /* Closing streams requires to lock the control socket. */
804 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
805 ret
= relayd_send_close_stream(
806 &relayd
->control_sock
, stream
->relayd_stream_id
, stream
->next_net_seq_num
- 1);
807 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
809 ERR("Relayd send close stream failed. Cleaning up relayd %" PRIu64
".",
810 relayd
->net_seq_idx
);
811 lttng_consumer_cleanup_relayd(relayd
);
814 /* Both conditions are met, we destroy the relayd. */
815 if (uatomic_read(&relayd
->refcount
) == 0 && uatomic_read(&relayd
->destroy_flag
)) {
816 consumer_destroy_relayd(relayd
);
818 stream
->net_seq_idx
= (uint64_t) -1ULL;
819 stream
->sent_to_relayd
= 0;
823 * Close stream's file descriptors and, if needed, close stream also on the
826 * The consumer data lock MUST be acquired.
827 * The stream lock MUST be acquired.
829 void consumer_stream_close_output(struct lttng_consumer_stream
*stream
)
831 struct consumer_relayd_sock_pair
*relayd
;
833 LTTNG_ASSERT(stream
);
835 /* Close output fd. Could be a socket or local file at this point. */
836 if (stream
->out_fd
>= 0) {
837 const auto ret
= close(stream
->out_fd
);
839 PERROR("Failed to close stream output file descriptor");
845 if (stream
->index_file
) {
846 lttng_index_file_put(stream
->index_file
);
847 stream
->index_file
= nullptr;
850 lttng_trace_chunk_put(stream
->trace_chunk
);
851 stream
->trace_chunk
= nullptr;
853 /* Check and cleanup relayd if needed. */
854 lttng::urcu::read_lock_guard read_lock
;
855 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
856 if (relayd
!= nullptr) {
857 consumer_stream_relayd_close(stream
, relayd
);
858 stream
->net_seq_idx
= -1ULL;
863 * Delete the stream from all possible hash tables.
865 * The consumer data lock MUST be acquired.
866 * The stream lock MUST be acquired.
868 void consumer_stream_delete(struct lttng_consumer_stream
*stream
, struct lttng_ht
*ht
)
871 struct lttng_ht_iter iter
;
873 LTTNG_ASSERT(stream
);
874 /* Should NEVER be called not in monitor mode. */
875 LTTNG_ASSERT(stream
->chan
->monitor
);
877 lttng::urcu::read_lock_guard read_lock
;
880 iter
.iter
.node
= &stream
->node
.node
;
881 ret
= lttng_ht_del(ht
, &iter
);
885 /* Delete from stream per channel ID hash table. */
886 iter
.iter
.node
= &stream
->node_channel_id
.node
;
888 * The returned value is of no importance. Even if the node is NOT in the
889 * hash table, we continue since we may have been called by a code path
890 * that did not add the stream to a (all) hash table. Same goes for the
891 * next call ht del call.
893 (void) lttng_ht_del(the_consumer_data
.stream_per_chan_id_ht
, &iter
);
895 /* Delete from the global stream list. */
896 iter
.iter
.node
= &stream
->node_session_id
.node
;
897 /* See the previous ht del on why we ignore the returned value. */
898 (void) lttng_ht_del(the_consumer_data
.stream_list_ht
, &iter
);
900 if (!stream
->metadata_flag
) {
901 /* Decrement the stream count of the global consumer data. */
902 LTTNG_ASSERT(the_consumer_data
.stream_count
> 0);
903 the_consumer_data
.stream_count
--;
908 * Free the given stream within a RCU call.
910 void consumer_stream_free(struct lttng_consumer_stream
*stream
)
912 LTTNG_ASSERT(stream
);
914 metadata_bucket_destroy(stream
->metadata_bucket
);
915 call_rcu(&stream
->node
.head
, free_stream_rcu
);
919 * Destroy the stream's buffers of the tracer.
921 void consumer_stream_destroy_buffers(struct lttng_consumer_stream
*stream
)
923 LTTNG_ASSERT(stream
);
925 switch (the_consumer_data
.type
) {
926 case LTTNG_CONSUMER_KERNEL
:
927 if (stream
->mmap_base
!= nullptr) {
928 const auto ret
= munmap(stream
->mmap_base
, stream
->mmap_len
);
935 if (stream
->wait_fd
>= 0) {
936 const auto ret
= close(stream
->wait_fd
);
942 stream
->wait_fd
= -1;
945 if (stream
->chan
->output
== CONSUMER_CHANNEL_SPLICE
) {
946 utils_close_pipe(stream
->splice_pipe
);
950 case LTTNG_CONSUMER32_UST
:
951 case LTTNG_CONSUMER64_UST
:
953 * Special case for the metadata since the wait fd is an internal pipe
954 * polled in the metadata thread.
956 if (stream
->metadata_flag
&& stream
->chan
->monitor
) {
957 const auto rpipe
= stream
->ust_metadata_poll_pipe
[0];
960 * This will stop the channel timer if one and close the write side
961 * of the metadata poll pipe.
963 lttng_ustconsumer_close_metadata(stream
->chan
);
965 const auto ret
= close(rpipe
);
968 PERROR("closing metadata pipe read side");
971 stream
->ust_metadata_poll_pipe
[0] = -1;
975 lttng_ustconsumer_del_stream(stream
);
978 ERR("Unknown consumer_data type");
984 * Destroy and close a already created stream.
986 static void destroy_close_stream(struct lttng_consumer_stream
*stream
)
988 LTTNG_ASSERT(stream
);
990 DBG("Consumer stream destroy monitored key: %" PRIu64
, stream
->key
);
992 /* Destroy tracer buffers of the stream. */
993 consumer_stream_destroy_buffers(stream
);
994 /* Close down everything including the relayd if one. */
995 consumer_stream_close_output(stream
);
999 * Decrement the stream's channel refcount and if down to 0, return the channel
1000 * pointer so it can be destroyed by the caller or NULL if not.
1002 static struct lttng_consumer_channel
*unref_channel(struct lttng_consumer_stream
*stream
)
1004 struct lttng_consumer_channel
*free_chan
= nullptr;
1006 LTTNG_ASSERT(stream
);
1007 LTTNG_ASSERT(stream
->chan
);
1009 /* Update refcount of channel and see if we need to destroy it. */
1010 if (!uatomic_sub_return(&stream
->chan
->refcount
, 1) &&
1011 !uatomic_read(&stream
->chan
->nb_init_stream_left
)) {
1012 free_chan
= stream
->chan
;
1019 * Destroy a stream completely. This will delete, close and free the stream.
1020 * Once return, the stream is NO longer usable. Its channel may get destroyed
1021 * if conditions are met for a monitored stream.
1023 * This MUST be called WITHOUT the consumer data and stream lock acquired if
1024 * the stream is in _monitor_ mode else it does not matter.
1026 void consumer_stream_destroy(struct lttng_consumer_stream
*stream
, struct lttng_ht
*ht
)
1028 LTTNG_ASSERT(stream
);
1030 cds_list_del_init(&stream
->send_node
);
1032 /* Stream is in monitor mode. */
1033 if (stream
->monitor
) {
1034 struct lttng_consumer_channel
*free_chan
= nullptr;
1037 * This means that the stream was successfully removed from the streams
1038 * list of the channel and sent to the right thread managing this
1039 * stream thus being globally visible.
1041 if (stream
->globally_visible
) {
1042 pthread_mutex_lock(&the_consumer_data
.lock
);
1043 pthread_mutex_lock(&stream
->chan
->lock
);
1045 pthread_mutex_lock(&stream
->lock
);
1046 /* Remove every reference of the stream in the consumer. */
1047 consumer_stream_delete(stream
, ht
);
1049 destroy_close_stream(stream
);
1051 /* Update channel's refcount of the stream. */
1052 free_chan
= unref_channel(stream
);
1054 /* Indicates that the consumer data state MUST be updated after this. */
1055 the_consumer_data
.need_update
= 1;
1057 pthread_mutex_unlock(&stream
->lock
);
1058 pthread_mutex_unlock(&stream
->chan
->lock
);
1059 pthread_mutex_unlock(&the_consumer_data
.lock
);
1062 * If the stream is not visible globally, this needs to be done
1063 * outside of the consumer data lock section.
1065 destroy_close_stream(stream
);
1066 free_chan
= unref_channel(stream
);
1070 consumer_del_channel(free_chan
);
1073 destroy_close_stream(stream
);
1076 /* Free stream within a RCU call. */
1077 lttng_trace_chunk_put(stream
->trace_chunk
);
1078 stream
->trace_chunk
= nullptr;
1079 lttng_dynamic_array_reset(&stream
->read_subbuffer_ops
.post_consume_cbs
);
1080 consumer_stream_free(stream
);
1084 * Write index of a specific stream either on the relayd or local disk.
1086 * Return 0 on success or else a negative value.
1088 int consumer_stream_write_index(struct lttng_consumer_stream
*stream
,
1089 struct ctf_packet_index
*element
)
1093 LTTNG_ASSERT(stream
);
1094 LTTNG_ASSERT(element
);
1096 lttng::urcu::read_lock_guard read_lock
;
1097 if (stream
->net_seq_idx
!= (uint64_t) -1ULL) {
1098 struct consumer_relayd_sock_pair
*relayd
;
1099 relayd
= consumer_find_relayd(stream
->net_seq_idx
);
1101 pthread_mutex_lock(&relayd
->ctrl_sock_mutex
);
1102 ret
= relayd_send_index(&relayd
->control_sock
,
1104 stream
->relayd_stream_id
,
1105 stream
->next_net_seq_num
- 1);
1108 * Communication error with lttng-relayd,
1109 * perform cleanup now
1111 ERR("Relayd send index failed. Cleaning up relayd %" PRIu64
".",
1112 relayd
->net_seq_idx
);
1113 lttng_consumer_cleanup_relayd(relayd
);
1116 pthread_mutex_unlock(&relayd
->ctrl_sock_mutex
);
1118 ERR("Stream %" PRIu64
" relayd ID %" PRIu64
" unknown. Can't write index.",
1120 stream
->net_seq_idx
);
1124 if (lttng_index_file_write(stream
->index_file
, element
)) {
1138 int consumer_stream_create_output_files(struct lttng_consumer_stream
*stream
, bool create_index
)
1141 enum lttng_trace_chunk_status chunk_status
;
1142 const int flags
= O_WRONLY
| O_CREAT
| O_TRUNC
;
1143 const mode_t mode
= S_IRUSR
| S_IWUSR
| S_IRGRP
| S_IWGRP
;
1144 char stream_path
[LTTNG_PATH_MAX
];
1146 ASSERT_LOCKED(stream
->lock
);
1147 LTTNG_ASSERT(stream
->trace_chunk
);
1149 ret
= utils_stream_file_path(stream
->chan
->pathname
,
1151 stream
->chan
->tracefile_size
,
1152 stream
->tracefile_count_current
,
1155 sizeof(stream_path
));
1160 if (stream
->out_fd
>= 0) {
1161 ret
= close(stream
->out_fd
);
1163 PERROR("Failed to close stream file \"%s\"", stream
->name
);
1166 stream
->out_fd
= -1;
1169 DBG("Opening stream output file \"%s\"", stream_path
);
1170 chunk_status
= lttng_trace_chunk_open_file(
1171 stream
->trace_chunk
, stream_path
, flags
, mode
, &stream
->out_fd
, false);
1172 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1173 ERR("Failed to open stream file \"%s\"", stream
->name
);
1178 if (!stream
->metadata_flag
&& (create_index
|| stream
->index_file
)) {
1179 if (stream
->index_file
) {
1180 lttng_index_file_put(stream
->index_file
);
1183 lttng_index_file_create_from_trace_chunk(stream
->trace_chunk
,
1184 stream
->chan
->pathname
,
1186 stream
->chan
->tracefile_size
,
1187 stream
->tracefile_count_current
,
1191 &stream
->index_file
);
1192 if (chunk_status
!= LTTNG_TRACE_CHUNK_STATUS_OK
) {
1198 /* Reset current size because we just perform a rotation. */
1199 stream
->tracefile_size_current
= 0;
1200 stream
->out_fd_offset
= 0;
1205 int consumer_stream_rotate_output_files(struct lttng_consumer_stream
*stream
)
1209 stream
->tracefile_count_current
++;
1210 if (stream
->chan
->tracefile_count
> 0) {
1211 stream
->tracefile_count_current
%= stream
->chan
->tracefile_count
;
1214 DBG("Rotating output files of stream \"%s\"", stream
->name
);
1215 ret
= consumer_stream_create_output_files(stream
, true);
1224 bool consumer_stream_is_deleted(struct lttng_consumer_stream
*stream
)
1227 * This function does not take a const stream since
1228 * cds_lfht_is_node_deleted was not const before liburcu 0.12.
1230 LTTNG_ASSERT(stream
);
1231 return cds_lfht_is_node_deleted(&stream
->node
.node
);
1234 static ssize_t
metadata_bucket_flush(const struct stream_subbuffer
*buffer
, void *data
)
1237 struct lttng_consumer_stream
*stream
= (lttng_consumer_stream
*) data
;
1239 ret
= consumer_stream_consume_mmap(nullptr, stream
, buffer
);
1247 static ssize_t
metadata_bucket_consume(struct lttng_consumer_local_data
*unused
1248 __attribute__((unused
)),
1249 struct lttng_consumer_stream
*stream
,
1250 const struct stream_subbuffer
*subbuffer
)
1253 enum metadata_bucket_status status
;
1255 status
= metadata_bucket_fill(stream
->metadata_bucket
, subbuffer
);
1257 case METADATA_BUCKET_STATUS_OK
:
1258 /* Return consumed size. */
1259 ret
= subbuffer
->buffer
.buffer
.size
;
1268 int consumer_stream_enable_metadata_bucketization(struct lttng_consumer_stream
*stream
)
1272 LTTNG_ASSERT(stream
->metadata_flag
);
1273 LTTNG_ASSERT(!stream
->metadata_bucket
);
1274 LTTNG_ASSERT(stream
->chan
->output
== CONSUMER_CHANNEL_MMAP
);
1276 stream
->metadata_bucket
= metadata_bucket_create(metadata_bucket_flush
, stream
);
1277 if (!stream
->metadata_bucket
) {
1282 stream
->read_subbuffer_ops
.consume_subbuffer
= metadata_bucket_consume
;
1287 void consumer_stream_metadata_set_version(struct lttng_consumer_stream
*stream
,
1288 uint64_t new_version
)
1290 LTTNG_ASSERT(new_version
> stream
->metadata_version
);
1291 stream
->metadata_version
= new_version
;
1292 stream
->reset_metadata_flag
= 1;
1294 if (stream
->metadata_bucket
) {
1295 metadata_bucket_reset(stream
->metadata_bucket
);
1299 int consumer_stream_flush_buffer(struct lttng_consumer_stream
*stream
, bool producer_active
)
1303 switch (the_consumer_data
.type
) {
1304 case LTTNG_CONSUMER_KERNEL
:
1305 if (producer_active
) {
1306 ret
= kernctl_buffer_flush(stream
->wait_fd
);
1308 ERR("Failed to flush kernel stream");
1312 ret
= kernctl_buffer_flush_empty(stream
->wait_fd
);
1315 * Doing a buffer flush which does not take into
1316 * account empty packets. This is not perfect,
1317 * but required as a fall-back when
1318 * "flush_empty" is not implemented by
1321 ret
= kernctl_buffer_flush(stream
->wait_fd
);
1323 ERR("Failed to flush kernel stream");
1329 case LTTNG_CONSUMER32_UST
:
1330 case LTTNG_CONSUMER64_UST
:
1331 ret
= lttng_ustconsumer_flush_buffer(stream
, (int) producer_active
);
1334 ERR("Unknown consumer_data type");