967344dcc1909f100b60c764d78baccb52a67978
[babeltrace.git] / src / plugins / ctf / lttng-live / lttng-live.h
1 #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
2 #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H
3
4 /*
5 * BabelTrace - LTTng-live client Component
6 *
7 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
8 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
9 * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
10 *
11 * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
12 *
13 * Permission is hereby granted, free of charge, to any person obtaining a copy
14 * of this software and associated documentation files (the "Software"), to deal
15 * in the Software without restriction, including without limitation the rights
16 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
17 * copies of the Software, and to permit persons to whom the Software is
18 * furnished to do so, subject to the following conditions:
19 *
20 * The above copyright notice and this permission notice shall be included in
21 * all copies or substantial portions of the Software.
22 *
23 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
24 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
25 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
26 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
27 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
28 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
29 * SOFTWARE.
30 */
31
32 #include <stdbool.h>
33
34 #include "common/macros.h"
35 #include <babeltrace2/babeltrace.h>
36
37 #include "../common/metadata/decoder.h"
38 #include "../common/msg-iter/msg-iter.h"
39
40 #include "viewer-connection.h"
41
42 struct lttng_live_component;
43 struct lttng_live_session;
44 struct lttng_live_msg_iter;
45
46 enum lttng_live_stream_state {
47 /* This stream won't have data until some known time in the future. */
48 LTTNG_LIVE_STREAM_QUIESCENT,
49 /*
50 * This stream won't have data until some known time in the future and
51 * the message iterator inactivity message was already sent downstream.
52 */
53 LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
54 /* This stream has data ready to be consumed. */
55 LTTNG_LIVE_STREAM_ACTIVE_DATA,
56 /*
57 * This stream has no data left to consume. We should asked the relay
58 * for more.
59 */
60 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
61 /* This stream won't have anymore data, ever. */
62 LTTNG_LIVE_STREAM_EOF,
63 };
64
65 /* Iterator over a live stream. */
66 struct lttng_live_stream_iterator {
67 bt_logging_level log_level;
68 bt_self_component *self_comp;
69
70 /* Owned by this. */
71 bt_stream *stream;
72
73 /* Weak reference. */
74 struct lttng_live_trace *trace;
75
76 /*
77 * Since only a single iterator per viewer connection, we have
78 * only a single message iterator per stream.
79 */
80 struct bt_msg_iter *msg_iter;
81
82 uint64_t viewer_stream_id;
83
84 uint64_t ctf_stream_class_id;
85
86 /* base offset in current index. */
87 uint64_t base_offset;
88 /* len to read in current index. */
89 uint64_t len;
90 /* offset in current index. */
91 uint64_t offset;
92
93 /*
94 * Clock Snapshot value of the last message iterator inactivity message
95 * sent downstream.
96 */
97 uint64_t last_inactivity_ts;
98
99 /*
100 * Clock Snapshot value of the current message iterator inactivity
101 * message we might want to send downstream.
102 */
103 uint64_t current_inactivity_ts;
104
105 enum lttng_live_stream_state state;
106
107 /*
108 * The current message produced by this live stream iterator. Owned by
109 * this.
110 */
111 bt_message *current_msg;
112
113 /* Timestamp in nanoseconds of the current message (current_msg). */
114 int64_t current_msg_ts_ns;
115
116 /* Owned by this. */
117 uint8_t *buf;
118 size_t buflen;
119
120 /* Owned by this. */
121 GString *name;
122
123 bool has_stream_hung_up;
124 };
125
126 struct lttng_live_metadata {
127 bt_logging_level log_level;
128 bt_self_component *self_comp;
129
130 /* Weak reference. */
131 struct lttng_live_trace *trace;
132
133 uint64_t stream_id;
134 /* Weak reference. */
135 struct ctf_metadata_decoder *decoder;
136
137 bool closed;
138 };
139
140 struct lttng_live_trace {
141 bt_logging_level log_level;
142 bt_self_component *self_comp;
143
144 /* Back reference to session. */
145 struct lttng_live_session *session;
146
147 /* ctf trace ID within the session. */
148 uint64_t id;
149
150 /* Owned by this. */
151 bt_trace *trace;
152
153 /* Weak reference. */
154 bt_trace_class *trace_class;
155
156 struct lttng_live_metadata *metadata;
157
158 const bt_clock_class *clock_class;
159
160 /* Array of pointers to struct lttng_live_stream_iterator. */
161 /* Owned by this. */
162 GPtrArray *stream_iterators;
163
164 bool new_metadata_needed;
165 };
166
167 struct lttng_live_session {
168 bt_logging_level log_level;
169 bt_self_component *self_comp;
170
171 /* Weak reference. */
172 struct lttng_live_msg_iter *lttng_live_msg_iter;
173
174 /* Owned by this. */
175 GString *hostname;
176
177 /* Owned by this. */
178 GString *session_name;
179
180 uint64_t id;
181
182 /* Array of pointers to struct lttng_live_trace. */
183 GPtrArray *traces;
184
185 bool attached;
186 bool new_streams_needed;
187 bool lazy_stream_msg_init;
188 bool closed;
189 };
190
191 enum session_not_found_action {
192 SESSION_NOT_FOUND_ACTION_UNKNOWN,
193 SESSION_NOT_FOUND_ACTION_CONTINUE,
194 SESSION_NOT_FOUND_ACTION_FAIL,
195 SESSION_NOT_FOUND_ACTION_END,
196 };
197
198 /*
199 * A component instance is an iterator on a single session.
200 */
201 struct lttng_live_component {
202 bt_logging_level log_level;
203
204 /* Weak reference. */
205 bt_self_component *self_comp;
206
207 struct {
208 GString *url;
209 enum session_not_found_action sess_not_found_act;
210 } params;
211
212 size_t max_query_size;
213
214 /*
215 * Keeps track of whether the downstream component already has a
216 * message iterator on this component.
217 */
218 bool has_msg_iter;
219 };
220
221 struct lttng_live_msg_iter {
222 bt_logging_level log_level;
223 bt_self_component *self_comp;
224
225 /* Weak reference. */
226 struct lttng_live_component *lttng_live_comp;
227
228 /* Weak reference. */
229 bt_self_message_iterator *self_msg_iter;
230
231 /* Owned by this. */
232 struct live_viewer_connection *viewer_connection;
233
234 /* Array of pointers to struct lttng_live_session. */
235 GPtrArray *sessions;
236
237 /* Number of live stream iterator this message iterator has.*/
238 uint64_t active_stream_iter;
239
240 /* Timestamp in nanosecond of the last message sent downstream. */
241 int64_t last_msg_ts_ns;
242 };
243
244 enum lttng_live_iterator_status {
245 /** Iterator state has progressed. Continue iteration immediately. */
246 LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
247 /** No message available for now. Try again later. */
248 LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
249 /** No more CTF_LTTNG_LIVEs to be delivered. */
250 LTTNG_LIVE_ITERATOR_STATUS_END = 1,
251 /** No error, okay. */
252 LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
253 /** Invalid arguments. */
254 LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
255 /** General error. */
256 LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
257 /** Out of memory. */
258 LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
259 /** Unsupported iterator feature. */
260 LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
261 };
262
263 bt_component_class_init_method_status lttng_live_component_init(
264 bt_self_component_source *self_comp,
265 const bt_value *params, void *init_method_data);
266
267 bt_component_class_query_method_status lttng_live_query(
268 bt_self_component_class_source *comp_class,
269 bt_private_query_executor *priv_query_exec,
270 const char *object, const bt_value *params,
271 void *method_data, const bt_value **result);
272
273 void lttng_live_component_finalize(bt_self_component_source *component);
274
275 bt_component_class_message_iterator_next_method_status lttng_live_msg_iter_next(
276 bt_self_message_iterator *iterator,
277 bt_message_array_const msgs, uint64_t capacity,
278 uint64_t *count);
279
280 bt_component_class_message_iterator_init_method_status lttng_live_msg_iter_init(
281 bt_self_message_iterator *self_msg_it,
282 bt_self_component_source *self_comp,
283 bt_self_component_port_output *self_port);
284
285 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
286
287 int lttng_live_create_viewer_session(struct lttng_live_msg_iter *lttng_live_msg_iter);
288 int lttng_live_attach_session(struct lttng_live_session *session);
289 int lttng_live_detach_session(struct lttng_live_session *session);
290 enum lttng_live_iterator_status lttng_live_get_new_streams(
291 struct lttng_live_session *session);
292
293 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter,
294 uint64_t session_id,
295 const char *hostname,
296 const char *session_name);
297
298 ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
299 FILE *fp);
300 enum lttng_live_iterator_status lttng_live_get_next_index(
301 struct lttng_live_msg_iter *lttng_live_msg_iter,
302 struct lttng_live_stream_iterator *stream,
303 struct packet_index *index);
304
305 enum bt_msg_iter_medium_status lttng_live_get_stream_bytes(
306 struct lttng_live_msg_iter *lttng_live_msg_iter,
307 struct lttng_live_stream_iterator *stream, uint8_t *buf,
308 uint64_t offset, uint64_t req_len, uint64_t *recv_len);
309 void lttng_live_add_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
310 struct lttng_live_stream_iterator *stream_iter);
311 void lttng_live_remove_stream_iterator(struct lttng_live_msg_iter *lttng_live_msg_iter,
312 struct lttng_live_stream_iterator *stream_iter);
313
314 struct lttng_live_trace *lttng_live_borrow_trace(
315 struct lttng_live_session *session, uint64_t trace_id);
316 void lttng_live_need_new_streams(struct lttng_live_msg_iter *lttng_live_msg_iter);
317
318 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
319
320 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */
This page took 0.03504 seconds and 3 git commands to generate.