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 SM |
76 | |
77 | /* Owned by this. */ | |
afb0f12b | 78 | bt_stream *stream = nullptr; |
4164020e SM |
79 | |
80 | /* Weak reference. */ | |
afb0f12b | 81 | struct lttng_live_trace *trace = nullptr; |
4164020e SM |
82 | |
83 | /* | |
84 | * Since only a single iterator per viewer connection, we have | |
85 | * only a single message iterator per stream. | |
86 | */ | |
afb0f12b | 87 | struct ctf_msg_iter *msg_iter = nullptr; |
4164020e | 88 | |
afb0f12b | 89 | uint64_t viewer_stream_id = 0; |
4164020e SM |
90 | |
91 | struct | |
92 | { | |
afb0f12b SM |
93 | bool is_set = false; |
94 | uint64_t value = 0; | |
4164020e SM |
95 | } ctf_stream_class_id; |
96 | ||
97 | /* base offset in current index. */ | |
afb0f12b | 98 | uint64_t base_offset = 0; |
4164020e | 99 | /* len to read in current index. */ |
afb0f12b | 100 | uint64_t len = 0; |
4164020e | 101 | /* offset in current index. */ |
afb0f12b | 102 | uint64_t offset = 0; |
4164020e SM |
103 | |
104 | /* | |
105 | * Clock Snapshot value of the last message iterator inactivity message | |
106 | * sent downstream. | |
107 | */ | |
108 | struct | |
109 | { | |
afb0f12b SM |
110 | bool is_set = false; |
111 | uint64_t value = 0; | |
4164020e SM |
112 | } last_inactivity_ts; |
113 | ||
114 | /* | |
115 | * Clock Snapshot value of the current message iterator inactivity | |
116 | * message we might want to send downstream. | |
117 | */ | |
afb0f12b | 118 | uint64_t current_inactivity_ts = 0; |
4164020e | 119 | |
afb0f12b | 120 | enum lttng_live_stream_state state = LTTNG_LIVE_STREAM_QUIESCENT; |
4164020e SM |
121 | |
122 | /* | |
123 | * The current message produced by this live stream iterator. Owned by | |
124 | * this. | |
125 | */ | |
afb0f12b | 126 | const bt_message *current_msg = nullptr; |
4164020e SM |
127 | |
128 | /* Timestamp in nanoseconds of the current message (current_msg). */ | |
afb0f12b | 129 | int64_t current_msg_ts_ns = 0; |
4164020e SM |
130 | |
131 | /* Owned by this. */ | |
afb0f12b SM |
132 | uint8_t *buf = nullptr; |
133 | size_t buflen = 0; | |
4164020e SM |
134 | |
135 | /* Owned by this. */ | |
afb0f12b | 136 | GString *name = nullptr; |
4164020e | 137 | |
afb0f12b | 138 | bool has_stream_hung_up = false; |
14f28187 FD |
139 | }; |
140 | ||
4164020e SM |
141 | struct 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 | { | |
0f5c5d5c SM |
180 | explicit lttng_live_trace(const bt2c::Logger& parentLogger) : |
181 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/TRACE"} | |
182 | { | |
183 | } | |
184 | ||
185 | bt2c::Logger logger; | |
c01594de | 186 | |
4164020e | 187 | /* Back reference to session. */ |
afb0f12b | 188 | struct lttng_live_session *session = nullptr; |
14f28187 | 189 | |
4164020e | 190 | /* ctf trace ID within the session. */ |
afb0f12b | 191 | uint64_t id = 0; |
14f28187 | 192 | |
4164020e | 193 | /* Owned by this. */ |
afb0f12b | 194 | bt_trace *trace = nullptr; |
14f28187 | 195 | |
4164020e | 196 | /* Weak reference. */ |
afb0f12b | 197 | bt_trace_class *trace_class = nullptr; |
14f28187 | 198 | |
afb0f12b | 199 | struct lttng_live_metadata *metadata = nullptr; |
14f28187 | 200 | |
afb0f12b | 201 | const bt_clock_class *clock_class = nullptr; |
14f28187 | 202 | |
4164020e SM |
203 | /* Array of pointers to struct lttng_live_stream_iterator. */ |
204 | /* Owned by this. */ | |
afb0f12b | 205 | GPtrArray *stream_iterators = nullptr; |
14f28187 | 206 | |
afb0f12b SM |
207 | enum lttng_live_metadata_stream_state metadata_stream_state = |
208 | LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED; | |
14f28187 FD |
209 | }; |
210 | ||
4164020e SM |
211 | struct 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 | ||
218 | bt2c::Logger logger; | |
219 | ||
afb0f12b | 220 | bt_self_component *self_comp = nullptr; |
c01594de | 221 | |
4164020e | 222 | /* Weak reference. */ |
afb0f12b | 223 | struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr; |
14f28187 | 224 | |
4164020e | 225 | /* Owned by this. */ |
afb0f12b | 226 | GString *hostname = nullptr; |
14f28187 | 227 | |
4164020e | 228 | /* Owned by this. */ |
afb0f12b | 229 | GString *session_name = nullptr; |
14f28187 | 230 | |
afb0f12b | 231 | uint64_t id = 0; |
14f28187 | 232 | |
4164020e | 233 | /* Array of pointers to struct lttng_live_trace. */ |
afb0f12b | 234 | GPtrArray *traces = nullptr; |
14f28187 | 235 | |
afb0f12b SM |
236 | bool attached = false; |
237 | bool new_streams_needed = false; | |
238 | bool lazy_stream_msg_init = false; | |
239 | bool closed = false; | |
14f28187 FD |
240 | }; |
241 | ||
4164020e SM |
242 | enum session_not_found_action |
243 | { | |
244 | SESSION_NOT_FOUND_ACTION_CONTINUE, | |
245 | SESSION_NOT_FOUND_ACTION_FAIL, | |
246 | SESSION_NOT_FOUND_ACTION_END, | |
14f28187 FD |
247 | }; |
248 | ||
249 | /* | |
250 | * A component instance is an iterator on a single session. | |
251 | */ | |
4164020e SM |
252 | struct lttng_live_component |
253 | { | |
0f5c5d5c SM |
254 | explicit lttng_live_component(bt2c::Logger loggerParam) noexcept : |
255 | logger {std::move(loggerParam)} | |
256 | { | |
257 | } | |
258 | ||
259 | bt2c::Logger logger; | |
4164020e SM |
260 | |
261 | /* Weak reference. */ | |
afb0f12b | 262 | bt_self_component *self_comp = nullptr; |
4164020e SM |
263 | |
264 | struct | |
265 | { | |
afb0f12b SM |
266 | GString *url = nullptr; |
267 | enum session_not_found_action sess_not_found_act = SESSION_NOT_FOUND_ACTION_CONTINUE; | |
4164020e SM |
268 | } params; |
269 | ||
afb0f12b | 270 | size_t max_query_size = 0; |
4164020e SM |
271 | |
272 | /* | |
273 | * Keeps track of whether the downstream component already has a | |
274 | * message iterator on this component. | |
275 | */ | |
afb0f12b | 276 | bool has_msg_iter = false; |
14f28187 FD |
277 | }; |
278 | ||
4164020e SM |
279 | struct lttng_live_msg_iter |
280 | { | |
0f5c5d5c SM |
281 | explicit lttng_live_msg_iter(const bt2c::Logger& parentLogger) : |
282 | logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/MSG-ITER"} | |
283 | { | |
284 | } | |
285 | ||
286 | bt2c::Logger logger; | |
287 | ||
afb0f12b | 288 | bt_self_component *self_comp = nullptr; |
c01594de | 289 | |
4164020e | 290 | /* Weak reference. */ |
afb0f12b | 291 | struct lttng_live_component *lttng_live_comp = nullptr; |
14f28187 | 292 | |
4164020e | 293 | /* Weak reference. */ |
afb0f12b | 294 | bt_self_message_iterator *self_msg_iter = nullptr; |
14f28187 | 295 | |
4164020e | 296 | /* Owned by this. */ |
afb0f12b | 297 | struct live_viewer_connection *viewer_connection = nullptr; |
14f28187 | 298 | |
4164020e | 299 | /* Array of pointers to struct lttng_live_session. */ |
afb0f12b | 300 | GPtrArray *sessions = nullptr; |
14f28187 | 301 | |
4164020e | 302 | /* Number of live stream iterator this message iterator has.*/ |
afb0f12b | 303 | uint64_t active_stream_iter = 0; |
14f28187 | 304 | |
4164020e | 305 | /* Timestamp in nanosecond of the last message sent downstream. */ |
afb0f12b | 306 | int64_t last_msg_ts_ns = 0; |
f79c2d7a | 307 | |
4164020e | 308 | /* True if the iterator was interrupted. */ |
afb0f12b | 309 | bool was_interrupted = false; |
14f28187 FD |
310 | }; |
311 | ||
4164020e SM |
312 | enum lttng_live_iterator_status |
313 | { | |
314 | /** Iterator state has progressed. Continue iteration immediately. */ | |
315 | LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3, | |
316 | /** No message available for now. Try again later. */ | |
317 | LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2, | |
318 | /** No more CTF_LTTNG_LIVEs to be delivered. */ | |
319 | LTTNG_LIVE_ITERATOR_STATUS_END = 1, | |
320 | /** No error, okay. */ | |
321 | LTTNG_LIVE_ITERATOR_STATUS_OK = 0, | |
322 | /** Invalid arguments. */ | |
323 | LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1, | |
324 | /** General error. */ | |
325 | LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2, | |
326 | /** Out of memory. */ | |
327 | LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3, | |
328 | /** Unsupported iterator feature. */ | |
329 | LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4, | |
14f28187 FD |
330 | }; |
331 | ||
0f5c5d5c SM |
332 | inline const char *format_as(const lttng_live_iterator_status status) noexcept |
333 | { | |
334 | switch (status) { | |
335 | case LTTNG_LIVE_ITERATOR_STATUS_CONTINUE: | |
336 | return "LTTNG_LIVE_ITERATOR_STATUS_CONTINUE"; | |
337 | ||
338 | case LTTNG_LIVE_ITERATOR_STATUS_AGAIN: | |
339 | return "LTTNG_LIVE_ITERATOR_STATUS_AGAIN"; | |
340 | ||
341 | case LTTNG_LIVE_ITERATOR_STATUS_END: | |
342 | return "LTTNG_LIVE_ITERATOR_STATUS_END"; | |
343 | ||
344 | case LTTNG_LIVE_ITERATOR_STATUS_OK: | |
345 | return "LTTNG_LIVE_ITERATOR_STATUS_OK"; | |
346 | ||
347 | case LTTNG_LIVE_ITERATOR_STATUS_INVAL: | |
348 | return "LTTNG_LIVE_ITERATOR_STATUS_INVAL"; | |
349 | ||
350 | case LTTNG_LIVE_ITERATOR_STATUS_ERROR: | |
351 | return "LTTNG_LIVE_ITERATOR_STATUS_ERROR"; | |
352 | ||
353 | case LTTNG_LIVE_ITERATOR_STATUS_NOMEM: | |
354 | return "LTTNG_LIVE_ITERATOR_STATUS_NOMEM"; | |
355 | ||
356 | case LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED: | |
357 | return "LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED"; | |
358 | } | |
359 | ||
360 | bt_common_abort(); | |
361 | } | |
362 | ||
4164020e SM |
363 | bt_component_class_initialize_method_status |
364 | lttng_live_component_init(bt_self_component_source *self_comp, | |
365 | bt_self_component_source_configuration *config, const bt_value *params, | |
366 | void *init_method_data); | |
14f28187 | 367 | |
4164020e SM |
368 | bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class, |
369 | bt_private_query_executor *priv_query_exec, | |
370 | const char *object, const bt_value *params, | |
371 | void *method_data, const bt_value **result); | |
14f28187 FD |
372 | |
373 | void lttng_live_component_finalize(bt_self_component_source *component); | |
374 | ||
4164020e SM |
375 | bt_message_iterator_class_next_method_status |
376 | lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs, | |
377 | uint64_t capacity, uint64_t *count); | |
14f28187 | 378 | |
4164020e SM |
379 | bt_message_iterator_class_initialize_method_status |
380 | lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it, | |
381 | bt_self_message_iterator_configuration *config, | |
382 | bt_self_component_port_output *self_port); | |
14f28187 FD |
383 | |
384 | void lttng_live_msg_iter_finalize(bt_self_message_iterator *it); | |
385 | ||
4164020e SM |
386 | enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session, |
387 | bt_self_message_iterator *self_msg_iter); | |
eee8e741 | 388 | |
4164020e | 389 | enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session); |
f79c2d7a | 390 | |
4164020e SM |
391 | enum lttng_live_iterator_status |
392 | lttng_live_session_get_new_streams(struct lttng_live_session *session, | |
393 | bt_self_message_iterator *self_msg_iter); | |
14f28187 | 394 | |
4164020e SM |
395 | struct lttng_live_trace * |
396 | lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session, | |
397 | uint64_t trace_id); | |
36e94ad6 | 398 | |
4164020e SM |
399 | int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id, |
400 | const char *hostname, const char *session_name); | |
14f28187 | 401 | |
c28512ab FD |
402 | /* |
403 | * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata. | |
404 | * If new metadata is received, the function writes it to the provided file | |
405 | * handle and updates the reply_len output parameter. This function should be | |
406 | * called in loop until _END status is received to ensure all metadata is | |
407 | * written to the file. | |
408 | */ | |
4164020e SM |
409 | enum lttng_live_get_one_metadata_status |
410 | lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len); | |
c28512ab | 411 | |
4164020e SM |
412 | enum lttng_live_iterator_status |
413 | lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
414 | struct lttng_live_stream_iterator *stream, struct packet_index *index); | |
14f28187 | 415 | |
4164020e SM |
416 | enum ctf_msg_iter_medium_status |
417 | lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter, | |
418 | struct lttng_live_stream_iterator *stream, uint8_t *buf, | |
419 | uint64_t offset, uint64_t req_len, uint64_t *recv_len); | |
14f28187 | 420 | |
9b4f9b42 | 421 | bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter); |
14f28187 | 422 | |
4164020e SM |
423 | void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter, |
424 | enum lttng_live_stream_state new_state); | |
34533ae0 | 425 | |
14f28187 | 426 | #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */ |