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_LOG_OUTPUT_LEVEL log_level
28 #define BT_LOG_TAG "PLUGIN/SRC.CTF.LTTNG-LIVE/META"
29 #include "logging/log.h"
36 #include "compat/memstream.h"
37 #include <babeltrace2/babeltrace.h>
40 #include "../common/metadata/decoder.h"
42 #define TSDL_MAGIC 0x75d11d57
44 struct packet_header
{
48 uint32_t content_size
;
50 uint8_t compression_scheme
;
51 uint8_t encryption_scheme
;
52 uint8_t checksum_scheme
;
55 } __attribute__((__packed__
));
59 bool stream_classes_all_have_default_clock_class(bt_trace_class
*tc
,
60 bt_logging_level log_level
)
63 const bt_clock_class
*cc
= NULL
;
64 const bt_stream_class
*sc
;
67 sc_count
= bt_trace_class_get_stream_class_count(tc
);
68 for (i
= 0; i
< sc_count
; i
++) {
69 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
73 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
76 BT_LOGE("Stream class doesn't have a default clock class: "
77 "sc-id=%" PRIu64
", sc-name=\"%s\"",
78 bt_stream_class_get_id(sc
),
79 bt_stream_class_get_name(sc
));
88 * Iterate over the stream classes and returns the first clock class
89 * encountered. This is useful to create message iterator inactivity message as
90 * we don't need a particular clock class.
93 const bt_clock_class
*borrow_any_clock_class(bt_trace_class
*tc
)
96 const bt_clock_class
*cc
= NULL
;
97 const bt_stream_class
*sc
;
99 sc_count
= bt_trace_class_get_stream_class_count(tc
);
100 for (i
= 0; i
< sc_count
; i
++) {
101 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
104 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
115 enum lttng_live_iterator_status
lttng_live_metadata_update(
116 struct lttng_live_trace
*trace
)
118 struct lttng_live_session
*session
= trace
->session
;
119 struct lttng_live_metadata
*metadata
= trace
->metadata
;
120 struct lttng_live_component
*lttng_live
=
121 session
->lttng_live_msg_iter
->lttng_live_comp
;
123 size_t size
, len_read
= 0;
124 char *metadata_buf
= NULL
;
126 enum ctf_metadata_decoder_status decoder_status
;
127 enum lttng_live_iterator_status status
=
128 LTTNG_LIVE_ITERATOR_STATUS_OK
;
129 bt_logging_level log_level
= trace
->log_level
;
131 /* No metadata stream yet. */
133 if (session
->new_streams_needed
) {
134 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
136 session
->new_streams_needed
= true;
137 status
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
142 if (!metadata
->trace
) {
143 trace
->new_metadata_needed
= false;
146 if (!trace
->new_metadata_needed
) {
150 /* Open for writing */
151 fp
= bt_open_memstream(&metadata_buf
, &size
);
153 BT_LOGE("Metadata open_memstream: %s", strerror(errno
));
157 /* Grab all available metadata. */
160 * get_one_metadata_packet returns the number of bytes
161 * received, 0 when we have received everything, a
162 * negative value on error.
164 ret
= lttng_live_get_one_metadata_packet(trace
, fp
);
171 * Consider metadata closed as soon as we get an error reading
172 * it (e.g. cannot be found).
175 if (!metadata
->closed
) {
176 metadata
->closed
= true;
178 * Release our reference on the trace as soon as
179 * we know the metadata stream is not available
180 * anymore. This won't necessarily teardown the
181 * metadata objects immediately, but only when
182 * the data streams are done.
184 metadata
->trace
= NULL
;
186 if (errno
== EINTR
) {
187 if (lttng_live_graph_is_canceled(lttng_live
)) {
188 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
194 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
195 BT_LOGE("bt_close_memstream: %s", strerror(errno
));
202 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
205 trace
->new_metadata_needed
= false;
209 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
211 BT_LOGE("Cannot memory-open metadata buffer: %s",
217 * The call to ctf_metadata_decoder_decode will append new metadata to
218 * our current trace class.
220 decoder_status
= ctf_metadata_decoder_decode(metadata
->decoder
, fp
);
221 switch (decoder_status
) {
222 case CTF_METADATA_DECODER_STATUS_OK
:
223 if (!trace
->trace_class
) {
225 ctf_metadata_decoder_get_ir_trace_class(
227 trace
->trace
= bt_trace_create(trace
->trace_class
);
228 if (!stream_classes_all_have_default_clock_class(
229 trace
->trace_class
, log_level
)) {
230 /* Error logged in function. */
234 borrow_any_clock_class(trace
->trace_class
);
236 trace
->new_metadata_needed
= false;
239 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
240 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
242 case CTF_METADATA_DECODER_STATUS_ERROR
:
243 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION
:
244 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
:
250 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
255 closeret
= fclose(fp
);
257 BT_LOGE("Error on fclose");
265 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
266 uint64_t ctf_trace_id
,
268 const char *trace_name
)
270 struct lttng_live_component
*lttng_live
=
271 session
->lttng_live_msg_iter
->lttng_live_comp
;
272 struct lttng_live_metadata
*metadata
= NULL
;
273 struct lttng_live_trace
*trace
;
275 struct ctf_metadata_decoder_config cfg
= {
276 .log_level
= session
->log_level
,
278 bt_self_component_source_as_self_component(
279 lttng_live
->self_comp
),
280 .clock_class_offset_s
= 0,
281 .clock_class_offset_ns
= 0,
284 metadata
= g_new0(struct lttng_live_metadata
, 1);
288 metadata
->log_level
= session
->log_level
;
289 metadata
->stream_id
= stream_id
;
291 match
= strstr(trace_name
, session
->session_name
->str
);
296 metadata
->decoder
= ctf_metadata_decoder_create(&cfg
);
297 if (!metadata
->decoder
) {
300 trace
= lttng_live_borrow_trace(session
, ctf_trace_id
);
304 metadata
->trace
= trace
;
305 trace
->metadata
= metadata
;
309 ctf_metadata_decoder_destroy(metadata
->decoder
);
315 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
317 struct lttng_live_metadata
*metadata
= trace
->metadata
;
322 ctf_metadata_decoder_destroy(metadata
->decoder
);
323 trace
->metadata
= NULL
;