+#ifndef _STREAM_H
+#define _STREAM_H
+
/*
- * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
- * David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
+ * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
+ * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
*
- * This program is free software; you can redistribute it and/or modify it
- * under the terms of the GNU General Public License, version 2 only, as
- * published by the Free Software Foundation.
+ * SPDX-License-Identifier: GPL-2.0-only
*
- * This program is distributed in the hope that it will be useful, but WITHOUT
- * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
- * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
- * more details.
- *
- * You should have received a copy of the GNU General Public License along with
- * this program; if not, write to the Free Software Foundation, Inc., 51
- * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/
-#ifndef _STREAM_H
-#define _STREAM_H
-
#include <limits.h>
#include <inttypes.h>
#include <pthread.h>
#include <urcu/list.h>
#include <common/hashtable/hashtable.h>
+#include <common/trace-chunk.h>
+#include <common/optional.h>
+#include <common/buffer-view.h>
#include "session.h"
+#include "tracefile-array.h"
+
+struct lttcomm_relayd_index;
+
+struct relay_stream_rotation {
+ /*
+ * Indicates if the stream's data and index have been rotated. A
+ * rotation is considered completed when both rotations have occurred.
+ */
+ bool data_rotated;
+ bool index_rotated;
+ /*
+ * Packet sequence number of the first packet of the new trace chunk to
+ * which the stream is rotating.
+ */
+ uint64_t packet_seq_num;
+ /*
+ * Monotonically increasing previous network sequence number of first
+ * data packet of the new trace chunk to which the stream is rotating.
+ */
+ uint64_t prev_data_net_seq;
+ struct lttng_trace_chunk *next_trace_chunk;
+};
/*
* Represents a stream in the relay
*/
struct relay_stream {
uint64_t stream_handle;
- uint64_t prev_seq; /* previous data sequence number encountered */
- struct lttng_ht_node_u64 node;
+
+ struct urcu_ref ref;
+ /* Back reference to trace. Protected by refcount on trace object. */
+ struct ctf_trace *trace;
+
/*
- * When we receive a stream, it gets stored in a list (on a per connection
- * basis) until we have all the streams of the same channel and the metadata
- * associated with it, then it gets flagged with viewer_ready.
+ * To protect from concurrent read/update. The viewer stream
+ * lock nests inside the stream lock. The stream lock nests
+ * inside the ctf_trace lock.
*/
- struct cds_list_head recv_list;
+ pthread_mutex_t lock;
+ /* previous data sequence number written to disk. */
+ uint64_t prev_data_seq;
+ /* previous index sequence number written to disk. */
+ uint64_t prev_index_seq;
+ /* seq num to encounter before closing. */
+ uint64_t last_net_seq_num;
- /* Added to the corresponding ctf_trace. */
- struct cds_list_head trace_list;
- struct rcu_head rcu_node;
- uint64_t session_id;
- int fd;
- /* FD on which to write the index data. */
- int index_fd;
- /* FD on which to read the index data for the viewer. */
- int read_index_fd;
+ struct fs_handle *file;
+ /* index file on which to write the index data. */
+ struct lttng_index_file *index_file;
char *path_name;
char *channel_name;
- /* on-disk circular buffer of tracefiles */
+
+ /* On-disk circular buffer of tracefiles. */
uint64_t tracefile_size;
uint64_t tracefile_size_current;
+ /* Max number of trace files for this stream. */
uint64_t tracefile_count;
- uint64_t tracefile_count_current;
- /* To inform the viewer up to where it can go back in time. */
- uint64_t oldest_tracefile_id;
+ /*
+ * Index of the currently active file for this stream's on-disk
+ * ring buffer.
+ */
+ uint64_t tracefile_current_index;
+ /*
+ * Indicates that the on-disk buffer has wrapped around. Stream
+ * files shall be unlinked before being opened after this has occurred.
+ */
+ bool tracefile_wrapped_around;
- uint64_t total_index_received;
- uint64_t last_net_seq_num;
+ /*
+ * Position in the tracefile where we have the full index also on disk.
+ */
+ uint64_t pos_after_last_complete_data_index;
/*
- * To protect from concurrent read/update. Also used to synchronize the
- * closing of this stream.
+ * Counts the number of received indexes. The "tag" associated
+ * with an index is taken before incrementing this seqcount.
+ * Therefore, the sequence tag associated with the last index
+ * received is always index_received_seqcount - 1.
*/
- pthread_mutex_t lock;
+ uint64_t index_received_seqcount;
/*
- * If the stream is inactive, this field is updated with the live beacon
- * timestamp end, when it is active, this field == -1ULL.
+ * Packet sequence number of the last received packet index.
+ * Only populated when interacting with CTF_INDEX 1.1+.
*/
- uint64_t beacon_ts_end;
+ LTTNG_OPTIONAL(uint64_t) received_packet_seq_num;
+
/*
- * CTF stream ID, -1ULL when unset.
+ * Tracefile array is an index of the stream trace files,
+ * indexed by position. It allows keeping track of the oldest
+ * available indexes when overwriting trace files in tracefile
+ * rotation.
*/
- uint64_t ctf_stream_id;
+ struct tracefile_array *tfa;
+
+ bool closed; /* Stream is closed. */
+ bool close_requested; /* Close command has been received. */
+
/*
- * To protect the update of the close_write_flag and the checks of
- * the tracefile_count_current.
- * It is taken before checking whenever we need to know if the
- * writer and reader are working in the same tracefile.
+ * Counts number of indexes in indexes_ht. Redundant info.
+ * Protected by stream lock.
*/
- pthread_mutex_t viewer_stream_rotation_lock;
+ int indexes_in_flight;
+ struct lttng_ht *indexes_ht;
- /* Information telling us when to close the stream */
- unsigned int close_flag:1;
/*
- * Indicates if the stream has been effectively closed thus having the
- * information in it invalidated but NOT freed. The stream lock MUST be
- * held to read/update that value.
+ * If the stream is inactive, this field is updated with the
+ * live beacon timestamp end, when it is active, this
+ * field == -1ULL.
*/
- unsigned int terminated_flag:1;
+ uint64_t beacon_ts_end;
+
+ /* CTF stream ID, -1ULL when unset (first packet not received yet). */
+ uint64_t ctf_stream_id;
+
/* Indicate if the stream was initialized for a data pending command. */
- unsigned int data_pending_check_done:1;
- unsigned int metadata_flag:1;
+ bool data_pending_check_done;
+
+ /* Is this stream a metadata stream ? */
+ bool is_metadata;
+ /* Amount of metadata received (bytes). */
+ uint64_t metadata_received;
+
+ /*
+ * Member of the stream list in struct ctf_trace.
+ * Updates are protected by the stream_list_lock.
+ * Traversals are protected by RCU.
+ */
+ struct cds_list_head stream_node;
+ /*
+ * Temporary list belonging to the connection until all streams
+ * are received for that connection.
+ * Member of the stream recv list in the connection.
+ * Updates are protected by the stream_recv_list_lock.
+ * Traversals are protected by RCU.
+ */
+ bool in_recv_list;
+ struct cds_list_head recv_node;
+ /* Protected by session lock. */
+ bool published;
+ /* Notified viewer that no new metadata is available. */
+ bool no_new_metadata_notified;
/*
- * To detect when we start overwriting old data, it is used to
- * update the oldest_tracefile_id.
+ * Node of stream within global stream hash table.
*/
- unsigned int tracefile_overwrite:1;
+ struct lttng_ht_node_u64 node;
+ bool in_stream_ht; /* is stream in stream hash table. */
+ struct rcu_head rcu_node; /* For call_rcu teardown. */
/*
- * Can this stream be used by a viewer or are we waiting for additional
- * information.
+ * The trace chunk to which the file currently being produced (if any)
+ * belongs.
*/
- unsigned int viewer_ready:1;
+ struct lttng_trace_chunk *trace_chunk;
+ LTTNG_OPTIONAL(struct relay_stream_rotation) ongoing_rotation;
};
-struct relay_stream *stream_find_by_id(struct lttng_ht *ht,
- uint64_t stream_id);
-int stream_close(struct relay_session *session, struct relay_stream *stream);
-void stream_delete(struct lttng_ht *ht, struct relay_stream *stream);
-void stream_destroy(struct relay_stream *stream);
+struct relay_stream *stream_create(struct ctf_trace *trace,
+ uint64_t stream_handle, char *path_name,
+ char *channel_name, uint64_t tracefile_size,
+ uint64_t tracefile_count);
+
+struct relay_stream *stream_get_by_id(uint64_t stream_id);
+bool stream_get(struct relay_stream *stream);
+void stream_put(struct relay_stream *stream);
+int stream_rotate_output_files(struct relay_session *session,
+ struct relay_stream *stream);
+int stream_set_pending_rotation(struct relay_stream *stream,
+ struct lttng_trace_chunk *next_trace_chunk,
+ uint64_t rotation_sequence_number);
+void try_stream_close(struct relay_stream *stream);
+void stream_publish(struct relay_stream *stream);
+int stream_init_packet(struct relay_stream *stream, size_t packet_size,
+ bool *file_rotated);
+int stream_write(struct relay_stream *stream,
+ const struct lttng_buffer_view *packet, size_t padding_len);
+/* Called after the reception of a complete data packet. */
+int stream_update_index(struct relay_stream *stream, uint64_t net_seq_num,
+ bool rotate_index, bool *flushed, uint64_t total_size);
+int stream_complete_packet(struct relay_stream *stream,
+ size_t packet_total_size, uint64_t sequence_number,
+ bool index_flushed);
+/* Index info is in host endianness. */
+int stream_add_index(struct relay_stream *stream,
+ const struct lttcomm_relayd_index *index_info);
+int stream_reset_file(struct relay_stream *stream);
+
+void print_relay_streams(void);
#endif /* _STREAM_H */
projects / lttng-tools.git / blobdiff