src/plugins/ctf/lttng-live/lttng-live.hpp

   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/vendor/fmt/format.h" /* IWYU pragma: keep */
  20
  21 #include "../common/src/metadata/tsdl/decoder.hpp"
  22 #include "../common/src/msg-iter/msg-iter.hpp"
  23 #include "viewer-connection.hpp"
  24
  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,
  43 };
  44
  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
  67 /* Iterator over a live stream. */
  68 struct lttng_live_stream_iterator
  69 {
  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;
  76
  77     /* Owned by this. */
  78     bt_stream *stream = nullptr;
  79
  80     /* Weak reference. */
  81     struct lttng_live_trace *trace = nullptr;
  82
  83     /*
  84      * Since only a single iterator per viewer connection, we have
  85      * only a single message iterator per stream.
  86      */
  87     struct ctf_msg_iter *msg_iter = nullptr;
  88
  89     uint64_t viewer_stream_id = 0;
  90
  91     struct
  92     {
  93         bool is_set = false;
  94         uint64_t value = 0;
  95     } ctf_stream_class_id;
  96
  97     /* base offset in current index. */
  98     uint64_t base_offset = 0;
  99     /* len to read in current index. */
 100     uint64_t len = 0;
 101     /* offset in current index. */
 102     uint64_t offset = 0;
 103
 104     /*
 105      * Clock Snapshot value of the last message iterator inactivity message
 106      * sent downstream.
 107      */
 108     struct
 109     {
 110         bool is_set = false;
 111         uint64_t value = 0;
 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      */
 118     uint64_t current_inactivity_ts = 0;
 119
 120     enum lttng_live_stream_state state = LTTNG_LIVE_STREAM_QUIESCENT;
 121
 122     /*
 123      * The current message produced by this live stream iterator. Owned by
 124      * this.
 125      */
 126     const bt_message *current_msg = nullptr;
 127
 128     /* Timestamp in nanoseconds of the current message (current_msg). */
 129     int64_t current_msg_ts_ns = 0;
 130
 131     /* Owned by this. */
 132     uint8_t *buf = nullptr;
 133     size_t buflen = 0;
 134
 135     /* Owned by this. */
 136     GString *name = nullptr;
 137
 138     bool has_stream_hung_up = false;
 139 };
 140
 141 struct lttng_live_metadata
 142 {
 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;
 149
 150     uint64_t stream_id = 0;
 151     /* Weak reference. */
 152     struct ctf_metadata_decoder *decoder = nullptr;
 153 };
 154
 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,
 175 };
 176
 177 struct lttng_live_trace
 178 {
 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;
 185
 186     /* Back reference to session. */
 187     struct lttng_live_session *session = nullptr;
 188
 189     /* ctf trace ID within the session. */
 190     uint64_t id = 0;
 191
 192     /* Owned by this. */
 193     bt_trace *trace = nullptr;
 194
 195     /* Weak reference. */
 196     bt_trace_class *trace_class = nullptr;
 197
 198     struct lttng_live_metadata *metadata = nullptr;
 199
 200     const bt_clock_class *clock_class = nullptr;
 201
 202     /* Array of pointers to struct lttng_live_stream_iterator. */
 203     /* Owned by this. */
 204     GPtrArray *stream_iterators = nullptr;
 205
 206     enum lttng_live_metadata_stream_state metadata_stream_state =
 207         LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED;
 208 };
 209
 210 struct lttng_live_session
 211 {
 212     explicit lttng_live_session(const bt2c::Logger& parentLogger) :
 213         logger {parentLogger, "PLUGIN/SRC.CTF.LTTNG-LIVE/SESSION"}
 214     {
 215     }
 216
 217     bt2c::Logger logger;
 218
 219     bt_self_component *self_comp = nullptr;
 220
 221     /* Weak reference. */
 222     struct lttng_live_msg_iter *lttng_live_msg_iter = nullptr;
 223
 224     /* Owned by this. */
 225     GString *hostname = nullptr;
 226
 227     /* Owned by this. */
 228     GString *session_name = nullptr;
 229
 230     uint64_t id = 0;
 231
 232     /* Array of pointers to struct lttng_live_trace. */
 233     GPtrArray *traces = nullptr;
 234
 235     bool attached = false;
 236     bool new_streams_needed = false;
 237     bool lazy_stream_msg_init = false;
 238     bool closed = false;
 239 };
 240
 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,
 246 };
 247
 248 /*
 249  * A component instance is an iterator on a single session.
 250  */
 251 struct lttng_live_component
 252 {
 253     explicit lttng_live_component(bt2c::Logger loggerParam) noexcept :
 254         logger {std::move(loggerParam)}
 255     {
 256     }
 257
 258     bt2c::Logger logger;
 259
 260     /* Weak reference. */
 261     bt_self_component *self_comp = nullptr;
 262
 263     struct
 264     {
 265         GString *url = nullptr;
 266         enum session_not_found_action sess_not_found_act = SESSION_NOT_FOUND_ACTION_CONTINUE;
 267     } params;
 268
 269     size_t max_query_size = 0;
 270
 271     /*
 272      * Keeps track of whether the downstream component already has a
 273      * message iterator on this component.
 274      */
 275     bool has_msg_iter = false;
 276 };
 277
 278 struct lttng_live_msg_iter
 279 {
 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
 287     bt_self_component *self_comp = nullptr;
 288
 289     /* Weak reference. */
 290     struct lttng_live_component *lttng_live_comp = nullptr;
 291
 292     /* Weak reference. */
 293     bt_self_message_iterator *self_msg_iter = nullptr;
 294
 295     /* Owned by this. */
 296     struct live_viewer_connection *viewer_connection = nullptr;
 297
 298     /* Array of pointers to struct lttng_live_session. */
 299     GPtrArray *sessions = nullptr;
 300
 301     /* Number of live stream iterator this message iterator has.*/
 302     uint64_t active_stream_iter = 0;
 303
 304     /* Timestamp in nanosecond of the last message sent downstream. */
 305     int64_t last_msg_ts_ns = 0;
 306
 307     /* True if the iterator was interrupted. */
 308     bool was_interrupted = false;
 309 };
 310
 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,
 329 };
 330
 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
 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);
 366
 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);
 371
 372 void lttng_live_component_finalize(bt_self_component_source *component);
 373
 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);
 377
 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);
 382
 383 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
 384
 385 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
 386                                                         bt_self_message_iterator *self_msg_iter);
 387
 388 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session);
 389
 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);
 393
 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);
 397
 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);
 400
 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  */
 408 enum lttng_live_get_one_metadata_status
 409 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len);
 410
 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);
 414
 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);
 419
 420 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
 421
 422 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter,
 423                                           enum lttng_live_stream_state new_state);
 424
 425 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */