Commit | Line | Data |
---|---|---|
7591bab1 MD |
1 | #ifndef _VIEWER_STREAM_H |
2 | #define _VIEWER_STREAM_H | |
3 | ||
2f8f53af DG |
4 | /* |
5 | * Copyright (C) 2013 - Julien Desfossez <jdesfossez@efficios.com> | |
6 | * David Goulet <dgoulet@efficios.com> | |
7591bab1 | 7 | * 2015 - Mathieu Desnoyers <mathieu.desnoyers@efficios.com> |
2f8f53af DG |
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 | ||
2f8f53af DG |
23 | #include <limits.h> |
24 | #include <inttypes.h> | |
25 | #include <pthread.h> | |
26 | ||
27 | #include <common/hashtable/hashtable.h> | |
28 | ||
29 | #include "ctf-trace.h" | |
30 | #include "lttng-viewer-abi.h" | |
2a174661 | 31 | #include "stream.h" |
2f8f53af | 32 | |
2f8f53af DG |
33 | struct relay_stream; |
34 | ||
35 | /* | |
7591bab1 MD |
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. | |
40 | * | |
41 | * This means that both the sessiond/consumerd connection or the viewer | |
42 | * connection may tear down (and unpublish) a relay_viewer_stream. | |
43 | * | |
44 | * Viewer stream updates are protected by their associated stream's lock. | |
2f8f53af DG |
45 | */ |
46 | struct relay_viewer_stream { | |
7591bab1 | 47 | struct urcu_ref ref; |
7591bab1 MD |
48 | |
49 | /* Back ref to stream. */ | |
50 | struct relay_stream *stream; | |
51 | ||
52 | /* FD from which to read the stream data. */ | |
53 | struct stream_fd *stream_fd; | |
f8f3885c MD |
54 | /* index file from which to read the index data. */ |
55 | struct lttng_index_file *index_file; | |
7591bab1 | 56 | |
2f8f53af DG |
57 | char *path_name; |
58 | char *channel_name; | |
7591bab1 MD |
59 | |
60 | uint64_t current_tracefile_id; | |
7591bab1 | 61 | |
a44ca2ca MD |
62 | /* |
63 | * Counts the number of sent indexes. The "tag" associated | |
64 | * with an index to send is the current index_received_seqcount, | |
65 | * because we increment index_received_seqcount after sending | |
66 | * each index. This index_received_seqcount counter can also be | |
67 | * updated when catching up with the producer. | |
68 | */ | |
69 | uint64_t index_sent_seqcount; | |
7591bab1 MD |
70 | |
71 | /* Indicates if this stream has been sent to a viewer client. */ | |
72 | bool sent_flag; | |
73 | /* For metadata stream, how much metadata has been sent. */ | |
74 | uint64_t metadata_sent; | |
75 | ||
2f8f53af DG |
76 | struct lttng_ht_node_u64 stream_n; |
77 | struct rcu_head rcu_node; | |
2f8f53af DG |
78 | }; |
79 | ||
80 | struct relay_viewer_stream *viewer_stream_create(struct relay_stream *stream, | |
7591bab1 MD |
81 | enum lttng_viewer_seek seek_t); |
82 | ||
83 | struct relay_viewer_stream *viewer_stream_get_by_id(uint64_t id); | |
84 | bool viewer_stream_get(struct relay_viewer_stream *vstream); | |
85 | void viewer_stream_put(struct relay_viewer_stream *vstream); | |
86 | int viewer_stream_rotate(struct relay_viewer_stream *vstream); | |
87 | bool viewer_stream_is_tracefile_seq_readable(struct relay_viewer_stream *vstream, | |
88 | uint64_t seq); | |
89 | void print_viewer_streams(void); | |
2f8f53af DG |
90 | |
91 | #endif /* _VIEWER_STREAM_H */ |