src/plugins/ctf/lttng-live/data-stream.c

   1 /*
   2  * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
   3  * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
   4  * Copyright 2016 - Jérémie Galarneau <jeremie.galarneau@efficios.com>
   5  * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
   6  *
   7  * Permission is hereby granted, free of charge, to any person obtaining a copy
   8  * of this software and associated documentation files (the "Software"), to deal
   9  * in the Software without restriction, including without limitation the rights
  10  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  11  * copies of the Software, and to permit persons to whom the Software is
  12  * furnished to do so, subject to the following conditions:
  13  *
  14  * The above copyright notice and this permission notice shall be included in
  15  * all copies or substantial portions of the Software.
  16  *
  17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  18  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  19  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  20  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  21  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  22  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  23  * SOFTWARE.
  24  */
  25
  26 #define BT_COMP_LOG_SELF_COMP self_comp
  27 #define BT_LOG_OUTPUT_LEVEL log_level
  28 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/DS"
  29 #include "logging/comp-logging.h"
  30
  31 #include <inttypes.h>
  32 #include <stdio.h>
  33 #include <stdlib.h>
  34
  35 #include <glib.h>
  36
  37 #include <babeltrace2/babeltrace.h>
  38
  39 #include "../common/msg-iter/msg-iter.h"
  40 #include "common/assert.h"
  41 #include "compat/mman.h"
  42 #include "data-stream.h"
  43
  44 #define STREAM_NAME_PREFIX      "stream-"
  45
  46 static
  47 enum ctf_msg_iter_medium_status medop_request_bytes(
  48                 size_t request_sz, uint8_t **buffer_addr,
  49                 size_t *buffer_sz, void *data)
  50 {
  51         enum ctf_msg_iter_medium_status status =
  52                 CTF_MSG_ITER_MEDIUM_STATUS_OK;
  53         struct lttng_live_stream_iterator *stream = data;
  54         struct lttng_live_trace *trace = stream->trace;
  55         struct lttng_live_session *session = trace->session;
  56         struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
  57         uint64_t recv_len = 0;
  58         uint64_t len_left;
  59         uint64_t read_len;
  60
  61         if (stream->has_stream_hung_up) {
  62                 status = CTF_MSG_ITER_MEDIUM_STATUS_EOF;
  63                 goto end;
  64         }
  65
  66         len_left = stream->base_offset + stream->len - stream->offset;
  67         if (!len_left) {
  68                 stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
  69                 status = CTF_MSG_ITER_MEDIUM_STATUS_AGAIN;
  70                 goto end;
  71         }
  72
  73         read_len = MIN(request_sz, stream->buflen);
  74         read_len = MIN(read_len, len_left);
  75         status = lttng_live_get_stream_bytes(live_msg_iter,
  76                         stream, stream->buf, stream->offset,
  77                         read_len, &recv_len);
  78         *buffer_addr = stream->buf;
  79         *buffer_sz = recv_len;
  80         stream->offset += recv_len;
  81 end:
  82         return status;
  83 }
  84
  85 static
  86 bt_stream *medop_borrow_stream(bt_stream_class *stream_class,
  87                 int64_t stream_id, void *data)
  88 {
  89         struct lttng_live_stream_iterator *lttng_live_stream = data;
  90         bt_logging_level log_level = lttng_live_stream->log_level;
  91         bt_self_component *self_comp = lttng_live_stream->self_comp;
  92
  93         if (!lttng_live_stream->stream) {
  94                 uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
  95
  96                 BT_COMP_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
  97                         "class %" PRId64, lttng_live_stream->name->str,
  98                         stream_id, stream_class_id);
  99
 100                 if (stream_id < 0) {
 101                         /*
 102                          * No stream instance ID in the stream. It's possible
 103                          * to encounter this situation with older version of
 104                          * LTTng. In these cases, use the viewer_stream_id that
 105                          * is unique for a live viewer session.
 106                          */
 107                         lttng_live_stream->stream = bt_stream_create_with_id(
 108                                 stream_class, lttng_live_stream->trace->trace,
 109                                 lttng_live_stream->viewer_stream_id);
 110                 } else {
 111                         lttng_live_stream->stream = bt_stream_create_with_id(
 112                                 stream_class, lttng_live_stream->trace->trace,
 113                                 (uint64_t) stream_id);
 114                 }
 115
 116                 if (!lttng_live_stream->stream) {
 117                         BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 118                                 "Cannot create stream %s (stream class ID "
 119                                 "%" PRId64 ", stream ID %" PRIu64 ")",
 120                                 lttng_live_stream->name->str,
 121                                 stream_class_id, stream_id);
 122                         goto end;
 123                 }
 124
 125                 bt_stream_set_name(lttng_live_stream->stream,
 126                         lttng_live_stream->name->str);
 127         }
 128
 129 end:
 130         return lttng_live_stream->stream;
 131 }
 132
 133 static struct ctf_msg_iter_medium_ops medops = {
 134         .request_bytes = medop_request_bytes,
 135         .seek = NULL,
 136         .borrow_stream = medop_borrow_stream,
 137 };
 138
 139 BT_HIDDEN
 140 enum lttng_live_iterator_status lttng_live_lazy_msg_init(
 141                 struct lttng_live_session *session,
 142                 bt_self_message_iterator *self_msg_iter)
 143 {
 144         struct lttng_live_component *lttng_live =
 145                 session->lttng_live_msg_iter->lttng_live_comp;
 146         uint64_t trace_idx, stream_iter_idx;
 147         bt_logging_level log_level = session->log_level;
 148         bt_self_component *self_comp = session->self_comp;
 149
 150         if (!session->lazy_stream_msg_init) {
 151                 return LTTNG_LIVE_ITERATOR_STATUS_OK;
 152         }
 153
 154         BT_COMP_LOGD("Lazily initializing self message iterator for live session: "
 155                 "session-id=%"PRIu64", self-msg-iter-addr=%p", session->id,
 156                 self_msg_iter);
 157
 158         for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
 159                 struct lttng_live_trace *trace =
 160                         g_ptr_array_index(session->traces, trace_idx);
 161
 162                 for (stream_iter_idx = 0;
 163                                 stream_iter_idx < trace->stream_iterators->len;
 164                                 stream_iter_idx++) {
 165                         struct ctf_trace_class *ctf_tc;
 166                         struct lttng_live_stream_iterator *stream_iter =
 167                                 g_ptr_array_index(trace->stream_iterators,
 168                                         stream_iter_idx);
 169
 170                         if (stream_iter->msg_iter) {
 171                                 continue;
 172                         }
 173                         ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
 174                                 trace->metadata->decoder);
 175                         BT_COMP_LOGD("Creating CTF message iterator: "
 176                                 "session-id=%"PRIu64", ctf-tc-addr=%p, "
 177                                 "stream-iter-name=%s, self-msg-iter-addr=%p",
 178                                 session->id, ctf_tc, stream_iter->name->str, self_msg_iter);
 179                         stream_iter->msg_iter = ctf_msg_iter_create(ctf_tc,
 180                                 lttng_live->max_query_size, medops, stream_iter,
 181                                 log_level, self_comp, self_msg_iter);
 182                         if (!stream_iter->msg_iter) {
 183                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 184                                         "Failed to create CTF message iterator");
 185                                 goto error;
 186                         }
 187
 188                         ctf_msg_iter_set_emit_stream_end_message(
 189                                 stream_iter->msg_iter, true);
 190                         ctf_msg_iter_set_emit_stream_beginning_message(
 191                                 stream_iter->msg_iter, true);
 192                 }
 193         }
 194
 195         session->lazy_stream_msg_init = false;
 196
 197         return LTTNG_LIVE_ITERATOR_STATUS_OK;
 198
 199 error:
 200         return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 201 }
 202
 203 BT_HIDDEN
 204 struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
 205                 struct lttng_live_session *session,
 206                 uint64_t ctf_trace_id,
 207                 uint64_t stream_id,
 208                 bt_self_message_iterator *self_msg_iter)
 209 {
 210         struct lttng_live_stream_iterator *stream_iter;
 211         struct lttng_live_component *lttng_live;
 212         struct lttng_live_trace *trace;
 213         bt_logging_level log_level;
 214         bt_self_component *self_comp;
 215
 216         BT_ASSERT(session);
 217         BT_ASSERT(session->lttng_live_msg_iter);
 218         BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
 219         log_level = session->log_level;
 220         self_comp = session->self_comp;
 221
 222         lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
 223
 224         stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
 225         if (!stream_iter) {
 226                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 227                         "Failed to allocate struct lttng_live_stream_iterator");
 228                 goto error;
 229         }
 230
 231         stream_iter->log_level = log_level;
 232         stream_iter->self_comp = self_comp;
 233         trace = lttng_live_borrow_trace(session, ctf_trace_id);
 234         if (!trace) {
 235                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 236                         "Failed to borrow CTF trace.");
 237                 goto error;
 238         }
 239
 240         stream_iter->trace = trace;
 241         stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
 242         stream_iter->viewer_stream_id = stream_id;
 243         stream_iter->ctf_stream_class_id = -1ULL;
 244         stream_iter->last_inactivity_ts = INT64_MIN;
 245
 246         if (trace->trace) {
 247                 struct ctf_trace_class *ctf_tc =
 248                         ctf_metadata_decoder_borrow_ctf_trace_class(
 249                                 trace->metadata->decoder);
 250                 BT_ASSERT(!stream_iter->msg_iter);
 251                 stream_iter->msg_iter = ctf_msg_iter_create(ctf_tc,
 252                         lttng_live->max_query_size, medops, stream_iter,
 253                         log_level, self_comp, self_msg_iter);
 254                 if (!stream_iter->msg_iter) {
 255                         BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 256                                 "Failed to create CTF message iterator");
 257                         goto error;
 258                 }
 259
 260                 ctf_msg_iter_set_emit_stream_end_message(
 261                         stream_iter->msg_iter, true);
 262                 ctf_msg_iter_set_emit_stream_beginning_message(
 263                         stream_iter->msg_iter, true);
 264         }
 265         stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
 266         if (!stream_iter->buf) {
 267                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 268                         "Failed to allocate live stream iterator buffer");
 269                 goto error;
 270         }
 271
 272         stream_iter->buflen = lttng_live->max_query_size;
 273         stream_iter->name = g_string_new(NULL);
 274         if (!stream_iter->name) {
 275                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 276                         "Failed to allocate live stream iterator name buffer");
 277                 goto error;
 278         }
 279
 280         g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
 281                 stream_iter->viewer_stream_id);
 282         g_ptr_array_add(trace->stream_iterators, stream_iter);
 283
 284         /* Track the number of active stream iterator. */
 285         session->lttng_live_msg_iter->active_stream_iter++;
 286
 287         goto end;
 288 error:
 289         lttng_live_stream_iterator_destroy(stream_iter);
 290         stream_iter = NULL;
 291 end:
 292         return stream_iter;
 293 }
 294
 295 BT_HIDDEN
 296 void lttng_live_stream_iterator_destroy(
 297                 struct lttng_live_stream_iterator *stream_iter)
 298 {
 299         if (!stream_iter) {
 300                 return;
 301         }
 302
 303         if (stream_iter->stream) {
 304                 BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
 305         }
 306
 307         if (stream_iter->msg_iter) {
 308                 ctf_msg_iter_destroy(stream_iter->msg_iter);
 309         }
 310         g_free(stream_iter->buf);
 311         if (stream_iter->name) {
 312                 g_string_free(stream_iter->name, TRUE);
 313         }
 314
 315         bt_message_put_ref(stream_iter->current_msg);
 316
 317         /* Track the number of active stream iterator. */
 318         stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
 319
 320         /*
 321          * Ensure we poke the trace metadata in the future, which is
 322          * required to release the metadata reference on the trace.
 323          */
 324         stream_iter->trace->new_metadata_needed = true;
 325         g_free(stream_iter);
 326 }