2 * SPDX-License-Identifier: MIT
4 * Copyright 2019 Francis Deslauriers <francis.deslauriers@efficios.com>
5 * Copyright 2016 Philippe Proulx <pproulx@efficios.com>
6 * Copyright 2010-2011 EfficiOS Inc. and Linux Foundation
9 #include "compat/memstream.h"
10 #include "cpp-common/bt2c/libc-up.hpp"
12 #include "../common/src/metadata/tsdl/ctf-meta-configure-ir-trace.hpp"
13 #include "../common/src/metadata/tsdl/decoder.hpp"
14 #include "lttng-live.hpp"
15 #include "metadata.hpp"
17 #define TSDL_MAGIC 0x75d11d57
24 uint32_t content_size
;
26 uint8_t compression_scheme
;
27 uint8_t encryption_scheme
;
28 uint8_t checksum_scheme
;
31 } __attribute__((__packed__
));
33 static bool stream_classes_all_have_default_clock_class(bt_trace_class
*tc
,
34 const bt2c::Logger
& logger
)
37 const bt_clock_class
*cc
= NULL
;
38 const bt_stream_class
*sc
;
41 sc_count
= bt_trace_class_get_stream_class_count(tc
);
42 for (i
= 0; i
< sc_count
; i
++) {
43 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
47 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
50 BT_CPPLOGE_APPEND_CAUSE_SPEC(logger
,
51 "Stream class doesn't have a default clock class: "
52 "sc-id={}, sc-name=\"{}\"",
53 bt_stream_class_get_id(sc
), bt_stream_class_get_name(sc
));
62 * Iterate over the stream classes and returns the first clock class
63 * encountered. This is useful to create message iterator inactivity message as
64 * we don't need a particular clock class.
66 static const bt_clock_class
*borrow_any_clock_class(bt_trace_class
*tc
)
69 const bt_clock_class
*cc
= NULL
;
70 const bt_stream_class
*sc
;
72 sc_count
= bt_trace_class_get_stream_class_count(tc
);
73 for (i
= 0; i
< sc_count
; i
++) {
74 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
77 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
87 enum lttng_live_iterator_status
lttng_live_metadata_update(struct lttng_live_trace
*trace
)
89 struct lttng_live_session
*session
= trace
->session
;
90 struct lttng_live_metadata
*metadata
= trace
->metadata
;
91 std::vector
<char> metadataBuf
;
94 enum ctf_metadata_decoder_status decoder_status
;
95 enum lttng_live_iterator_status status
= LTTNG_LIVE_ITERATOR_STATUS_OK
;
96 enum lttng_live_get_one_metadata_status metadata_status
;
98 BT_CPPLOGD_SPEC(metadata
->logger
, "Updating metadata for trace: session-id={}, trace-id={}",
99 session
->id
, trace
->id
);
101 /* No metadata stream yet. */
103 if (session
->closed
) {
105 * The session is closed AND we never received any
106 * metadata this indicates that we will never receive
109 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
110 } else if (session
->new_streams_needed
) {
111 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
113 session
->new_streams_needed
= true;
114 status
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
119 if (trace
->metadata_stream_state
!= LTTNG_LIVE_METADATA_STREAM_STATE_NEEDED
) {
123 keep_receiving
= true;
124 /* Grab all available metadata. */
125 while (keep_receiving
) {
127 * lttng_live_get_one_metadata_packet() asks the Relay Daemon
128 * for new metadata. If new metadata is received, the function
129 * writes it to the provided file handle and updates the
130 * reply_len output parameter. We call this function in loop
131 * until it returns _END meaning that no new metadata is
133 * We may receive a _CLOSED status if the metadata stream we
134 * are requesting is no longer available on the relay.
135 * If we receive an _ERROR status, it means there was a
136 * networking, allocating, or some other unrecoverable error.
138 metadata_status
= lttng_live_get_one_metadata_packet(trace
, metadataBuf
);
140 switch (metadata_status
) {
141 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
:
143 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
:
144 keep_receiving
= false;
146 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
:
149 "Metadata stream was closed by the Relay, the trace is no longer active: "
150 "trace-id={}, metadata-stream-id={}",
151 trace
->id
, metadata
->stream_id
);
153 * The stream was closed and we received everything
154 * there was to receive for this metadata stream.
155 * We go on with the decoding of what we received. So
156 * that data stream can be decoded.
158 keep_receiving
= false;
159 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_CLOSED
;
161 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
:
162 BT_CPPLOGE_APPEND_CAUSE_SPEC(metadata
->logger
,
163 "Error getting one trace metadata packet: trace-id={}",
171 if (metadataBuf
.empty()) {
173 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
177 /* The relay sent zero bytes of metadata. */
178 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED
;
183 * Open a new reading file handle on the `metadata_buf` and pass it to
184 * the metadata decoder.
186 fp
.reset(bt_fmemopen(metadataBuf
.data(), metadataBuf
.size(), "rb"));
188 if (errno
== EINTR
&& lttng_live_graph_is_canceled(session
->lttng_live_msg_iter
)) {
189 session
->lttng_live_msg_iter
->was_interrupted
= true;
190 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
192 BT_CPPLOGE_ERRNO_APPEND_CAUSE_SPEC(metadata
->logger
,
193 "Cannot memory-open metadata buffer", ".");
194 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
200 * The call to ctf_metadata_decoder_append_content() will append
201 * new metadata to our current trace class.
203 BT_CPPLOGD_SPEC(metadata
->logger
, "Appending new metadata to the ctf_trace class");
204 decoder_status
= ctf_metadata_decoder_append_content(metadata
->decoder
.get(), fp
.get());
205 switch (decoder_status
) {
206 case CTF_METADATA_DECODER_STATUS_OK
:
207 if (!trace
->trace_class
) {
208 struct ctf_trace_class
*tc
=
209 ctf_metadata_decoder_borrow_ctf_trace_class(metadata
->decoder
.get());
211 trace
->trace_class
= ctf_metadata_decoder_get_ir_trace_class(metadata
->decoder
.get());
212 trace
->trace
= trace
->trace_class
->instantiate();
214 BT_CPPLOGE_APPEND_CAUSE_SPEC(metadata
->logger
, "Failed to create bt_trace");
218 ctf_trace_class_configure_ir_trace(tc
, *trace
->trace
);
220 if (!stream_classes_all_have_default_clock_class(trace
->trace_class
->libObjPtr(),
222 /* Error logged in function. */
225 trace
->clock_class
= borrow_any_clock_class(trace
->trace_class
->libObjPtr());
228 /* The metadata was updated successfully. */
229 trace
->metadata_stream_state
= LTTNG_LIVE_METADATA_STREAM_STATE_NOT_NEEDED
;
239 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
244 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
, uint64_t ctf_trace_id
,
247 struct lttng_live_trace
*trace
;
249 ctf_metadata_decoder_config cfg
{session
->logger
};
250 cfg
.self_comp
= session
->self_comp
;
251 cfg
.create_trace_class
= true;
253 lttng_live_metadata
*metadata
= new lttng_live_metadata
{session
->logger
};
254 metadata
->stream_id
= stream_id
;
256 metadata
->decoder
= ctf_metadata_decoder_create(&cfg
);
257 if (!metadata
->decoder
) {
258 BT_CPPLOGE_APPEND_CAUSE_SPEC(session
->logger
, "Failed to create CTF metadata decoder");
261 trace
= lttng_live_session_borrow_or_create_trace_by_id(session
, ctf_trace_id
);
263 BT_CPPLOGE_APPEND_CAUSE_SPEC(session
->logger
, "Failed to borrow trace");
266 trace
->metadata
= metadata
;
274 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
276 struct lttng_live_metadata
*metadata
= trace
->metadata
;
281 trace
->metadata
= NULL
;