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