Run clang-format on the whole tree
[lttng-tools.git] / src / bin / lttng-relayd / viewer-stream.cpp
CommitLineData
2f8f53af 1/*
ab5be9fa
MJ
2 * Copyright (C) 2013 Julien Desfossez <jdesfossez@efficios.com>
3 * Copyright (C) 2013 David Goulet <dgoulet@efficios.com>
4 * Copyright (C) 2015 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
2f8f53af 5 *
ab5be9fa 6 * SPDX-License-Identifier: GPL-2.0-only
2f8f53af 7 *
2f8f53af
DG
8 */
9
6c1c0768 10#define _LGPL_SOURCE
28ab034a
JG
11#include "lttng-relayd.hpp"
12#include "viewer-stream.hpp"
13
c9e313bc 14#include <common/common.hpp>
c9e313bc 15#include <common/compat/string.hpp>
28ab034a 16#include <common/index/index.hpp>
c9e313bc 17#include <common/utils.hpp>
2f8f53af 18
28ab034a
JG
19#include <algorithm>
20#include <fcntl.h>
21#include <sys/stat.h>
22#include <sys/types.h>
2f8f53af 23
b9973dea 24static void viewer_stream_release_composite_objects(struct relay_viewer_stream *vstream)
2f8f53af 25{
b9973dea
MD
26 if (vstream->stream_file.handle) {
27 fs_handle_close(vstream->stream_file.handle);
28 vstream->stream_file.handle = NULL;
29 }
30 if (vstream->index_file) {
31 lttng_index_file_put(vstream->index_file);
32 vstream->index_file = NULL;
33 }
34 if (vstream->stream) {
35 stream_put(vstream->stream);
36 vstream->stream = NULL;
37 }
80516611 38 lttng_trace_chunk_put(vstream->stream_file.trace_chunk);
b9973dea
MD
39 vstream->stream_file.trace_chunk = NULL;
40}
41
42static void viewer_stream_destroy(struct relay_viewer_stream *vstream)
43{
7591bab1
MD
44 free(vstream->path_name);
45 free(vstream->channel_name);
46 free(vstream);
2f8f53af
DG
47}
48
7591bab1 49static void viewer_stream_destroy_rcu(struct rcu_head *head)
2f8f53af 50{
7591bab1 51 struct relay_viewer_stream *vstream =
0114db0e 52 lttng::utils::container_of(head, &relay_viewer_stream::rcu_node);
2f8f53af 53
7591bab1 54 viewer_stream_destroy(vstream);
2f8f53af
DG
55}
56
9edaf114 57/* Relay stream's lock must be held by the caller. */
2f8f53af 58struct relay_viewer_stream *viewer_stream_create(struct relay_stream *stream,
28ab034a
JG
59 struct lttng_trace_chunk *trace_chunk,
60 enum lttng_viewer_seek seek_t)
2f8f53af 61{
ebb29c10 62 struct relay_viewer_stream *vstream = NULL;
ebb29c10 63
9edaf114 64 ASSERT_LOCKED(stream->lock);
2f8f53af 65
64803277 66 vstream = zmalloc<relay_viewer_stream>();
2f8f53af
DG
67 if (!vstream) {
68 PERROR("relay viewer stream zmalloc");
69 goto error;
70 }
71
80516611 72 if (trace_chunk) {
28ab034a 73 const bool acquired_reference = lttng_trace_chunk_get(trace_chunk);
80516611 74
a0377dfe 75 LTTNG_ASSERT(acquired_reference);
80516611
JG
76 }
77
9edaf114 78 vstream->stream_file.trace_chunk = trace_chunk;
f5436bfc 79 vstream->path_name = lttng_strndup(stream->path_name, LTTNG_VIEWER_PATH_MAX);
b272577e
MD
80 if (vstream->path_name == NULL) {
81 PERROR("relay viewer path_name alloc");
82 goto error;
83 }
28ab034a 84 vstream->channel_name = lttng_strndup(stream->channel_name, LTTNG_VIEWER_NAME_MAX);
b272577e
MD
85 if (vstream->channel_name == NULL) {
86 PERROR("relay viewer channel_name alloc");
87 goto error;
88 }
2f8f53af 89
a44ca2ca
MD
90 if (!stream_get(stream)) {
91 ERR("Cannot get stream");
92 goto error;
93 }
94 vstream->stream = stream;
95
a44ca2ca
MD
96 if (stream->is_metadata && stream->trace->viewer_metadata_stream) {
97 ERR("Cannot attach viewer metadata stream to trace (busy).");
71381736 98 goto error;
a44ca2ca
MD
99 }
100
2f8f53af 101 switch (seek_t) {
c4e361a4 102 case LTTNG_VIEWER_SEEK_BEGINNING:
a44ca2ca
MD
103 {
104 uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);
105
106 if (seq_tail == -1ULL) {
107 /*
108 * Tail may not be initialized yet. Nonetheless, we know
109 * we want to send the first index once it becomes
110 * available.
111 */
112 seq_tail = 0;
113 }
28ab034a 114 vstream->current_tracefile_id = tracefile_array_get_file_index_tail(stream->tfa);
a44ca2ca 115 vstream->index_sent_seqcount = seq_tail;
2f8f53af 116 break;
a44ca2ca 117 }
c4e361a4 118 case LTTNG_VIEWER_SEEK_LAST:
a44ca2ca 119 vstream->current_tracefile_id =
78118e3b 120 tracefile_array_get_read_file_index_head(stream->tfa);
a44ca2ca
MD
121 /*
122 * We seek at the very end of each stream, awaiting for
123 * a future packet to eventually come in.
124 *
125 * We don't need to check the head position for -1ULL since the
126 * increment will set it to 0.
127 */
28ab034a 128 vstream->index_sent_seqcount = tracefile_array_get_seq_head(stream->tfa) + 1;
2f8f53af
DG
129 break;
130 default:
71381736 131 goto error;
2f8f53af 132 }
2f8f53af 133
2f8f53af 134 /*
a44ca2ca
MD
135 * If we never received an index for the current stream, delay
136 * the opening of the index, otherwise open it right now.
2f8f53af 137 */
b0d240a2 138 if (stream->index_file == NULL) {
f8f3885c 139 vstream->index_file = NULL;
0eafad74 140 } else if (vstream->stream_file.trace_chunk) {
ebb29c10
JG
141 const uint32_t connection_major = stream->trace->session->major;
142 const uint32_t connection_minor = stream->trace->session->minor;
3ff5c5db 143 enum lttng_trace_chunk_status chunk_status;
ebb29c10 144
3ff5c5db 145 chunk_status = lttng_index_file_create_from_trace_chunk_read_only(
28ab034a
JG
146 vstream->stream_file.trace_chunk,
147 stream->path_name,
148 stream->channel_name,
149 stream->tracefile_size,
150 vstream->current_tracefile_id,
151 lttng_to_index_major(connection_major, connection_minor),
152 lttng_to_index_minor(connection_major, connection_minor),
153 true,
154 &vstream->index_file);
3ff5c5db
MD
155 if (chunk_status != LTTNG_TRACE_CHUNK_STATUS_OK) {
156 if (chunk_status == LTTNG_TRACE_CHUNK_STATUS_NO_FILE) {
157 vstream->index_file = NULL;
158 } else {
71381736 159 goto error;
3ff5c5db 160 }
2f8f53af 161 }
2f8f53af
DG
162 }
163
b0d240a2
MD
164 /*
165 * If we never received a data file for the current stream, delay the
166 * opening, otherwise open it right now.
167 */
0eafad74 168 if (stream->file && vstream->stream_file.trace_chunk) {
8bb66c3c 169 int ret;
b0d240a2
MD
170 char file_path[LTTNG_PATH_MAX];
171 enum lttng_trace_chunk_status status;
172
173 ret = utils_stream_file_path(stream->path_name,
28ab034a
JG
174 stream->channel_name,
175 stream->tracefile_size,
176 vstream->current_tracefile_id,
177 NULL,
178 file_path,
179 sizeof(file_path));
b0d240a2 180 if (ret < 0) {
71381736 181 goto error;
b0d240a2
MD
182 }
183
28ab034a
JG
184 status = lttng_trace_chunk_open_fs_handle(vstream->stream_file.trace_chunk,
185 file_path,
186 O_RDONLY,
187 0,
188 &vstream->stream_file.handle,
189 true);
b0d240a2 190 if (status != LTTNG_TRACE_CHUNK_STATUS_OK) {
71381736 191 goto error;
b0d240a2 192 }
b0d240a2
MD
193 }
194
f8f3885c 195 if (seek_t == LTTNG_VIEWER_SEEK_LAST && vstream->index_file) {
2f8f53af
DG
196 off_t lseek_ret;
197
28ab034a 198 lseek_ret = fs_handle_seek(vstream->index_file->file, 0, SEEK_END);
2f8f53af 199 if (lseek_ret < 0) {
71381736 200 goto error;
2f8f53af 201 }
7591bab1 202 }
7591bab1 203 if (stream->is_metadata) {
28ab034a 204 rcu_assign_pointer(stream->trace->viewer_metadata_stream, vstream);
2f8f53af
DG
205 }
206
80516611
JG
207 vstream->last_seen_rotation_count = stream->completed_rotation_count;
208
7591bab1
MD
209 /* Globally visible after the add unique. */
210 lttng_ht_node_init_u64(&vstream->stream_n, stream->stream_handle);
7591bab1 211 urcu_ref_init(&vstream->ref);
c51b2177 212 lttng_ht_add_unique_u64(viewer_streams_ht, &vstream->stream_n);
7591bab1 213
2f8f53af
DG
214 return vstream;
215
216error:
217 if (vstream) {
b9973dea
MD
218 /* Not using `put` since vstream is assumed to be published. */
219 viewer_stream_release_composite_objects(vstream);
7591bab1 220 viewer_stream_destroy(vstream);
2f8f53af
DG
221 }
222 return NULL;
223}
224
7591bab1 225static void viewer_stream_unpublish(struct relay_viewer_stream *vstream)
2f8f53af
DG
226{
227 int ret;
228 struct lttng_ht_iter iter;
229
7591bab1 230 iter.iter.node = &vstream->stream_n.node;
2f8f53af 231 ret = lttng_ht_del(viewer_streams_ht, &iter);
a0377dfe 232 LTTNG_ASSERT(!ret);
2f8f53af
DG
233}
234
7591bab1 235static void viewer_stream_release(struct urcu_ref *ref)
2f8f53af 236{
28ab034a
JG
237 struct relay_viewer_stream *vstream =
238 caa_container_of(ref, struct relay_viewer_stream, ref);
2a174661 239
7591bab1
MD
240 if (vstream->stream->is_metadata) {
241 rcu_assign_pointer(vstream->stream->trace->viewer_metadata_stream, NULL);
2a174661 242 }
7591bab1 243 viewer_stream_unpublish(vstream);
b9973dea 244 viewer_stream_release_composite_objects(vstream);
7591bab1
MD
245 call_rcu(&vstream->rcu_node, viewer_stream_destroy_rcu);
246}
247
248/* Must be called with RCU read-side lock held. */
249bool viewer_stream_get(struct relay_viewer_stream *vstream)
250{
ce4d4083 251 return urcu_ref_get_unless_zero(&vstream->ref);
2f8f53af
DG
252}
253
254/*
7591bab1 255 * Get viewer stream by id.
2f8f53af 256 *
7591bab1 257 * Return viewer stream if found else NULL.
2f8f53af 258 */
7591bab1 259struct relay_viewer_stream *viewer_stream_get_by_id(uint64_t id)
2f8f53af
DG
260{
261 struct lttng_ht_node_u64 *node;
262 struct lttng_ht_iter iter;
7591bab1 263 struct relay_viewer_stream *vstream = NULL;
2f8f53af 264
7591bab1 265 rcu_read_lock();
2f8f53af
DG
266 lttng_ht_lookup(viewer_streams_ht, &id, &iter);
267 node = lttng_ht_iter_get_node_u64(&iter);
268 if (!node) {
269 DBG("Relay viewer stream %" PRIu64 " not found", id);
270 goto end;
271 }
0114db0e 272 vstream = lttng::utils::container_of(node, &relay_viewer_stream::stream_n);
7591bab1
MD
273 if (!viewer_stream_get(vstream)) {
274 vstream = NULL;
275 }
2f8f53af 276end:
7591bab1
MD
277 rcu_read_unlock();
278 return vstream;
279}
280
281void viewer_stream_put(struct relay_viewer_stream *vstream)
282{
283 rcu_read_lock();
7591bab1 284 urcu_ref_put(&vstream->ref, viewer_stream_release);
7591bab1
MD
285 rcu_read_unlock();
286}
287
3087b021
MD
288void viewer_stream_close_files(struct relay_viewer_stream *vstream)
289{
290 if (vstream->index_file) {
291 lttng_index_file_put(vstream->index_file);
292 vstream->index_file = NULL;
293 }
8bb66c3c 294 if (vstream->stream_file.handle) {
28ab034a 295 fs_handle_close(vstream->stream_file.handle);
8bb66c3c 296 vstream->stream_file.handle = NULL;
3087b021
MD
297 }
298}
299
300void viewer_stream_sync_tracefile_array_tail(struct relay_viewer_stream *vstream)
301{
302 const struct relay_stream *stream = vstream->stream;
303 uint64_t seq_tail;
304
305 vstream->current_tracefile_id = tracefile_array_get_file_index_tail(stream->tfa);
306 seq_tail = tracefile_array_get_seq_tail(stream->tfa);
307 if (seq_tail == -1ULL) {
308 seq_tail = 0;
309 }
7fb6d478
MD
310
311 /*
312 * Move the index sent seqcount forward if it was lagging behind
313 * the new tail of the tracefile array. If the current
314 * index_sent_seqcount is already further than the tracefile
315 * array tail position, keep its current position.
316 */
28ab034a 317 vstream->index_sent_seqcount = std::max(seq_tail, vstream->index_sent_seqcount);
3087b021
MD
318}
319
2f8f53af
DG
320/*
321 * Rotate a stream to the next tracefile.
322 *
7591bab1 323 * Must be called with the rstream lock held.
b0d240a2 324 * Returns 0 on success, 1 on EOF.
2f8f53af 325 */
7591bab1 326int viewer_stream_rotate(struct relay_viewer_stream *vstream)
2f8f53af
DG
327{
328 int ret;
a44ca2ca 329 uint64_t new_id;
ebb29c10 330 const struct relay_stream *stream = vstream->stream;
2f8f53af 331
7591bab1 332 /* Detect the last tracefile to open. */
28ab034a
JG
333 if (stream->index_received_seqcount == vstream->index_sent_seqcount &&
334 stream->trace->session->connection_closed) {
7591bab1 335 ret = 1;
2a174661
DG
336 goto end;
337 }
2f8f53af 338
7591bab1
MD
339 if (stream->tracefile_count == 0) {
340 /* Ignore rotation, there is none to do. */
341 ret = 0;
2f8f53af
DG
342 goto end;
343 }
344
a44ca2ca
MD
345 /*
346 * Try to move to the next file.
347 */
28ab034a
JG
348 new_id = (vstream->current_tracefile_id + 1) % stream->tracefile_count;
349 if (tracefile_array_seq_in_file(stream->tfa, new_id, vstream->index_sent_seqcount)) {
a44ca2ca 350 vstream->current_tracefile_id = new_id;
2f8f53af 351 } else {
a44ca2ca
MD
352 uint64_t seq_tail = tracefile_array_get_seq_tail(stream->tfa);
353
354 /*
355 * This can only be reached on overwrite, which implies there
356 * has been data written at some point, which will have set the
357 * tail.
358 */
a0377dfe 359 LTTNG_ASSERT(seq_tail != -1ULL);
a44ca2ca
MD
360 /*
361 * We need to resync because we lag behind tail.
362 */
28ab034a 363 vstream->current_tracefile_id = tracefile_array_get_file_index_tail(stream->tfa);
a44ca2ca 364 vstream->index_sent_seqcount = seq_tail;
2f8f53af 365 }
b0d240a2
MD
366 viewer_stream_close_files(vstream);
367 ret = 0;
2f8f53af 368end:
2f8f53af
DG
369 return ret;
370}
7591bab1
MD
371
372void print_viewer_streams(void)
373{
374 struct lttng_ht_iter iter;
375 struct relay_viewer_stream *vstream;
376
ce3f3ba3
JG
377 if (!viewer_streams_ht) {
378 return;
379 }
380
7591bab1 381 rcu_read_lock();
28ab034a 382 cds_lfht_for_each_entry (viewer_streams_ht->ht, &iter.iter, vstream, stream_n.node) {
7591bab1
MD
383 if (!viewer_stream_get(vstream)) {
384 continue;
385 }
28ab034a
JG
386 DBG("vstream %p refcount %ld stream %" PRIu64 " trace %" PRIu64 " session %" PRIu64,
387 vstream,
388 vstream->ref.refcount,
389 vstream->stream->stream_handle,
390 vstream->stream->trace->id,
391 vstream->stream->trace->session->id);
7591bab1
MD
392 viewer_stream_put(vstream);
393 }
394 rcu_read_unlock();
395}
This page took 0.077779 seconds and 4 git commands to generate.