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_LOG_OUTPUT_LEVEL log_level
  27 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/DS"
  28 #include "logging/log.h"
  29
  30 #include <stdio.h>
  31 #include <stdint.h>
  32 #include <stdlib.h>
  33 #include <stdbool.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         len_left = stream->base_offset + stream->len - stream->offset;
  61         if (!len_left) {
  62                 stream->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
  63                 status = BT_MSG_ITER_MEDIUM_STATUS_AGAIN;
  64                 return status;
  65         }
  66         read_len = MIN(request_sz, stream->buflen);
  67         read_len = MIN(read_len, len_left);
  68         status = lttng_live_get_stream_bytes(live_msg_iter,
  69                         stream, stream->buf, stream->offset,
  70                         read_len, &recv_len);
  71         *buffer_addr = stream->buf;
  72         *buffer_sz = recv_len;
  73         stream->offset += recv_len;
  74         return status;
  75 }
  76
  77 static
  78 bt_stream *medop_borrow_stream(bt_stream_class *stream_class,
  79                 int64_t stream_id, void *data)
  80 {
  81         struct lttng_live_stream_iterator *lttng_live_stream = data;
  82         bt_logging_level log_level = lttng_live_stream->log_level;
  83
  84         if (!lttng_live_stream->stream) {
  85                 uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
  86
  87                 BT_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
  88                         "class %" PRId64, lttng_live_stream->name->str,
  89                         stream_id, stream_class_id);
  90
  91                 if (stream_id < 0) {
  92                         /*
  93                          * No stream instance ID in the stream. It's possible
  94                          * to encounter this situation with older version of
  95                          * LTTng. In these cases, use the viewer_stream_id that
  96                          * is unique for a live viewer session.
  97                          */
  98                         lttng_live_stream->stream = bt_stream_create_with_id(
  99                                 stream_class, lttng_live_stream->trace->trace,
 100                                 lttng_live_stream->viewer_stream_id);
 101                 } else {
 102                         lttng_live_stream->stream = bt_stream_create_with_id(
 103                                 stream_class, lttng_live_stream->trace->trace,
 104                                 (uint64_t) stream_id);
 105                 }
 106
 107                 if (!lttng_live_stream->stream) {
 108                         BT_LOGE("Cannot create stream %s (stream class ID "
 109                                 "%" PRId64 ", stream ID %" PRIu64 ")",
 110                                 lttng_live_stream->name->str,
 111                                 stream_class_id, stream_id);
 112                 }
 113                 bt_stream_set_name(lttng_live_stream->stream,
 114                         lttng_live_stream->name->str);
 115         }
 116
 117         return lttng_live_stream->stream;
 118 }
 119
 120 static struct bt_msg_iter_medium_ops medops = {
 121         .request_bytes = medop_request_bytes,
 122         .seek = NULL,
 123         .borrow_stream = medop_borrow_stream,
 124 };
 125
 126 BT_HIDDEN
 127 enum lttng_live_iterator_status lttng_live_lazy_msg_init(
 128                 struct lttng_live_session *session)
 129 {
 130         struct lttng_live_component *lttng_live =
 131                 session->lttng_live_msg_iter->lttng_live_comp;
 132         uint64_t trace_idx, stream_iter_idx;
 133         bt_logging_level log_level = session->log_level;
 134
 135         if (!session->lazy_stream_msg_init) {
 136                 return LTTNG_LIVE_ITERATOR_STATUS_OK;
 137         }
 138
 139         for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
 140                 struct lttng_live_trace *trace =
 141                         g_ptr_array_index(session->traces, trace_idx);
 142
 143                 for (stream_iter_idx = 0;
 144                                 stream_iter_idx < trace->stream_iterators->len;
 145                                 stream_iter_idx++) {
 146                         struct ctf_trace_class *ctf_tc;
 147                         struct lttng_live_stream_iterator *stream_iter =
 148                                 g_ptr_array_index(trace->stream_iterators,
 149                                                 stream_iter_idx);
 150
 151                         if (stream_iter->msg_iter) {
 152                                 continue;
 153                         }
 154                         ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
 155                                                 trace->metadata->decoder);
 156                         stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
 157                                         lttng_live->max_query_size, medops,
 158                                         stream_iter, log_level, NULL);
 159                         if (!stream_iter->msg_iter) {
 160                                 goto error;
 161                         }
 162                 }
 163         }
 164
 165         session->lazy_stream_msg_init = false;
 166
 167         return LTTNG_LIVE_ITERATOR_STATUS_OK;
 168
 169 error:
 170         return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
 171 }
 172
 173 BT_HIDDEN
 174 struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
 175                 struct lttng_live_session *session,
 176                 uint64_t ctf_trace_id,
 177                 uint64_t stream_id)
 178 {
 179         struct lttng_live_stream_iterator *stream_iter;
 180         struct lttng_live_component *lttng_live;
 181         struct lttng_live_trace *trace;
 182         bt_logging_level log_level;
 183
 184         BT_ASSERT(session);
 185         BT_ASSERT(session->lttng_live_msg_iter);
 186         BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
 187         log_level = session->log_level;
 188
 189         lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
 190
 191         stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
 192         if (!stream_iter) {
 193                 goto error;
 194         }
 195
 196         stream_iter->log_level = log_level;
 197         trace = lttng_live_borrow_trace(session, ctf_trace_id);
 198         if (!trace) {
 199                 goto error;
 200         }
 201
 202         stream_iter->trace = trace;
 203         stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
 204         stream_iter->viewer_stream_id = stream_id;
 205         stream_iter->ctf_stream_class_id = -1ULL;
 206         stream_iter->last_inactivity_ts = INT64_MIN;
 207
 208         if (trace->trace) {
 209                 struct ctf_trace_class *ctf_tc =
 210                         ctf_metadata_decoder_borrow_ctf_trace_class(
 211                                         trace->metadata->decoder);
 212                 BT_ASSERT(!stream_iter->msg_iter);
 213                 stream_iter->msg_iter = bt_msg_iter_create(ctf_tc,
 214                                 lttng_live->max_query_size, medops,
 215                                 stream_iter, log_level, NULL);
 216                 if (!stream_iter->msg_iter) {
 217                         goto error;
 218                 }
 219         }
 220         stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
 221         if (!stream_iter->buf) {
 222                 goto error;
 223         }
 224
 225         stream_iter->buflen = lttng_live->max_query_size;
 226         stream_iter->name = g_string_new(NULL);
 227         if (!stream_iter->name) {
 228                 goto error;
 229         }
 230
 231         g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
 232                         stream_iter->viewer_stream_id);
 233         g_ptr_array_add(trace->stream_iterators, stream_iter);
 234
 235         /* Track the number of active stream iterator. */
 236         session->lttng_live_msg_iter->active_stream_iter++;
 237
 238         goto end;
 239 error:
 240         lttng_live_stream_iterator_destroy(stream_iter);
 241         stream_iter = NULL;
 242 end:
 243         return stream_iter;
 244 }
 245
 246 BT_HIDDEN
 247 void lttng_live_stream_iterator_destroy(
 248                 struct lttng_live_stream_iterator *stream_iter)
 249 {
 250         if (!stream_iter) {
 251                 return;
 252         }
 253
 254         if (stream_iter->stream) {
 255                 BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
 256         }
 257
 258         if (stream_iter->msg_iter) {
 259                 bt_msg_iter_destroy(stream_iter->msg_iter);
 260         }
 261         if (stream_iter->buf) {
 262                 g_free(stream_iter->buf);
 263         }
 264         if (stream_iter->name) {
 265                 g_string_free(stream_iter->name, TRUE);
 266         }
 267
 268         bt_message_put_ref(stream_iter->current_msg);
 269
 270         /* Track the number of active stream iterator. */
 271         stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
 272
 273         /*
 274          * Ensure we poke the trace metadata in the future, which is
 275          * required to release the metadata reference on the trace.
 276          */
 277         stream_iter->trace->new_metadata_needed = true;
 278         g_free(stream_iter);
 279 }