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

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