Commit | Line | Data |
---|---|---|
14f28187 | 1 | /* |
0235b0db | 2 | * SPDX-License-Identifier: MIT |
14f28187 FD |
3 | * |
4 | * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com> | |
5 | * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com> | |
6 | * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com> | |
7 | * | |
0235b0db | 8 | * BabelTrace - LTTng-live client Component |
14f28187 FD |
9 | */ |
10 | ||
0235b0db MJ |
11 | #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H |
12 | #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H | |
13 | ||
c802cacb | 14 | #include <glib.h> |
3c22a242 FD |
15 | #include <stdint.h> |
16 | ||
3fadfbc0 | 17 | #include <babeltrace2/babeltrace.h> |
14f28187 | 18 | |
35e432d7 | 19 | #include "cpp-common/bt2/message.hpp" |
0f5c5d5c SM |
20 | #include "cpp-common/vendor/fmt/format.h" /* IWYU pragma: keep */ |
21 | ||
5656cea5 PP |
22 | #include "../common/src/metadata/tsdl/decoder.hpp" |
23 | #include "../common/src/msg-iter/msg-iter.hpp" | |
087cd0f5 | 24 | #include "viewer-connection.hpp" |
14f28187 | 25 | |
4164020e SM |
26 | enum lttng_live_stream_state |
27 | { | |
28 | /* This stream won't have data until some known time in the future. */ | |
29 | LTTNG_LIVE_STREAM_QUIESCENT, | |
30 | /* | |
31 | * This stream won't have data until some known time in the future and | |
32 | * the message iterator inactivity message was already sent downstream. | |
33 | */ | |
34 | LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */ | |
35 | /* This stream has data ready to be consumed. */ | |
36 | LTTNG_LIVE_STREAM_ACTIVE_DATA, | |
37 | /* | |
38 | * This stream has no data left to consume. We should asked the relay | |
39 | * for more. | |
40 | */ | |
41 | LTTNG_LIVE_STREAM_ACTIVE_NO_DATA, | |
42 | /* This stream won't have anymore data, ever. */ | |
43 | LTTNG_LIVE_STREAM_EOF, | |
14f28187 FD |
44 | }; |
45 | ||
0f5c5d5c SM |
46 | inline const char *format_as(const lttng_live_stream_state state) noexcept |
47 | { | |
48 | switch (state) { | |
49 | case LTTNG_LIVE_STREAM_ACTIVE_NO_DATA: | |
50 | return "ACTIVE_NO_DATA"; | |
51 | ||
52 | case LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA: | |
53 | return "QUIESCENT_NO_DATA"; | |
54 | ||
55 | case LTTNG_LIVE_STREAM_QUIESCENT: | |
56 | return "QUIESCENT"; | |
57 | ||
58 | case LTTNG_LIVE_STREAM_ACTIVE_DATA: | |
59 | return "ACTIVE_DATA"; | |
60 | ||
61 | case LTTNG_LIVE_STREAM_EOF: | |
62 | return "EOF"; | |
63 | } | |
64 | ||
65 | bt_common_abort(); | |
66 | } | |
67 | ||
14f28187 | 68 | /* Iterator over a live stream. */ |
4164020e SM |
69 | struct lttng_live_stream_iterator |
70 | { | |
6eeff3ca SM |
71 | using UP = std::unique_ptr<lttng_live_stream_iterator>; |
72 | ||
0f5c5d5c SM |
73 | explicit lttng_live_stream_iterator(const bt2c::Logger& parentLogger) : |
74 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/STREAM-ITER"} | |
75 | { | |
76 | } | |
77 | ||
ce4ee876 SM |
78 | ~lttng_live_stream_iterator(); |
79 | ||
0f5c5d5c | 80 | bt2c::Logger logger; |
4164020e | 81 | |
0b68f2bc | 82 | bt2::Stream::Shared stream; |
4164020e SM |
83 | |
84 | /* Weak reference. */ | |
afb0f12b | 85 | struct lttng_live_trace *trace = nullptr; |
4164020e SM |
86 | |
87 | /* | |
88 | * Since only a single iterator per viewer connection, we have | |
89 | * only a single message iterator per stream. | |
90 | */ | |
2d5d8c7b | 91 | ctf_msg_iter_up msg_iter; |
4164020e | 92 | |
afb0f12b | 93 | uint64_t viewer_stream_id = 0; |
4164020e SM |
94 | |
95 | struct | |
96 | { | |
afb0f12b SM |
97 | bool is_set = false; |
98 | uint64_t value = 0; | |
4164020e SM |
99 | } ctf_stream_class_id; |
100 | ||
101 | /* base offset in current index. */ | |
afb0f12b | 102 | uint64_t base_offset = 0; |
4164020e | 103 | /* len to read in current index. */ |
afb0f12b | 104 | uint64_t len = 0; |
4164020e | 105 | /* offset in current index. */ |
afb0f12b | 106 | uint64_t offset = 0; |
4164020e SM |
107 | |
108 | /* | |
109 | * Clock Snapshot value of the last message iterator inactivity message | |
110 | * sent downstream. | |
111 | */ | |
112 | struct | |
113 | { | |
afb0f12b SM |
114 | bool is_set = false; |
115 | uint64_t value = 0; | |
4164020e SM |
116 | } last_inactivity_ts; |
117 | ||
118 | /* | |
119 | * Clock Snapshot value of the current message iterator inactivity | |
120 | * message we might want to send downstream. | |
121 | */ | |
afb0f12b | 122 | uint64_t current_inactivity_ts = 0; |
4164020e | 123 | |
afb0f12b | 124 | enum lttng_live_stream_state state = LTTNG_LIVE_STREAM_QUIESCENT; |
4164020e | 125 | |
35e432d7 SM |
126 | /* The current message produced by this live stream iterator. */ |
127 | bt2::ConstMessage::Shared current_msg; | |
4164020e SM |
128 | |
129 | /* Timestamp in nanoseconds of the current message (current_msg). */ | |
afb0f12b | 130 | int64_t current_msg_ts_ns = 0; |
4164020e | 131 | |
afbf59c4 | 132 | std::vector<uint8_t> buf; |
4164020e | 133 | |
e28ca558 | 134 | std::string name; |
4164020e | 135 | |
afb0f12b | 136 | bool has_stream_hung_up = false; |
14f28187 FD |
137 | }; |
138 | ||
4164020e SM |
139 | struct lttng_live_metadata |
140 | { | |
e66be7c3 SM |
141 | using UP = std::unique_ptr<lttng_live_metadata>; |
142 | ||
0f5c5d5c SM |
143 | explicit lttng_live_metadata(const bt2c::Logger& parentLogger) : |
144 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/METADATA"} | |
145 | { | |
146 | } | |
147 | ||
148 | bt2c::Logger logger; | |
c01594de | 149 | |
afb0f12b | 150 | uint64_t stream_id = 0; |
1fa280c9 | 151 | |
4164020e | 152 | /* Weak reference. */ |
1fa280c9 | 153 | ctf_metadata_decoder_up decoder; |
14f28187 FD |
154 | }; |
155 | ||
4164020e SM |
156 | enum lttng_live_metadata_stream_state |
157 | { | |
158 | /* | |
159 | * The metadata needs to be updated. This is either because we just | |
160 | * created the trace and haven't asked yet, or the relay specifically | |
161 | * told us that new metadata is available. | |
162 | */ | |
163 | LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED, | |
164 | /* | |
165 | * The metadata was updated and the relay has not told us we need to | |
166 | * update it yet. | |
167 | */ | |
168 | LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED, | |
169 | /* | |
170 | * The relay has closed this metadata stream. We set this in reaction | |
171 | * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA | |
172 | * command to the relay. If this field is set, we have received all the | |
173 | * metadata that we are ever going to get for that metadata stream. | |
174 | */ | |
175 | LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED, | |
76bbaebc FD |
176 | }; |
177 | ||
4164020e SM |
178 | struct lttng_live_trace |
179 | { | |
deb86334 SM |
180 | using UP = std::unique_ptr<lttng_live_trace>; |
181 | ||
0f5c5d5c SM |
182 | explicit lttng_live_trace(const bt2c::Logger& parentLogger) : |
183 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/TRACE"} | |
184 | { | |
185 | } | |
186 | ||
187 | bt2c::Logger logger; | |
c01594de | 188 | |
4164020e | 189 | /* Back reference to session. */ |
afb0f12b | 190 | struct lttng_live_session *session = nullptr; |
14f28187 | 191 | |
4164020e | 192 | /* ctf trace ID within the session. */ |
afb0f12b | 193 | uint64_t id = 0; |
14f28187 | 194 | |
7916e7eb | 195 | bt2::Trace::Shared trace; |
14f28187 | 196 | |
a52f1f2e | 197 | bt2::TraceClass::Shared trace_class; |
14f28187 | 198 | |
e66be7c3 | 199 | lttng_live_metadata::UP metadata; |
14f28187 | 200 | |
afb0f12b | 201 | const bt_clock_class *clock_class = nullptr; |
14f28187 | 202 | |
db00b877 | 203 | std::vector<lttng_live_stream_iterator::UP> stream_iterators; |
14f28187 | 204 | |
afb0f12b SM |
205 | enum lttng_live_metadata_stream_state metadata_stream_state = |
206 | LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED; | |
14f28187 FD |
207 | }; |
208 | ||
4164020e SM |
209 | struct lttng_live_session |
210 | { | |
459dcd39 SM |
211 | using UP = std::unique_ptr<lttng_live_session>; |
212 | ||
0f5c5d5c SM |
213 | explicit lttng_live_session(const bt2c::Logger& parentLogger) : |
214 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/SESSION"} | |
215 | { | |
216 | } | |
217 | ||
c28da405 SM |
218 | ~lttng_live_session(); |
219 | ||
0f5c5d5c SM |
220 | bt2c::Logger logger; |
221 | ||
afb0f12b | 222 | bt_self_component *self_comp = nullptr; |
c01594de | 223 | |
4164020e | 224 | /* Weak reference. */ |
afb0f12b | 225 | struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr; |
14f28187 | 226 | |
220476b8 | 227 | std::string hostname; |
14f28187 | 228 | |
220476b8 | 229 | std::string session_name; |
14f28187 | 230 | |
afb0f12b | 231 | uint64_t id = 0; |
14f28187 | 232 | |
6dcda123 | 233 | std::vector<lttng_live_trace::UP> traces; |
14f28187 | 234 | |
afb0f12b SM |
235 | bool attached = false; |
236 | bool new_streams_needed = false; | |
237 | bool lazy_stream_msg_init = false; | |
238 | bool closed = false; | |
14f28187 FD |
239 | }; |
240 | ||
4164020e SM |
241 | enum session_not_found_action |
242 | { | |
243 | SESSION_NOT_FOUND_ACTION_CONTINUE, | |
244 | SESSION_NOT_FOUND_ACTION_FAIL, | |
245 | SESSION_NOT_FOUND_ACTION_END, | |
14f28187 FD |
246 | }; |
247 | ||
248 | /* | |
249 | * A component instance is an iterator on a single session. | |
250 | */ | |
4164020e SM |
251 | struct lttng_live_component |
252 | { | |
ef9e5f5d SM |
253 | using UP = std::unique_ptr<lttng_live_component>; |
254 | ||
0f5c5d5c SM |
255 | explicit lttng_live_component(bt2c::Logger loggerParam) noexcept : |
256 | logger {std::move(loggerParam)} | |
257 | { | |
258 | } | |
259 | ||
260 | bt2c::Logger logger; | |
4164020e SM |
261 | |
262 | /* Weak reference. */ | |
afb0f12b | 263 | bt_self_component *self_comp = nullptr; |
4164020e SM |
264 | |
265 | struct | |
266 | { | |
2780ec75 | 267 | std::string url; |
afb0f12b | 268 | enum session_not_found_action sess_not_found_act = SESSION_NOT_FOUND_ACTION_CONTINUE; |
4164020e SM |
269 | } params; |
270 | ||
afb0f12b | 271 | size_t max_query_size = 0; |
4164020e SM |
272 | |
273 | /* | |
274 | * Keeps track of whether the downstream component already has a | |
275 | * message iterator on this component. | |
276 | */ | |
afb0f12b | 277 | bool has_msg_iter = false; |
14f28187 FD |
278 | }; |
279 | ||
4164020e SM |
280 | struct lttng_live_msg_iter |
281 | { | |
0f5c5d5c SM |
282 | explicit lttng_live_msg_iter(const bt2c::Logger& parentLogger) : |
283 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/MSG-ITER"} | |
284 | { | |
285 | } | |
286 | ||
8ad3f6e0 SM |
287 | ~lttng_live_msg_iter(); |
288 | ||
0f5c5d5c SM |
289 | bt2c::Logger logger; |
290 | ||
afb0f12b | 291 | bt_self_component *self_comp = nullptr; |
c01594de | 292 | |
4164020e | 293 | /* Weak reference. */ |
afb0f12b | 294 | struct lttng_live_component *lttng_live_comp = nullptr; |
14f28187 | 295 | |
4164020e | 296 | /* Weak reference. */ |
afb0f12b | 297 | bt_self_message_iterator *self_msg_iter = nullptr; |
14f28187 | 298 | |
d721bef8 | 299 | live_viewer_connection::UP viewer_connection; |
14f28187 | 300 | |
751aaa62 | 301 | std::vector<lttng_live_session::UP> sessions; |
14f28187 | 302 | |
4164020e | 303 | /* Number of live stream iterator this message iterator has.*/ |
afb0f12b | 304 | uint64_t active_stream_iter = 0; |
14f28187 | 305 | |
4164020e | 306 | /* Timestamp in nanosecond of the last message sent downstream. */ |
afb0f12b | 307 | int64_t last_msg_ts_ns = 0; |
f79c2d7a | 308 | |
4164020e | 309 | /* True if the iterator was interrupted. */ |
afb0f12b | 310 | bool was_interrupted = false; |
14f28187 FD |
311 | }; |
312 | ||
4164020e SM |
313 | enum lttng_live_iterator_status |
314 | { | |
315 | /** Iterator state has progressed. Continue iteration immediately. */ | |
316 | LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3, | |
317 | /** No message available for now. Try again later. */ | |
318 | LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2, | |
319 | /** No more CTF_LTTNG_LIVEs to be delivered. */ | |
320 | LTTNG_LIVE_ITERATOR_STATUS_END = 1, | |
321 | /** No error, okay. */ | |
322 | LTTNG_LIVE_ITERATOR_STATUS_OK = 0, | |
323 | /** Invalid arguments. */ | |
324 | LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1, | |
325 | /** General error. */ | |
326 | LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2, | |
327 | /** Out of memory. */ | |
328 | LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3, | |
329 | /** Unsupported iterator feature. */ | |
330 | LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4, | |
14f28187 FD |
331 | }; |
332 | ||
0f5c5d5c SM |
333 | inline const char *format_as(const lttng_live_iterator_status status) noexcept |
334 | { | |
335 | switch (status) { | |
336 | case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE: | |
337 | return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE"; | |
338 | ||
339 | case LTTNG_LIVE_ITERATOR_STATUS_AGAIN: | |
340 | return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN"; | |
341 | ||
342 | case LTTNG_LIVE_ITERATOR_STATUS_END: | |
343 | return "LTTNG_LIVE_ITERATOR_STATUS_END"; | |
344 | ||
345 | case LTTNG_LIVE_ITERATOR_STATUS_OK: | |
346 | return "LTTNG_LIVE_ITERATOR_STATUS_OK"; | |
347 | ||
348 | case LTTNG_LIVE_ITERATOR_STATUS_INVAL: | |
349 | return "LTTNG_LIVE_ITERATOR_STATUS_INVAL"; | |
350 | ||
351 | case LTTNG_LIVE_ITERATOR_STATUS_ERROR: | |
352 | return "LTTNG_LIVE_ITERATOR_STATUS_ERROR"; | |
353 | ||
354 | case LTTNG_LIVE_ITERATOR_STATUS_NOMEM: | |
355 | return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM"; | |
356 | ||
357 | case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED: | |
358 | return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED"; | |
359 | } | |
360 | ||
361 | bt_common_abort(); | |
362 | } | |
363 | ||
4164020e SM |
364 | bt_component_class_initialize_method_status |
365 | lttng_live_component_init(bt_self_component_source *self_comp, | |
366 | bt_self_component_source_configuration *config, const bt_value *params, | |
367 | void *init_method_data); | |
14f28187 | 368 | |
4164020e SM |
369 | bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class, |
370 | bt_private_query_executor *priv_query_exec, | |
371 | const char *object, const bt_value *params, | |
372 | void *method_data, const bt_value **result); | |
14f28187 FD |
373 | |
374 | void lttng_live_component_finalize(bt_self_component_source *component); | |
375 | ||
4164020e SM |
376 | bt_message_iterator_class_next_method_status |
377 | lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
378 | uint64_t capacity, uint64_t *count); | |
14f28187 | 379 | |
4164020e SM |
380 | bt_message_iterator_class_initialize_method_status |
381 | lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it, | |
382 | bt_self_message_iterator_configuration *config, | |
383 | bt_self_component_port_output *self_port); | |
14f28187 FD |
384 | |
385 | void lttng_live_msg_iter_finalize(bt_self_message_iterator *it); | |
386 | ||
4164020e SM |
387 | enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session, |
388 | bt_self_message_iterator *self_msg_iter); | |
eee8e741 | 389 | |
4164020e | 390 | enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session); |
f79c2d7a | 391 | |
4164020e SM |
392 | enum lttng_live_iterator_status |
393 | lttng_live_session_get_new_streams(struct lttng_live_session *session, | |
394 | bt_self_message_iterator *self_msg_iter); | |
14f28187 | 395 | |
4164020e SM |
396 | struct lttng_live_trace * |
397 | lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session, | |
398 | uint64_t trace_id); | |
36e94ad6 | 399 | |
4164020e SM |
400 | int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id, |
401 | const char *hostname, const char *session_name); | |
14f28187 | 402 | |
c28512ab FD |
403 | /* |
404 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata. | |
405 | * If new metadata is received, the function writes it to the provided file | |
406 | * handle and updates the reply_len output parameter. This function should be | |
407 | * called in loop until _END status is received to ensure all metadata is | |
408 | * written to the file. | |
409 | */ | |
4164020e | 410 | enum lttng_live_get_one_metadata_status |
15fcc425 | 411 | lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, std::vector<char>& buf); |
c28512ab | 412 | |
4164020e SM |
413 | enum lttng_live_iterator_status |
414 | lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
415 | struct lttng_live_stream_iterator *stream, struct packet_index *index); | |
14f28187 | 416 | |
4164020e SM |
417 | enum ctf_msg_iter_medium_status |
418 | lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
419 | struct lttng_live_stream_iterator *stream, uint8_t *buf, | |
420 | uint64_t offset, uint64_t req_len, uint64_t *recv_len); | |
14f28187 | 421 | |
9b4f9b42 | 422 | bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter); |
14f28187 | 423 | |
4164020e SM |
424 | void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter, |
425 | enum lttng_live_stream_state new_state); | |
34533ae0 | 426 | |
14f28187 | 427 | #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */ |