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 <stdio.h>
  32 #include <stdint.h>
  33 #include <stdlib.h>
  34 #include <glib.h>
  35 #include <inttypes.h>
  36 #include "compat/mman.h"
  37 #include <babeltrace2/babeltrace.h>
  38 #include "../common/msg-iter/msg-iter.h"
  39 #include "common/assert.h"
  40
  41 #include "data-stream.h"
  42
  43 #define STREAM_NAME_PREFIX      "stream-"
  44
  45 static
  46 enum bt_msg_iter_medium_status medop_request_bytes(
  47                 size_t request_sz, uint8_t **buffer_addr,
  48                 size_t *buffer_sz, void *data)
  49 {
  50         enum bt_msg_iter_medium_status status =
  51                 BT_MSG_ITER_MEDIUM_STATUS_OK;
  52         struct lttng_live_stream_iterator *stream = data;
  53         struct lttng_live_trace *trace = stream->trace;
  54         struct lttng_live_session *session = trace->session;
  55         struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
  56         uint64_t recv_len = 0;
  57         uint64_t len_left;
  58         uint64_t read_len;
  59
  60         if (stream->has_stream_hung_up) {
  61                 status = BT_MSG_ITER_MEDIUM_STATUS_EOF;
  62                 goto end;
  63         }
  64
  65         len_left = stream->base_offset + stream->len - stream->offset;
  66         if (!len_left) {
  67                 stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
  68                 status = BT_MSG_ITER_MEDIUM_STATUS_AGAIN;
  69                 goto end;
  70         }
  71
  72         read_len = MIN(request_sz, stream->buflen);
  73         read_len = MIN(read_len, len_left);
  74         status = lttng_live_get_stream_bytes(live_msg_iter,
  75                         stream, stream->buf, stream->offset,
  76                         read_len, &recv_len);
  77         *buffer_addr = stream->buf;
  78         *buffer_sz = recv_len;
  79         stream->offset += recv_len;
  80 end:
  81         return status;
  82 }
  83
  84 static
  85 bt_stream *medop_borrow_stream(bt_stream_class *stream_class,
  86                 int64_t stream_id, void *data)
  87 {
  88         struct lttng_live_stream_iterator *lttng_live_stream = data;
  89         bt_logging_level log_level = lttng_live_stream->log_level;
  90         bt_self_component *self_comp = lttng_live_stream->self_comp;
  91
  92         if (!lttng_live_stream->stream) {
  93                 uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
  94
  95                 BT_COMP_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
  96                         "class %" PRId64, lttng_live_stream->name->str,
  97                         stream_id, stream_class_id);
  98
  99                 if (stream_id < 0) {
 100                         /*
 101                          * No stream instance ID in the stream. It's possible
 102                          * to encounter this situation with older version of
 103                          * LTTng. In these cases, use the viewer_stream_id that
 104                          * is unique for a live viewer session.
 105                          */
 106                         lttng_live_stream->stream = bt_stream_create_with_id(
 107                                 stream_class, lttng_live_stream->trace->trace,
 108                                 lttng_live_stream->viewer_stream_id);
 109                 } else {
 110                         lttng_live_stream->stream = bt_stream_create_with_id(
 111                                 stream_class, lttng_live_stream->trace->trace,
 112                                 (uint64_t) stream_id);
 113                 }
 114
 115                 if (!lttng_live_stream->stream) {
 116                         BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 117                                 "Cannot create stream %s (stream class ID "
 118                                 "%" PRId64 ", stream ID %" PRIu64 ")",
 119                                 lttng_live_stream->name->str,
 120                                 stream_class_id, stream_id);
 121                         goto end;
 122                 }
 123
 124                 bt_stream_set_name(lttng_live_stream->stream,
 125                         lttng_live_stream->name->str);
 126         }
 127
 128 end:
 129         return lttng_live_stream->stream;
 130 }
 131
 132 static struct bt_msg_iter_medium_ops medops = {
 133         .request_bytes = medop_request_bytes,
 134         .seek = NULL,
 135         .borrow_stream = medop_borrow_stream,
 136 };
 137
 138 BT_HIDDEN
 139 enum lttng_live_iterator_status lttng_live_lazy_msg_init(
 140                 struct lttng_live_session *session)
 141 {
 142         struct lttng_live_component *lttng_live =
 143                 session->lttng_live_msg_iter->lttng_live_comp;
 144         uint64_t trace_idx, stream_iter_idx;
 145         bt_logging_level log_level = session->log_level;
 146         bt_self_component *self_comp = session->self_comp;
 147
 148         if (!session->lazy_stream_msg_init) {
 149                 return LTTNG_LIVE_ITERATOR_STATUS_OK;
 150         }
 151
 152         for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
 153                 struct lttng_live_trace *trace =
 154                         g_ptr_array_index(session->traces, trace_idx);
 155
 156                 for (stream_iter_idx = 0;
 157                                 stream_iter_idx < trace->stream_iterators->len;
 158                                 stream_iter_idx++) {
 159                         struct ctf_trace_class *ctf_tc;
 160                         struct lttng_live_stream_iterator *stream_iter =
 161                                 g_ptr_array_index(trace->stream_iterators,
 162                                         stream_iter_idx);
 163
 164                         if (stream_iter->msg_iter) {
 165                                 continue;
 166                         }
 167                         ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
 168                                 trace->metadata->decoder);
 169                         stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
 170                                 lttng_live->max_query_size, medops, stream_iter,
 171                                 log_level, self_comp);
 172                         if (!stream_iter->msg_iter) {
 173                                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 174                                         "Failed to create CTF message iterator");
 175                                 goto error;
 176                         }
 177
 178                         bt_msg_iter_set_emit_stream_end_message(
 179                                 stream_iter->msg_iter, true);
 180                         bt_msg_iter_set_emit_stream_beginning_message(
 181                                 stream_iter->msg_iter, true);
 182                 }
 183         }
 184
 185         session->lazy_stream_msg_init = false;
 186
 187         return LTTNG_LIVE_ITERATOR_STATUS_OK;
 188
 189 error:
 190         return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 191 }
 192
 193 BT_HIDDEN
 194 struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
 195                 struct lttng_live_session *session,
 196                 uint64_t ctf_trace_id,
 197                 uint64_t stream_id)
 198 {
 199         struct lttng_live_stream_iterator *stream_iter;
 200         struct lttng_live_component *lttng_live;
 201         struct lttng_live_trace *trace;
 202         bt_logging_level log_level;
 203         bt_self_component *self_comp;
 204
 205         BT_ASSERT(session);
 206         BT_ASSERT(session->lttng_live_msg_iter);
 207         BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
 208         log_level = session->log_level;
 209         self_comp = session->self_comp;
 210
 211         lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
 212
 213         stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
 214         if (!stream_iter) {
 215                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 216                         "Failed to allocate struct lttng_live_stream_iterator");
 217                 goto error;
 218         }
 219
 220         stream_iter->log_level = log_level;
 221         stream_iter->self_comp = self_comp;
 222         trace = lttng_live_borrow_trace(session, ctf_trace_id);
 223         if (!trace) {
 224                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 225                         "Failed to borrow CTF trace.");
 226                 goto error;
 227         }
 228
 229         stream_iter->trace = trace;
 230         stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
 231         stream_iter->viewer_stream_id = stream_id;
 232         stream_iter->ctf_stream_class_id = -1ULL;
 233         stream_iter->last_inactivity_ts = INT64_MIN;
 234
 235         if (trace->trace) {
 236                 struct ctf_trace_class *ctf_tc =
 237                         ctf_metadata_decoder_borrow_ctf_trace_class(
 238                                 trace->metadata->decoder);
 239                 BT_ASSERT(!stream_iter->msg_iter);
 240                 stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
 241                         lttng_live->max_query_size, medops, stream_iter,
 242                         log_level, self_comp);
 243                 if (!stream_iter->msg_iter) {
 244                         BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 245                                 "Failed to create CTF message iterator");
 246                         goto error;
 247                 }
 248
 249                 bt_msg_iter_set_emit_stream_end_message(
 250                         stream_iter->msg_iter, true);
 251                 bt_msg_iter_set_emit_stream_beginning_message(
 252                         stream_iter->msg_iter, true);
 253         }
 254         stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
 255         if (!stream_iter->buf) {
 256                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 257                         "Failed to allocate live stream iterator buffer");
 258                 goto error;
 259         }
 260
 261         stream_iter->buflen = lttng_live->max_query_size;
 262         stream_iter->name = g_string_new(NULL);
 263         if (!stream_iter->name) {
 264                 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
 265                         "Failed to allocate live stream iterator name buffer");
 266                 goto error;
 267         }
 268
 269         g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
 270                 stream_iter->viewer_stream_id);
 271         g_ptr_array_add(trace->stream_iterators, stream_iter);
 272
 273         /* Track the number of active stream iterator. */
 274         session->lttng_live_msg_iter->active_stream_iter++;
 275
 276         goto end;
 277 error:
 278         lttng_live_stream_iterator_destroy(stream_iter);
 279         stream_iter = NULL;
 280 end:
 281         return stream_iter;
 282 }
 283
 284 BT_HIDDEN
 285 void lttng_live_stream_iterator_destroy(
 286                 struct lttng_live_stream_iterator *stream_iter)
 287 {
 288         if (!stream_iter) {
 289                 return;
 290         }
 291
 292         if (stream_iter->stream) {
 293                 BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
 294         }
 295
 296         if (stream_iter->msg_iter) {
 297                 bt_msg_iter_destroy(stream_iter->msg_iter);
 298         }
 299         g_free(stream_iter->buf);
 300         if (stream_iter->name) {
 301                 g_string_free(stream_iter->name, TRUE);
 302         }
 303
 304         bt_message_put_ref(stream_iter->current_msg);
 305
 306         /* Track the number of active stream iterator. */
 307         stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
 308
 309         /*
 310          * Ensure we poke the trace metadata in the future, which is
 311          * required to release the metadata reference on the trace.
 312          */
 313         stream_iter->trace->new_metadata_needed = true;
 314         g_free(stream_iter);
 315 }