5 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
6 * David Goulet <dgoulet@efficios.com>
7 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
9 * This program is free software; you can redistribute it and/or modify it
10 * under the terms of the GNU General Public License, version 2 only, as
11 * published by the Free Software Foundation.
13 * This program is distributed in the hope that it will be useful, but WITHOUT
14 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
15 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
18 * You should have received a copy of the GNU General Public License along with
19 * this program; if not, write to the Free Software Foundation, Inc., 51
20 * Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
26 #include <urcu/list.h>
28 #include <common/hashtable/hashtable.h>
29 #include <common/trace-chunk.h>
30 #include <common/optional.h>
31 #include <common/buffer-view.h>
34 #include "tracefile-array.h"
36 struct lttcomm_relayd_index
;
38 struct relay_stream_rotation
{
40 * Indicates if the stream's data and index have been rotated. A
41 * rotation is considered completed when both rotations have occurred.
46 * Packet sequence number of the first packet of the new trace chunk to
47 * which the stream is rotating.
49 uint64_t packet_seq_num
;
51 * Monotonically increasing previous network sequence number of first
52 * data packet of the new trace chunk to which the stream is rotating.
54 uint64_t prev_data_net_seq
;
55 struct lttng_trace_chunk
*next_trace_chunk
;
59 * Represents a stream in the relay
62 uint64_t stream_handle
;
65 /* Back reference to trace. Protected by refcount on trace object. */
66 struct ctf_trace
*trace
;
69 * To protect from concurrent read/update. The viewer stream
70 * lock nests inside the stream lock. The stream lock nests
71 * inside the ctf_trace lock.
74 /* previous data sequence number written to disk. */
75 uint64_t prev_data_seq
;
76 /* previous index sequence number written to disk. */
77 uint64_t prev_index_seq
;
78 /* seq num to encounter before closing. */
79 uint64_t last_net_seq_num
;
81 struct fs_handle
*file
;
82 /* index file on which to write the index data. */
83 struct lttng_index_file
*index_file
;
88 /* On-disk circular buffer of tracefiles. */
89 uint64_t tracefile_size
;
90 uint64_t tracefile_size_current
;
91 /* Max number of trace files for this stream. */
92 uint64_t tracefile_count
;
94 * Index of the currently active file for this stream's on-disk
97 uint64_t tracefile_current_index
;
99 * Indicates that the on-disk buffer has wrapped around. Stream
100 * files shall be unlinked before being opened after this has occurred.
102 bool tracefile_wrapped_around
;
105 * Position in the tracefile where we have the full index also on disk.
107 uint64_t pos_after_last_complete_data_index
;
110 * Counts the number of received indexes. The "tag" associated
111 * with an index is taken before incrementing this seqcount.
112 * Therefore, the sequence tag associated with the last index
113 * received is always index_received_seqcount - 1.
115 uint64_t index_received_seqcount
;
118 * Packet sequence number of the last received packet index.
119 * Only populated when interacting with CTF_INDEX 1.1+.
121 LTTNG_OPTIONAL(uint64_t) received_packet_seq_num
;
124 * Tracefile array is an index of the stream trace files,
125 * indexed by position. It allows keeping track of the oldest
126 * available indexes when overwriting trace files in tracefile
129 struct tracefile_array
*tfa
;
131 bool closed
; /* Stream is closed. */
132 bool close_requested
; /* Close command has been received. */
135 * Counts number of indexes in indexes_ht. Redundant info.
136 * Protected by stream lock.
138 int indexes_in_flight
;
139 struct lttng_ht
*indexes_ht
;
142 * If the stream is inactive, this field is updated with the
143 * live beacon timestamp end, when it is active, this
146 uint64_t beacon_ts_end
;
148 /* CTF stream ID, -1ULL when unset (first packet not received yet). */
149 uint64_t ctf_stream_id
;
151 /* Indicate if the stream was initialized for a data pending command. */
152 bool data_pending_check_done
;
154 /* Is this stream a metadata stream ? */
156 /* Amount of metadata received (bytes). */
157 uint64_t metadata_received
;
160 * Member of the stream list in struct ctf_trace.
161 * Updates are protected by the stream_list_lock.
162 * Traversals are protected by RCU.
164 struct cds_list_head stream_node
;
166 * Temporary list belonging to the connection until all streams
167 * are received for that connection.
168 * Member of the stream recv list in the connection.
169 * Updates are protected by the stream_recv_list_lock.
170 * Traversals are protected by RCU.
173 struct cds_list_head recv_node
;
174 /* Protected by session lock. */
176 /* Notified viewer that no new metadata is available. */
177 bool no_new_metadata_notified
;
179 * Node of stream within global stream hash table.
181 struct lttng_ht_node_u64 node
;
182 bool in_stream_ht
; /* is stream in stream hash table. */
183 struct rcu_head rcu_node
; /* For call_rcu teardown. */
185 * The trace chunk to which the file currently being produced (if any)
188 struct lttng_trace_chunk
*trace_chunk
;
189 LTTNG_OPTIONAL(struct relay_stream_rotation
) ongoing_rotation
;
192 struct relay_stream
*stream_create(struct ctf_trace
*trace
,
193 uint64_t stream_handle
, char *path_name
,
194 char *channel_name
, uint64_t tracefile_size
,
195 uint64_t tracefile_count
);
197 struct relay_stream
*stream_get_by_id(uint64_t stream_id
);
198 bool stream_get(struct relay_stream
*stream
);
199 void stream_put(struct relay_stream
*stream
);
200 int stream_rotate_output_files(struct relay_session
*session
,
201 struct relay_stream
*stream
);
202 int stream_set_pending_rotation(struct relay_stream
*stream
,
203 struct lttng_trace_chunk
*next_trace_chunk
,
204 uint64_t rotation_sequence_number
);
205 void try_stream_close(struct relay_stream
*stream
);
206 void stream_publish(struct relay_stream
*stream
);
207 int stream_init_packet(struct relay_stream
*stream
, size_t packet_size
,
209 int stream_write(struct relay_stream
*stream
,
210 const struct lttng_buffer_view
*packet
, size_t padding_len
);
211 /* Called after the reception of a complete data packet. */
212 int stream_update_index(struct relay_stream
*stream
, uint64_t net_seq_num
,
213 bool rotate_index
, bool *flushed
, uint64_t total_size
);
214 int stream_complete_packet(struct relay_stream
*stream
,
215 size_t packet_total_size
, uint64_t sequence_number
,
217 /* Index info is in host endianness. */
218 int stream_add_index(struct relay_stream
*stream
,
219 const struct lttcomm_relayd_index
*index_info
);
220 int stream_reset_file(struct relay_stream
*stream
);
222 void print_relay_streams(void);
224 #endif /* _STREAM_H */