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