src.ctf.lttng-live: use optional pattern for `ctf_stream_class_id`
[babeltrace.git] / src / plugins / ctf / lttng-live / data-stream.c
CommitLineData
7cdc2bab 1/*
0235b0db 2 * SPDX-License-Identifier: MIT
7cdc2bab 3 *
0235b0db
MJ
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2016 Jérémie Galarneau <jeremie.galarneau@efficios.com>
7 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
7cdc2bab
MD
8 */
9
2ece7dd0 10#define BT_COMP_LOG_SELF_COMP self_comp
c01594de 11#define BT_LOG_OUTPUT_LEVEL log_level
350ad6c1 12#define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/DS"
d9c39b0a 13#include "logging/comp-logging.h"
020bc26f 14
3c22a242 15#include <inttypes.h>
7cdc2bab 16#include <stdio.h>
7cdc2bab 17#include <stdlib.h>
3c22a242 18
7cdc2bab 19#include <glib.h>
3c22a242 20
3fadfbc0 21#include <babeltrace2/babeltrace.h>
3c22a242 22
d6e69534 23#include "../common/msg-iter/msg-iter.h"
578e048b 24#include "common/assert.h"
3c22a242 25#include "compat/mman.h"
087bc060 26#include "data-stream.h"
7cdc2bab 27
14f28187
FD
28#define STREAM_NAME_PREFIX "stream-"
29
7cdc2bab 30static
18a1979b 31enum ctf_msg_iter_medium_status medop_request_bytes(
7cdc2bab
MD
32 size_t request_sz, uint8_t **buffer_addr,
33 size_t *buffer_sz, void *data)
34{
18a1979b
SM
35 enum ctf_msg_iter_medium_status status =
36 CTF_MSG_ITER_MEDIUM_STATUS_OK;
7cdc2bab
MD
37 struct lttng_live_stream_iterator *stream = data;
38 struct lttng_live_trace *trace = stream->trace;
39 struct lttng_live_session *session = trace->session;
14f28187 40 struct lttng_live_msg_iter *live_msg_iter = session->lttng_live_msg_iter;
7cdc2bab
MD
41 uint64_t recv_len = 0;
42 uint64_t len_left;
43 uint64_t read_len;
7cdc2bab 44
c9694de4
SM
45 BT_ASSERT(request_sz);
46
4a39caef 47 if (stream->has_stream_hung_up) {
18a1979b 48 status = CTF_MSG_ITER_MEDIUM_STATUS_EOF;
4a39caef
FD
49 goto end;
50 }
51
7cdc2bab
MD
52 len_left = stream->base_offset + stream->len - stream->offset;
53 if (!len_left) {
34533ae0
FD
54 lttng_live_stream_iterator_set_state(stream,
55 LTTNG_LIVE_STREAM_ACTIVE_NO_DATA);
18a1979b 56 status = CTF_MSG_ITER_MEDIUM_STATUS_AGAIN;
4a39caef 57 goto end;
7cdc2bab 58 }
4a39caef 59
7cdc2bab
MD
60 read_len = MIN(request_sz, stream->buflen);
61 read_len = MIN(read_len, len_left);
14f28187 62 status = lttng_live_get_stream_bytes(live_msg_iter,
7cdc2bab
MD
63 stream, stream->buf, stream->offset,
64 read_len, &recv_len);
7cdc2bab
MD
65 *buffer_addr = stream->buf;
66 *buffer_sz = recv_len;
67 stream->offset += recv_len;
4a39caef 68end:
7cdc2bab
MD
69 return status;
70}
71
72static
14f28187
FD
73bt_stream *medop_borrow_stream(bt_stream_class *stream_class,
74 int64_t stream_id, void *data)
7cdc2bab
MD
75{
76 struct lttng_live_stream_iterator *lttng_live_stream = data;
c01594de 77 bt_logging_level log_level = lttng_live_stream->log_level;
2ece7dd0 78 bt_self_component *self_comp = lttng_live_stream->self_comp;
7cdc2bab
MD
79
80 if (!lttng_live_stream->stream) {
14f28187 81 uint64_t stream_class_id = bt_stream_class_get_id(stream_class);
b92735af 82
2ece7dd0 83 BT_COMP_LOGI("Creating stream %s (ID: %" PRIu64 ") out of stream "
14f28187
FD
84 "class %" PRId64, lttng_live_stream->name->str,
85 stream_id, stream_class_id);
b92735af 86
14f28187
FD
87 if (stream_id < 0) {
88 /*
89 * No stream instance ID in the stream. It's possible
90 * to encounter this situation with older version of
91 * LTTng. In these cases, use the viewer_stream_id that
92 * is unique for a live viewer session.
93 */
94 lttng_live_stream->stream = bt_stream_create_with_id(
95 stream_class, lttng_live_stream->trace->trace,
96 lttng_live_stream->viewer_stream_id);
b92735af 97 } else {
14f28187
FD
98 lttng_live_stream->stream = bt_stream_create_with_id(
99 stream_class, lttng_live_stream->trace->trace,
100 (uint64_t) stream_id);
b92735af 101 }
7cdc2bab 102
7cdc2bab 103 if (!lttng_live_stream->stream) {
1419db2b
FD
104 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
105 "Cannot create stream %s (stream class ID "
14f28187
FD
106 "%" PRId64 ", stream ID %" PRIu64 ")",
107 lttng_live_stream->name->str,
108 stream_class_id, stream_id);
b80991f6 109 goto end;
7cdc2bab 110 }
b80991f6 111
14f28187
FD
112 bt_stream_set_name(lttng_live_stream->stream,
113 lttng_live_stream->name->str);
7cdc2bab
MD
114 }
115
b80991f6 116end:
7cdc2bab
MD
117 return lttng_live_stream->stream;
118}
119
18a1979b 120static struct ctf_msg_iter_medium_ops medops = {
7cdc2bab 121 .request_bytes = medop_request_bytes,
14f28187
FD
122 .seek = NULL,
123 .borrow_stream = medop_borrow_stream,
7cdc2bab
MD
124};
125
126BT_HIDDEN
14f28187 127enum lttng_live_iterator_status lttng_live_lazy_msg_init(
851de941
SM
128 struct lttng_live_session *session,
129 bt_self_message_iterator *self_msg_iter)
7cdc2bab 130{
14f28187
FD
131 struct lttng_live_component *lttng_live =
132 session->lttng_live_msg_iter->lttng_live_comp;
133 uint64_t trace_idx, stream_iter_idx;
c01594de 134 bt_logging_level log_level = session->log_level;
2ece7dd0 135 bt_self_component *self_comp = session->self_comp;
7cdc2bab 136
d6e69534 137 if (!session->lazy_stream_msg_init) {
14f28187 138 return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab
MD
139 }
140
ecb4ba8a
FD
141 BT_COMP_LOGD("Lazily initializing self message iterator for live session: "
142 "session-id=%"PRIu64", self-msg-iter-addr=%p", session->id,
143 self_msg_iter);
144
14f28187
FD
145 for (trace_idx = 0; trace_idx < session->traces->len; trace_idx++) {
146 struct lttng_live_trace *trace =
147 g_ptr_array_index(session->traces, trace_idx);
148
149 for (stream_iter_idx = 0;
150 stream_iter_idx < trace->stream_iterators->len;
151 stream_iter_idx++) {
152 struct ctf_trace_class *ctf_tc;
153 struct lttng_live_stream_iterator *stream_iter =
154 g_ptr_array_index(trace->stream_iterators,
0f1979c3 155 stream_iter_idx);
7cdc2bab 156
14f28187 157 if (stream_iter->msg_iter) {
7cdc2bab
MD
158 continue;
159 }
14f28187 160 ctf_tc = ctf_metadata_decoder_borrow_ctf_trace_class(
0f1979c3 161 trace->metadata->decoder);
ecb4ba8a
FD
162 BT_COMP_LOGD("Creating CTF message iterator: "
163 "session-id=%"PRIu64", ctf-tc-addr=%p, "
164 "stream-iter-name=%s, self-msg-iter-addr=%p",
165 session->id, ctf_tc, stream_iter->name->str, self_msg_iter);
18a1979b 166 stream_iter->msg_iter = ctf_msg_iter_create(ctf_tc,
0f1979c3 167 lttng_live->max_query_size, medops, stream_iter,
851de941 168 log_level, self_comp, self_msg_iter);
14f28187 169 if (!stream_iter->msg_iter) {
1419db2b
FD
170 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
171 "Failed to create CTF message iterator");
7cdc2bab
MD
172 goto error;
173 }
174 }
175 }
176
d6e69534 177 session->lazy_stream_msg_init = false;
7cdc2bab 178
14f28187 179 return LTTNG_LIVE_ITERATOR_STATUS_OK;
7cdc2bab
MD
180
181error:
14f28187 182 return LTTNG_LIVE_ITERATOR_STATUS_ERROR;
7cdc2bab
MD
183}
184
185BT_HIDDEN
186struct lttng_live_stream_iterator *lttng_live_stream_iterator_create(
187 struct lttng_live_session *session,
188 uint64_t ctf_trace_id,
851de941
SM
189 uint64_t stream_id,
190 bt_self_message_iterator *self_msg_iter)
7cdc2bab 191{
14f28187
FD
192 struct lttng_live_stream_iterator *stream_iter;
193 struct lttng_live_component *lttng_live;
7cdc2bab 194 struct lttng_live_trace *trace;
c01594de 195 bt_logging_level log_level;
2ece7dd0 196 bt_self_component *self_comp;
7cdc2bab 197
14f28187
FD
198 BT_ASSERT(session);
199 BT_ASSERT(session->lttng_live_msg_iter);
200 BT_ASSERT(session->lttng_live_msg_iter->lttng_live_comp);
c01594de 201 log_level = session->log_level;
2ece7dd0 202 self_comp = session->self_comp;
14f28187
FD
203
204 lttng_live = session->lttng_live_msg_iter->lttng_live_comp;
205
206 stream_iter = g_new0(struct lttng_live_stream_iterator, 1);
207 if (!stream_iter) {
1419db2b
FD
208 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
209 "Failed to allocate struct lttng_live_stream_iterator");
14f28187
FD
210 goto error;
211 }
212
c01594de 213 stream_iter->log_level = log_level;
2ece7dd0 214 stream_iter->self_comp = self_comp;
36e94ad6 215 trace = lttng_live_session_borrow_or_create_trace_by_id(session, ctf_trace_id);
7cdc2bab 216 if (!trace) {
1419db2b
FD
217 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
218 "Failed to borrow CTF trace.");
7cdc2bab
MD
219 goto error;
220 }
221
14f28187
FD
222 stream_iter->trace = trace;
223 stream_iter->state = LTTNG_LIVE_STREAM_ACTIVE_NO_DATA;
224 stream_iter->viewer_stream_id = stream_id;
1a258819
FD
225
226 stream_iter->ctf_stream_class_id.is_set = false;
227 stream_iter->ctf_stream_class_id.value = UINT64_MAX;
228
a043c362
FD
229 stream_iter->last_inactivity_ts.is_set = false;
230 stream_iter->last_inactivity_ts.value = 0;
7cdc2bab
MD
231
232 if (trace->trace) {
14f28187
FD
233 struct ctf_trace_class *ctf_tc =
234 ctf_metadata_decoder_borrow_ctf_trace_class(
0f1979c3 235 trace->metadata->decoder);
14f28187 236 BT_ASSERT(!stream_iter->msg_iter);
18a1979b 237 stream_iter->msg_iter = ctf_msg_iter_create(ctf_tc,
0f1979c3 238 lttng_live->max_query_size, medops, stream_iter,
851de941 239 log_level, self_comp, self_msg_iter);
14f28187 240 if (!stream_iter->msg_iter) {
1419db2b
FD
241 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
242 "Failed to create CTF message iterator");
7cdc2bab
MD
243 goto error;
244 }
245 }
14f28187
FD
246 stream_iter->buf = g_new0(uint8_t, lttng_live->max_query_size);
247 if (!stream_iter->buf) {
1419db2b
FD
248 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
249 "Failed to allocate live stream iterator buffer");
14f28187
FD
250 goto error;
251 }
7cdc2bab 252
14f28187
FD
253 stream_iter->buflen = lttng_live->max_query_size;
254 stream_iter->name = g_string_new(NULL);
255 if (!stream_iter->name) {
1419db2b
FD
256 BT_COMP_LOGE_APPEND_CAUSE(self_comp,
257 "Failed to allocate live stream iterator name buffer");
14f28187
FD
258 goto error;
259 }
260
261 g_string_printf(stream_iter->name, STREAM_NAME_PREFIX "%" PRIu64,
0f1979c3 262 stream_iter->viewer_stream_id);
14f28187 263 g_ptr_array_add(trace->stream_iterators, stream_iter);
7cdc2bab 264
14f28187
FD
265 /* Track the number of active stream iterator. */
266 session->lttng_live_msg_iter->active_stream_iter++;
7cdc2bab
MD
267
268 goto end;
269error:
14f28187
FD
270 lttng_live_stream_iterator_destroy(stream_iter);
271 stream_iter = NULL;
7cdc2bab 272end:
14f28187 273 return stream_iter;
7cdc2bab
MD
274}
275
276BT_HIDDEN
14f28187
FD
277void lttng_live_stream_iterator_destroy(
278 struct lttng_live_stream_iterator *stream_iter)
7cdc2bab 279{
14f28187 280 if (!stream_iter) {
7cdc2bab
MD
281 return;
282 }
283
14f28187
FD
284 if (stream_iter->stream) {
285 BT_STREAM_PUT_REF_AND_RESET(stream_iter->stream);
7cdc2bab
MD
286 }
287
14f28187 288 if (stream_iter->msg_iter) {
18a1979b 289 ctf_msg_iter_destroy(stream_iter->msg_iter);
7cdc2bab 290 }
19bbdc9b 291 g_free(stream_iter->buf);
14f28187
FD
292 if (stream_iter->name) {
293 g_string_free(stream_iter->name, TRUE);
294 }
295
296 bt_message_put_ref(stream_iter->current_msg);
297
298 /* Track the number of active stream iterator. */
299 stream_iter->trace->session->lttng_live_msg_iter->active_stream_iter--;
300
14f28187 301 g_free(stream_iter);
7cdc2bab 302}
This page took 0.084981 seconds and 4 git commands to generate.