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

   1 #ifndef BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
   2 #define BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H
   3
   4 /*
   5  * BabelTrace - LTTng-live client Component
   6  *
   7  * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
   8  * Copyright 2016 Mathieu Desnoyers <mathieu.desnoyers@efficios.com>
   9  *
  10  * Author: Jérémie Galarneau <jeremie.galarneau@efficios.com>
  11  *
  12  * Permission is hereby granted, free of charge, to any person obtaining a copy
  13  * of this software and associated documentation files (the "Software"), to deal
  14  * in the Software without restriction, including without limitation the rights
  15  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  16  * copies of the Software, and to permit persons to whom the Software is
  17  * furnished to do so, subject to the following conditions:
  18  *
  19  * The above copyright notice and this permission notice shall be included in
  20  * all copies or substantial portions of the Software.
  21  *
  22  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  23  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  24  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  25  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  26  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  27  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  28  * SOFTWARE.
  29  */
  30
  31 #include <stdbool.h>
  32
  33 #include <babeltrace/babeltrace-internal.h>
  34
  35 #define BT_LOG_OUTPUT_LEVEL bt_lttng_live_log_level
  36 #include <babeltrace/logging-internal.h>
  37
  38 #include <babeltrace/graph/component.h>
  39 #include <babeltrace/graph/notification-iterator.h>
  40 #include <babeltrace/graph/clock-class-priority-map.h>
  41 #include "viewer-connection.h"
  42
  43 //TODO: this should not be used by plugins. Should copy code into plugin
  44 //instead.
  45 #include "babeltrace/object-internal.h"
  46 #include "babeltrace/list-internal.h"
  47 #include "../common/metadata/decoder.h"
  48
  49 #define STREAM_NAME_PREFIX      "stream-"
  50 /* Account for u64 max string length. */
  51 #define U64_STR_MAX_LEN         20
  52 #define STREAM_NAME_MAX_LEN     (sizeof(STREAM_NAME_PREFIX) + U64_STR_MAX_LEN)
  53
  54 extern int bt_lttng_live_log_level;
  55
  56 struct lttng_live_component;
  57 struct lttng_live_session;
  58
  59 enum lttng_live_stream_state {
  60         LTTNG_LIVE_STREAM_ACTIVE_NO_DATA,
  61         LTTNG_LIVE_STREAM_QUIESCENT_NO_DATA,
  62         LTTNG_LIVE_STREAM_QUIESCENT,
  63         LTTNG_LIVE_STREAM_ACTIVE_DATA,
  64         LTTNG_LIVE_STREAM_EOF,
  65 };
  66
  67 enum live_stream_type {
  68         LIVE_STREAM_TYPE_NO_STREAM,
  69         LIVE_STREAM_TYPE_STREAM,
  70 };
  71
  72 struct lttng_live_stream_iterator_generic {
  73         enum live_stream_type type;
  74 };
  75
  76 /* Iterator over a live stream. */
  77 struct lttng_live_stream_iterator {
  78         struct lttng_live_stream_iterator_generic p;
  79
  80         struct bt_ctf_stream *stream;
  81         struct lttng_live_trace *trace;
  82         struct bt_private_port *port;
  83
  84         /* Node of stream list within the trace. */
  85         struct bt_list_head node;
  86
  87         /*
  88          * Since only a single iterator per viewer connection, we have
  89          * only a single notification iterator per stream.
  90          */
  91         struct bt_ctf_notif_iter *notif_iter;
  92
  93         uint64_t viewer_stream_id;
  94
  95         uint64_t ctf_stream_class_id;
  96         uint64_t base_offset;           /* base offset in current index. */
  97         uint64_t len;                   /* len to read in current index. */
  98         uint64_t offset;                /* offset in current index. */
  99
 100         int64_t last_returned_inactivity_timestamp;
 101         int64_t current_inactivity_timestamp;
 102
 103         enum lttng_live_stream_state state;
 104
 105         uint64_t current_packet_end_timestamp;
 106         struct bt_notification *packet_end_notif_queue;
 107
 108         uint8_t *buf;
 109         size_t buflen;
 110
 111         char name[STREAM_NAME_MAX_LEN];
 112 };
 113
 114 struct lttng_live_no_stream_iterator {
 115         struct lttng_live_stream_iterator_generic p;
 116
 117         struct lttng_live_component *lttng_live;
 118         struct bt_private_port *port;
 119 };
 120
 121 struct lttng_live_component_options {
 122         bool opt_dummy : 1;
 123 };
 124
 125 struct lttng_live_metadata {
 126         struct lttng_live_trace *trace;
 127         uint64_t stream_id;
 128         uint8_t uuid[16];
 129         bool is_uuid_set;
 130         int bo;
 131         char *text;
 132
 133         struct ctf_metadata_decoder *decoder;
 134
 135         bool closed;
 136 };
 137
 138 struct lttng_live_trace {
 139         struct bt_object obj;
 140
 141         /* Node of trace list within the session. */
 142         struct bt_list_head node;
 143
 144         /* Back reference to session. */
 145         struct lttng_live_session *session;
 146
 147         uint64_t id;    /* ctf trace ID within the session. */
 148
 149         struct bt_ctf_trace *trace;
 150
 151         struct lttng_live_metadata *metadata;
 152         struct bt_clock_class_priority_map *cc_prio_map;
 153
 154         /* List of struct lttng_live_stream_iterator */
 155         struct bt_list_head streams;
 156
 157         bool new_metadata_needed;
 158 };
 159
 160 struct lttng_live_session {
 161         /* Node of session list within the component. */
 162         struct bt_list_head node;
 163
 164         struct lttng_live_component *lttng_live;
 165
 166         uint64_t id;
 167
 168         /* List of struct lttng_live_trace */
 169         struct bt_list_head traces;
 170
 171         bool attached;
 172         bool new_streams_needed;
 173         bool lazy_stream_notif_init;
 174         bool closed;
 175 };
 176
 177 /*
 178  * A component instance is an iterator on a single session.
 179  */
 180 struct lttng_live_component {
 181         struct bt_object obj;
 182         struct bt_private_component *private_component; /* weak */
 183         struct bt_live_viewer_connection *viewer_connection;
 184
 185         /* List of struct lttng_live_session */
 186         struct bt_list_head sessions;
 187
 188         GString *url;
 189         size_t max_query_size;
 190         struct lttng_live_component_options options;
 191
 192         struct bt_private_port *no_stream_port;
 193         struct lttng_live_no_stream_iterator *no_stream_iter;
 194 };
 195
 196 enum bt_ctf_lttng_live_iterator_status {
 197         /** Iterator state has progressed. Continue iteration immediately. */
 198         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_CONTINUE = 3,
 199         /** No notification available for now. Try again later. */
 200         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_AGAIN = 2,
 201         /** No more CTF_LTTNG_LIVEs to be delivered. */
 202         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_END = 1,
 203         /** No error, okay. */
 204         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_OK = 0,
 205         /** Invalid arguments. */
 206         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_INVAL = -1,
 207         /** General error. */
 208         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_ERROR = -2,
 209         /** Out of memory. */
 210         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_NOMEM = -3,
 211         /** Unsupported iterator feature. */
 212         BT_CTF_LTTNG_LIVE_ITERATOR_STATUS_UNSUPPORTED = -4,
 213 };
 214
 215 BT_HIDDEN
 216 enum bt_component_status lttng_live_component_init(struct bt_private_component *source,
 217                 struct bt_value *params, void *init_method_data);
 218
 219 struct bt_value *lttng_live_query(struct bt_component_class *comp_class,
 220                 const char *object, struct bt_value *params);
 221
 222 void lttng_live_component_finalize(struct bt_private_component *component);
 223
 224 BT_HIDDEN
 225 struct bt_notification_iterator_next_return lttng_live_iterator_next(
 226         struct bt_private_notification_iterator *iterator);
 227
 228
 229 enum bt_notification_iterator_status lttng_live_iterator_init(
 230                 struct bt_private_notification_iterator *it,
 231                 struct bt_private_port *port);
 232
 233 void lttng_live_iterator_finalize(struct bt_private_notification_iterator *it);
 234
 235 int lttng_live_create_viewer_session(struct lttng_live_component *lttng_live);
 236 int lttng_live_attach_session(struct lttng_live_session *session);
 237 int lttng_live_detach_session(struct lttng_live_session *session);
 238 enum bt_ctf_lttng_live_iterator_status lttng_live_get_new_streams(
 239                 struct lttng_live_session *session);
 240
 241 int lttng_live_add_session(struct lttng_live_component *lttng_live, uint64_t session_id);
 242
 243 ssize_t lttng_live_get_one_metadata_packet(struct lttng_live_trace *trace,
 244                 FILE *fp);
 245 enum bt_ctf_lttng_live_iterator_status lttng_live_get_next_index(
 246                 struct lttng_live_component *lttng_live,
 247                 struct lttng_live_stream_iterator *stream,
 248                 struct packet_index *index);
 249 enum bt_ctf_notif_iter_medium_status lttng_live_get_stream_bytes(
 250                 struct lttng_live_component *lttng_live,
 251                 struct lttng_live_stream_iterator *stream, uint8_t *buf, uint64_t offset,
 252                 uint64_t req_len, uint64_t *recv_len);
 253
 254 int lttng_live_add_port(struct lttng_live_component *lttng_live,
 255                 struct lttng_live_stream_iterator *stream_iter);
 256 int lttng_live_remove_port(struct lttng_live_component *lttng_live,
 257                 struct bt_private_port *port);
 258
 259 struct lttng_live_trace *lttng_live_ref_trace(
 260                 struct lttng_live_session *session, uint64_t trace_id);
 261 void lttng_live_unref_trace(struct lttng_live_trace *trace);
 262 void lttng_live_need_new_streams(struct lttng_live_component *lttng_live);
 263
 264 #endif /* BABELTRACE_PLUGIN_CTF_LTTNG_LIVE_INTERNAL_H */