1 #ifndef _VIEWER_STREAM_H
2 #define _VIEWER_STREAM_H
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.
27 #include <common/hashtable/hashtable.h>
29 #include "ctf-trace.h"
30 #include "lttng-viewer-abi.h"
36 * The viewer stream's lifetime is the intersection of their viewer connection's
37 * lifetime and the duration during which at least:
38 * a) their input source is still active
39 * b) they still have data left to send to the client.
41 * This means that both the sessiond/consumerd connection or the viewer
42 * connection may tear down (and unpublish) a relay_viewer_stream.
44 * Viewer stream updates are protected by their associated stream's lock.
46 struct relay_viewer_stream
{
49 /* Back ref to stream. */
50 struct relay_stream
*stream
;
53 /* FD from which to read the stream data. */
55 struct lttng_trace_chunk
*trace_chunk
;
57 /* index file from which to read the index data. */
58 struct lttng_index_file
*index_file
;
63 uint64_t current_tracefile_id
;
66 * Counts the number of sent indexes. The "tag" associated
67 * with an index to send is the current index_received_seqcount,
68 * because we increment index_received_seqcount after sending
69 * each index. This index_received_seqcount counter can also be
70 * updated when catching up with the producer.
72 uint64_t index_sent_seqcount
;
74 /* Indicates if this stream has been sent to a viewer client. */
76 /* For metadata stream, how much metadata has been sent. */
77 uint64_t metadata_sent
;
79 struct lttng_ht_node_u64 stream_n
;
80 struct rcu_head rcu_node
;
83 struct relay_viewer_stream
*viewer_stream_create(struct relay_stream
*stream
,
84 struct lttng_trace_chunk
*viewer_trace_chunk
,
85 enum lttng_viewer_seek seek_t
);
87 struct relay_viewer_stream
*viewer_stream_get_by_id(uint64_t id
);
88 bool viewer_stream_get(struct relay_viewer_stream
*vstream
);
89 void viewer_stream_put(struct relay_viewer_stream
*vstream
);
90 int viewer_stream_rotate(struct relay_viewer_stream
*vstream
);
91 bool viewer_stream_is_tracefile_seq_readable(struct relay_viewer_stream
*vstream
,
93 void print_viewer_streams(void);
95 #endif /* _VIEWER_STREAM_H */