2 * Copyright 2019 - Francis Deslauriers <francis.deslauriers@efficios.com>
3 * Copyright 2016 - Philippe Proulx <pproulx@efficios.com>
4 * Copyright 2010-2011 - EfficiOS Inc. and Linux Foundation
6 * Some functions are based on older functions written by Mathieu Desnoyers.
8 * Permission is hereby granted, free of charge, to any person obtaining a copy
9 * of this software and associated documentation files (the "Software"), to deal
10 * in the Software without restriction, including without limitation the rights
11 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
12 * copies of the Software, and to permit persons to whom the Software is
13 * furnished to do so, subject to the following conditions:
15 * The above copyright notice and this permission notice shall be included in
16 * all copies or substantial portions of the Software.
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
19 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
20 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
21 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
22 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
23 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
27 #define BT_COMP_LOG_SELF_COMP self_comp
28 #define BT_LOG_OUTPUT_LEVEL log_level
29 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META"
30 #include "logging/comp-logging.h"
37 #include "compat/memstream.h"
38 #include <babeltrace2/babeltrace.h>
41 #include "../common/metadata/decoder.h"
42 #include "../common/metadata/ctf-meta-configure-ir-trace.h"
44 #define TSDL_MAGIC 0x75d11d57
46 struct packet_header
{
50 uint32_t content_size
;
52 uint8_t compression_scheme
;
53 uint8_t encryption_scheme
;
54 uint8_t checksum_scheme
;
57 } __attribute__((__packed__
));
61 bool stream_classes_all_have_default_clock_class(bt_trace_class
*tc
,
62 bt_logging_level log_level
,
63 bt_self_component
*self_comp
)
66 const bt_clock_class
*cc
= NULL
;
67 const bt_stream_class
*sc
;
70 sc_count
= bt_trace_class_get_stream_class_count(tc
);
71 for (i
= 0; i
< sc_count
; i
++) {
72 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
76 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
79 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
80 "Stream class doesn't have a default clock class: "
81 "sc-id=%" PRIu64
", sc-name=\"%s\"",
82 bt_stream_class_get_id(sc
),
83 bt_stream_class_get_name(sc
));
92 * Iterate over the stream classes and returns the first clock class
93 * encountered. This is useful to create message iterator inactivity message as
94 * we don't need a particular clock class.
97 const bt_clock_class
*borrow_any_clock_class(bt_trace_class
*tc
)
100 const bt_clock_class
*cc
= NULL
;
101 const bt_stream_class
*sc
;
103 sc_count
= bt_trace_class_get_stream_class_count(tc
);
104 for (i
= 0; i
< sc_count
; i
++) {
105 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
108 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
119 enum lttng_live_iterator_status
lttng_live_metadata_update(
120 struct lttng_live_trace
*trace
)
122 struct lttng_live_session
*session
= trace
->session
;
123 struct lttng_live_metadata
*metadata
= trace
->metadata
;
124 size_t size
, len_read
= 0;
125 char *metadata_buf
= NULL
;
128 enum ctf_metadata_decoder_status decoder_status
;
129 enum lttng_live_iterator_status status
=
130 LTTNG_LIVE_ITERATOR_STATUS_OK
;
131 bt_logging_level log_level
= trace
->log_level
;
132 bt_self_component
*self_comp
= trace
->self_comp
;
133 enum lttng_live_get_one_metadata_status metadata_status
;
135 /* No metadata stream yet. */
137 if (session
->new_streams_needed
) {
138 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
140 session
->new_streams_needed
= true;
141 status
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
146 if (!metadata
->trace
) {
147 trace
->new_metadata_needed
= false;
150 if (!trace
->new_metadata_needed
) {
154 /* Open for writing */
155 fp
= bt_open_memstream(&metadata_buf
, &size
);
157 if (errno
== EINTR
&&
158 lttng_live_graph_is_canceled(session
->lttng_live_msg_iter
)) {
159 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
161 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp
,
162 "Metadata open_memstream", ".");
163 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
168 keep_receiving
= true;
169 /* Grab all available metadata. */
170 while (keep_receiving
) {
171 size_t reply_len
= 0;
173 * lttng_live_get_one_metadata_packet() asks the Relay Daemon
174 * for new metadata. If new metadata is received, the function
175 * writes it to the provided file handle and updates the
176 * reply_len output parameter. We call this function in loop
177 * until it returns _END meaning that no new metadata is
179 * We may receive a _CLOSED status if the metadata stream we
180 * are requesting is no longer available on the relay.
181 * If we receive an _ERROR status, it means there was a
182 * networking, allocating, or some other unrecoverable error.
184 metadata_status
= lttng_live_get_one_metadata_packet(trace
, fp
,
187 switch (metadata_status
) {
188 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_OK
:
189 len_read
+= reply_len
;
191 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_END
:
192 keep_receiving
= false;
194 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
:
195 keep_receiving
= false;
197 case LTTNG_LIVE_GET_ONE_METADATA_STATUS_ERROR
:
205 * A closed metadata stream means the trace is no longer active. Return
206 * _END so that the caller can remove the trace from its list.
208 if (metadata_status
== LTTNG_LIVE_GET_ONE_METADATA_STATUS_CLOSED
) {
209 status
= LTTNG_LIVE_ITERATOR_STATUS_END
;
213 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
214 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp
,
215 "Metadata bt_close_memstream", ".");
222 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
225 trace
->new_metadata_needed
= false;
229 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
231 if (errno
== EINTR
&&
232 lttng_live_graph_is_canceled(session
->lttng_live_msg_iter
)) {
233 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
235 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp
,
236 "Cannot memory-open metadata buffer", ".");
237 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
243 * The call to ctf_metadata_decoder_append_content() will append
244 * new metadata to our current trace class.
246 decoder_status
= ctf_metadata_decoder_append_content(
247 metadata
->decoder
, fp
);
248 switch (decoder_status
) {
249 case CTF_METADATA_DECODER_STATUS_OK
:
250 if (!trace
->trace_class
) {
251 struct ctf_trace_class
*tc
=
252 ctf_metadata_decoder_borrow_ctf_trace_class(
256 ctf_metadata_decoder_get_ir_trace_class(
258 trace
->trace
= bt_trace_create(trace
->trace_class
);
260 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
261 "Failed to create bt_trace");
264 if (ctf_trace_class_configure_ir_trace(tc
,
266 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
267 "Failed to configure ctf trace class");
270 if (!stream_classes_all_have_default_clock_class(
271 trace
->trace_class
, log_level
,
273 /* Error logged in function. */
277 borrow_any_clock_class(trace
->trace_class
);
279 trace
->new_metadata_needed
= false;
282 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
283 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
292 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
297 closeret
= fclose(fp
);
299 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(self_comp
,
300 "Error on fclose", ".");
308 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
309 uint64_t ctf_trace_id
, uint64_t stream_id
,
310 const char *trace_name
)
312 bt_self_component
*self_comp
= session
->self_comp
;
313 bt_logging_level log_level
= session
->log_level
;
314 struct lttng_live_metadata
*metadata
= NULL
;
315 struct lttng_live_trace
*trace
;
316 struct ctf_metadata_decoder_config cfg
= {
317 .log_level
= session
->log_level
,
318 .self_comp
= session
->self_comp
,
319 .clock_class_offset_s
= 0,
320 .clock_class_offset_ns
= 0,
321 .create_trace_class
= true,
324 metadata
= g_new0(struct lttng_live_metadata
, 1);
328 metadata
->log_level
= session
->log_level
;
329 metadata
->self_comp
= session
->self_comp
;
330 metadata
->stream_id
= stream_id
;
332 metadata
->decoder
= ctf_metadata_decoder_create(&cfg
);
333 if (!metadata
->decoder
) {
334 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
335 "Failed to create CTF metadata decoder");
338 trace
= lttng_live_borrow_trace(session
, ctf_trace_id
);
340 BT_COMP_LOGE_APPEND_CAUSE(self_comp
,
341 "Failed to borrow trace");
344 metadata
->trace
= trace
;
345 trace
->metadata
= metadata
;
349 ctf_metadata_decoder_destroy(metadata
->decoder
);
355 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
357 struct lttng_live_metadata
*metadata
= trace
->metadata
;
362 ctf_metadata_decoder_destroy(metadata
->decoder
);
363 trace
->metadata
= NULL
;