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 <stdbool.h>
  15 #include <stdint.h>
  16
  17 #include <glib.h>
  18
  19 #include <babeltrace2/babeltrace.h>
  20
  21 #include "common/macros.h"
  22 #include "../common/metadata/decoder.hpp"
  23 #include "../common/msg-iter/msg-iter.hpp"
  24 #include "viewer-connection.hpp"
  25
  26 struct lttng_live_component;
  27 struct lttng_live_session;
  28 struct lttng_live_msg_iter;
  29
  30 enum lttng_live_stream_state
  31 {
  32     /* This stream won't have data until some known time in the future. */
  33     LTTNG_LIVE_STREAM_QUIESCENT,
  34     /*
  35      * This stream won't have data until some known time in the future and
  36      * the message iterator inactivity message was already sent downstream.
  37      */
  38     LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA, /* */
  39     /* This stream has data ready to be consumed. */
  40     LTTNG_LIVE_STREAM_ACTIVE_DATA,
  41     /*
  42      * This stream has no data left to consume. We should asked the relay
  43      * for more.
  44      */
  45     LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
  46     /* This stream won't have anymore data, ever. */
  47     LTTNG_LIVE_STREAM_EOF,
  48 };
  49
  50 /* Iterator over a live stream. */
  51 struct lttng_live_stream_iterator
  52 {
  53     bt_logging_level log_level;
  54     bt_self_component *self_comp;
  55
  56     /* Owned by this. */
  57     bt_stream *stream;
  58
  59     /* Weak reference. */
  60     struct lttng_live_trace *trace;
  61
  62     /*
  63      * Since only a single iterator per viewer connection, we have
  64      * only a single message iterator per stream.
  65      */
  66     struct ctf_msg_iter *msg_iter;
  67
  68     uint64_t viewer_stream_id;
  69
  70     struct
  71     {
  72         bool is_set;
  73         uint64_t value;
  74     } ctf_stream_class_id;
  75
  76     /* base offset in current index. */
  77     uint64_t base_offset;
  78     /* len to read in current index. */
  79     uint64_t len;
  80     /* offset in current index. */
  81     uint64_t offset;
  82
  83     /*
  84      * Clock Snapshot value of the last message iterator inactivity message
  85      * sent downstream.
  86      */
  87     struct
  88     {
  89         bool is_set;
  90         uint64_t value;
  91     } last_inactivity_ts;
  92
  93     /*
  94      * Clock Snapshot value of the current message iterator inactivity
  95      * message we might want to send downstream.
  96      */
  97     uint64_t current_inactivity_ts;
  98
  99     enum lttng_live_stream_state state;
 100
 101     /*
 102      * The current message produced by this live stream iterator. Owned by
 103      * this.
 104      */
 105     const bt_message *current_msg;
 106
 107     /* Timestamp in nanoseconds of the current message (current_msg). */
 108     int64_t current_msg_ts_ns;
 109
 110     /* Owned by this. */
 111     uint8_t *buf;
 112     size_t buflen;
 113
 114     /* Owned by this. */
 115     GString *name;
 116
 117     bool has_stream_hung_up;
 118 };
 119
 120 struct lttng_live_metadata
 121 {
 122     bt_logging_level log_level;
 123     bt_self_component *self_comp;
 124
 125     uint64_t stream_id;
 126     /* Weak reference. */
 127     struct ctf_metadata_decoder *decoder;
 128 };
 129
 130 enum lttng_live_metadata_stream_state
 131 {
 132     /*
 133      * The metadata needs to be updated. This is either because we just
 134      * created the trace and haven't asked yet, or the relay specifically
 135      * told us that new metadata is available.
 136      */
 137     LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED,
 138     /*
 139      * The metadata was updated and the relay has not told us we need to
 140      * update it yet.
 141      */
 142     LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED,
 143     /*
 144      * The relay has closed this metadata stream. We set this in reaction
 145      * to a LTTNG_VIEWER_METADATA_ERR reply to a LTTNG_VIEWER_GET_METADATA
 146      * command to the relay. If this field is set, we have received all the
 147      * metadata that we are ever going to get for that metadata stream.
 148      */
 149     LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED,
 150 };
 151
 152 struct lttng_live_trace
 153 {
 154     bt_logging_level log_level;
 155     bt_self_component *self_comp;
 156
 157     /* Back reference to session. */
 158     struct lttng_live_session *session;
 159
 160     /* ctf trace ID within the session. */
 161     uint64_t id;
 162
 163     /* Owned by this. */
 164     bt_trace *trace;
 165
 166     /* Weak reference. */
 167     bt_trace_class *trace_class;
 168
 169     struct lttng_live_metadata *metadata;
 170
 171     const bt_clock_class *clock_class;
 172
 173     /* Array of pointers to struct lttng_live_stream_iterator. */
 174     /* Owned by this. */
 175     GPtrArray *stream_iterators;
 176
 177     enum lttng_live_metadata_stream_state metadata_stream_state;
 178 };
 179
 180 struct lttng_live_session
 181 {
 182     bt_logging_level log_level;
 183     bt_self_component *self_comp;
 184
 185     /* Weak reference. */
 186     struct lttng_live_msg_iter *lttng_live_msg_iter;
 187
 188     /* Owned by this. */
 189     GString *hostname;
 190
 191     /* Owned by this. */
 192     GString *session_name;
 193
 194     uint64_t id;
 195
 196     /* Array of pointers to struct lttng_live_trace. */
 197     GPtrArray *traces;
 198
 199     bool attached;
 200     bool new_streams_needed;
 201     bool lazy_stream_msg_init;
 202     bool closed;
 203 };
 204
 205 enum session_not_found_action
 206 {
 207     SESSION_NOT_FOUND_ACTION_CONTINUE,
 208     SESSION_NOT_FOUND_ACTION_FAIL,
 209     SESSION_NOT_FOUND_ACTION_END,
 210 };
 211
 212 /*
 213  * A component instance is an iterator on a single session.
 214  */
 215 struct lttng_live_component
 216 {
 217     bt_logging_level log_level;
 218
 219     /* Weak reference. */
 220     bt_self_component *self_comp;
 221
 222     struct
 223     {
 224         GString *url;
 225         enum session_not_found_action sess_not_found_act;
 226     } params;
 227
 228     size_t max_query_size;
 229
 230     /*
 231      * Keeps track of whether the downstream component already has a
 232      * message iterator on this component.
 233      */
 234     bool has_msg_iter;
 235 };
 236
 237 struct lttng_live_msg_iter
 238 {
 239     bt_logging_level log_level;
 240     bt_self_component *self_comp;
 241
 242     /* Weak reference. */
 243     struct lttng_live_component *lttng_live_comp;
 244
 245     /* Weak reference. */
 246     bt_self_message_iterator *self_msg_iter;
 247
 248     /* Owned by this. */
 249     struct live_viewer_connection *viewer_connection;
 250
 251     /* Array of pointers to struct lttng_live_session. */
 252     GPtrArray *sessions;
 253
 254     /* Number of live stream iterator this message iterator has.*/
 255     uint64_t active_stream_iter;
 256
 257     /* Timestamp in nanosecond of the last message sent downstream. */
 258     int64_t last_msg_ts_ns;
 259
 260     /* True if the iterator was interrupted. */
 261     bool was_interrupted;
 262 };
 263
 264 enum lttng_live_iterator_status
 265 {
 266     /** Iterator state has progressed. Continue iteration immediately. */
 267     LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
 268     /** No message available for now. Try again later. */
 269     LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
 270     /** No more CTF_LTTNG_LIVEs to be delivered. */
 271     LTTNG_LIVE_ITERATOR_STATUS_END = 1,
 272     /** No error, okay. */
 273     LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
 274     /** Invalid arguments. */
 275     LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
 276     /** General error. */
 277     LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
 278     /** Out of memory. */
 279     LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
 280     /** Unsupported iterator feature. */
 281     LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
 282 };
 283
 284 bt_component_class_initialize_method_status
 285 lttng_live_component_init(bt_self_component_source *self_comp,
 286                           bt_self_component_source_configuration *config, const bt_value *params,
 287                           void *init_method_data);
 288
 289 bt_component_class_query_method_status lttng_live_query(bt_self_component_class_source *comp_class,
 290                                                         bt_private_query_executor *priv_query_exec,
 291                                                         const char *object, const bt_value *params,
 292                                                         void *method_data, const bt_value **result);
 293
 294 void lttng_live_component_finalize(bt_self_component_source *component);
 295
 296 bt_message_iterator_class_next_method_status
 297 lttng_live_msg_iter_next(bt_self_message_iterator *iterator, bt_message_array_const msgs,
 298                          uint64_t capacity, uint64_t *count);
 299
 300 bt_message_iterator_class_initialize_method_status
 301 lttng_live_msg_iter_init(bt_self_message_iterator *self_msg_it,
 302                          bt_self_message_iterator_configuration *config,
 303                          bt_self_component_port_output *self_port);
 304
 305 void lttng_live_msg_iter_finalize(bt_self_message_iterator *it);
 306
 307 enum lttng_live_viewer_status lttng_live_session_attach(struct lttng_live_session *session,
 308                                                         bt_self_message_iterator *self_msg_iter);
 309
 310 enum lttng_live_viewer_status lttng_live_session_detach(struct lttng_live_session *session);
 311
 312 enum lttng_live_iterator_status
 313 lttng_live_session_get_new_streams(struct lttng_live_session *session,
 314                                    bt_self_message_iterator *self_msg_iter);
 315
 316 struct lttng_live_trace *
 317 lttng_live_session_borrow_or_create_trace_by_id(struct lttng_live_session *session,
 318                                                 uint64_t trace_id);
 319
 320 int lttng_live_add_session(struct lttng_live_msg_iter *lttng_live_msg_iter, uint64_t session_id,
 321                            const char *hostname, const char *session_name);
 322
 323 /*
 324  * lttng_live_get_one_metadata_packet() asks the Relay Daemon for new metadata.
 325  * If new metadata is received, the function writes it to the provided file
 326  * handle and updates the reply_len output parameter. This function should be
 327  * called in loop until _END status is received to ensure all metadata is
 328  * written to the file.
 329  */
 330 enum lttng_live_get_one_metadata_status
 331 lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace, FILE *fp, size_t *reply_len);
 332
 333 enum lttng_live_iterator_status
 334 lttng_live_get_next_index(struct lttng_live_msg_iter *lttng_live_msg_iter,
 335                           struct lttng_live_stream_iterator *stream, struct packet_index *index);
 336
 337 enum ctf_msg_iter_medium_status
 338 lttng_live_get_stream_bytes(struct lttng_live_msg_iter *lttng_live_msg_iter,
 339                             struct lttng_live_stream_iterator *stream, uint8_t *buf,
 340                             uint64_t offset, uint64_t req_len, uint64_t *recv_len);
 341
 342 bool lttng_live_graph_is_canceled(struct lttng_live_msg_iter *msg_iter);
 343
 344 BT_HIDDEN
 345 void lttng_live_stream_iterator_set_state(struct lttng_live_stream_iterator *stream_iter,
 346                                           enum lttng_live_stream_state new_state);
 347
 348 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_H */