Fix: relayd: use packet sequence number for rotation position
[lttng-tools.git] / src / bin / lttng-relayd / stream.h
1 #ifndef _STREAM_H
2 #define _STREAM_H
3
4 /*
5 * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com>
6 * David Goulet <dgoulet@efficios.com>
7 * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
8 *
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.
12 *
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
16 * more details.
17 *
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.
21 */
22
23 #include <limits.h>
24 #include <inttypes.h>
25 #include <pthread.h>
26 #include <urcu/list.h>
27
28 #include <common/hashtable/hashtable.h>
29 #include <common/trace-chunk.h>
30 #include <common/optional.h>
31 #include <common/buffer-view.h>
32
33 #include "session.h"
34 #include "stream-fd.h"
35 #include "tracefile-array.h"
36
37 struct lttcomm_relayd_index;
38
39 struct relay_stream_rotation {
40 /*
41 * Indicates if the stream's data and index have been rotated. A
42 * rotation is considered completed when both rotations have occurred.
43 */
44 bool data_rotated;
45 bool index_rotated;
46 /*
47 * Packet sequence number of the first packet of the new trace chunk to
48 * which the stream is rotating.
49 */
50 uint64_t packet_seq_num;
51 /*
52 * Monotonically increasing previous network sequence number of first
53 * data packet of the new trace chunk to which the stream is rotating.
54 */
55 uint64_t prev_data_net_seq;
56 struct lttng_trace_chunk *next_trace_chunk;
57 };
58
59 /*
60 * Represents a stream in the relay
61 */
62 struct relay_stream {
63 uint64_t stream_handle;
64
65 struct urcu_ref ref;
66 /* Back reference to trace. Protected by refcount on trace object. */
67 struct ctf_trace *trace;
68
69 /*
70 * To protect from concurrent read/update. The viewer stream
71 * lock nests inside the stream lock. The stream lock nests
72 * inside the ctf_trace lock.
73 */
74 pthread_mutex_t lock;
75 /* previous data sequence number written to disk. */
76 uint64_t prev_data_seq;
77 /* previous index sequence number written to disk. */
78 uint64_t prev_index_seq;
79 /* seq num to encounter before closing. */
80 uint64_t last_net_seq_num;
81
82 /* FD on which to write the stream data. */
83 struct stream_fd *stream_fd;
84 /* index file on which to write the index data. */
85 struct lttng_index_file *index_file;
86
87 char *path_name;
88 char *channel_name;
89
90 /* On-disk circular buffer of tracefiles. */
91 uint64_t tracefile_size;
92 uint64_t tracefile_size_current;
93 /* Max number of trace files for this stream. */
94 uint64_t tracefile_count;
95 /*
96 * Index of the currently active file for this stream's on-disk
97 * ring buffer.
98 */
99 uint64_t tracefile_current_index;
100 /*
101 * Indicates that the on-disk buffer has wrapped around. Stream
102 * files shall be unlinked before being opened after this has occurred.
103 */
104 bool tracefile_wrapped_around;
105
106 /*
107 * Position in the tracefile where we have the full index also on disk.
108 */
109 uint64_t pos_after_last_complete_data_index;
110
111 /*
112 * Counts the number of received indexes. The "tag" associated
113 * with an index is taken before incrementing this seqcount.
114 * Therefore, the sequence tag associated with the last index
115 * received is always index_received_seqcount - 1.
116 */
117 uint64_t index_received_seqcount;
118
119 /*
120 * Packet sequence number of the last received packet index.
121 * Only populated when interacting with CTF_INDEX 1.1+.
122 */
123 LTTNG_OPTIONAL(uint64_t) received_packet_seq_num;
124
125 /*
126 * Tracefile array is an index of the stream trace files,
127 * indexed by position. It allows keeping track of the oldest
128 * available indexes when overwriting trace files in tracefile
129 * rotation.
130 */
131 struct tracefile_array *tfa;
132
133 bool closed; /* Stream is closed. */
134 bool close_requested; /* Close command has been received. */
135
136 /*
137 * Counts number of indexes in indexes_ht. Redundant info.
138 * Protected by stream lock.
139 */
140 int indexes_in_flight;
141 struct lttng_ht *indexes_ht;
142
143 /*
144 * If the stream is inactive, this field is updated with the
145 * live beacon timestamp end, when it is active, this
146 * field == -1ULL.
147 */
148 uint64_t beacon_ts_end;
149
150 /* CTF stream ID, -1ULL when unset (first packet not received yet). */
151 uint64_t ctf_stream_id;
152
153 /* Indicate if the stream was initialized for a data pending command. */
154 bool data_pending_check_done;
155
156 /* Is this stream a metadata stream ? */
157 bool is_metadata;
158 /* Amount of metadata received (bytes). */
159 uint64_t metadata_received;
160
161 /*
162 * Member of the stream list in struct ctf_trace.
163 * Updates are protected by the stream_list_lock.
164 * Traversals are protected by RCU.
165 */
166 struct cds_list_head stream_node;
167 /*
168 * Temporary list belonging to the connection until all streams
169 * are received for that connection.
170 * Member of the stream recv list in the connection.
171 * Updates are protected by the stream_recv_list_lock.
172 * Traversals are protected by RCU.
173 */
174 bool in_recv_list;
175 struct cds_list_head recv_node;
176 /* Protected by session lock. */
177 bool published;
178 /*
179 * Node of stream within global stream hash table.
180 */
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. */
184 /*
185 * The trace chunk to which the file currently being produced (if any)
186 * belongs.
187 */
188 struct lttng_trace_chunk *trace_chunk;
189 LTTNG_OPTIONAL(struct relay_stream_rotation) ongoing_rotation;
190 };
191
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);
196
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,
208 bool *file_rotated);
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,
216 bool index_flushed);
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);
221
222 void print_relay_streams(void);
223
224 #endif /* _STREAM_H */
This page took 0.053889 seconds and 4 git commands to generate.