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_TAG "PLUGIN-CTF-LTTNG-LIVE-SRC-METADATA"
35 #include <babeltrace/compat/memstream-internal.h>
36 #include <babeltrace/babeltrace.h>
39 #include "../common/metadata/decoder.h"
41 #define TSDL_MAGIC 0x75d11d57
43 struct packet_header
{
47 uint32_t content_size
;
49 uint8_t compression_scheme
;
50 uint8_t encryption_scheme
;
51 uint8_t checksum_scheme
;
54 } __attribute__((__packed__
));
58 bool stream_classes_all_have_default_clock_class(bt_trace_class
*tc
)
61 const bt_clock_class
*cc
= NULL
;
62 const bt_stream_class
*sc
;
65 sc_count
= bt_trace_class_get_stream_class_count(tc
);
66 for (i
= 0; i
< sc_count
; i
++) {
67 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
71 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
74 BT_LOGE("Stream class doesn't have a default clock class: "
75 "sc-id=%" PRIu64
", sc-name=\"%s\"",
76 bt_stream_class_get_id(sc
),
77 bt_stream_class_get_name(sc
));
86 * Iterate over the stream classes and returns the first clock class
87 * encountered. This is useful to create message iterator inactivity message as
88 * we don't need a particular clock class.
91 const bt_clock_class
*borrow_any_clock_class(bt_trace_class
*tc
)
94 const bt_clock_class
*cc
= NULL
;
95 const bt_stream_class
*sc
;
97 sc_count
= bt_trace_class_get_stream_class_count(tc
);
98 for (i
= 0; i
< sc_count
; i
++) {
99 sc
= bt_trace_class_borrow_stream_class_by_index_const(tc
, i
);
102 cc
= bt_stream_class_borrow_default_clock_class_const(sc
);
113 enum lttng_live_iterator_status
lttng_live_metadata_update(
114 struct lttng_live_trace
*trace
)
116 struct lttng_live_session
*session
= trace
->session
;
117 struct lttng_live_metadata
*metadata
= trace
->metadata
;
118 struct lttng_live_component
*lttng_live
=
119 session
->lttng_live_msg_iter
->lttng_live_comp
;
121 size_t size
, len_read
= 0;
122 char *metadata_buf
= NULL
;
124 enum ctf_metadata_decoder_status decoder_status
;
125 enum lttng_live_iterator_status status
=
126 LTTNG_LIVE_ITERATOR_STATUS_OK
;
128 /* No metadata stream yet. */
130 if (session
->new_streams_needed
) {
131 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
133 session
->new_streams_needed
= true;
134 status
= LTTNG_LIVE_ITERATOR_STATUS_CONTINUE
;
139 if (!metadata
->trace
) {
140 trace
->new_metadata_needed
= false;
143 if (!trace
->new_metadata_needed
) {
147 /* Open for writing */
148 fp
= bt_open_memstream(&metadata_buf
, &size
);
150 BT_LOGE("Metadata open_memstream: %s", strerror(errno
));
154 /* Grab all available metadata. */
157 * get_one_metadata_packet returns the number of bytes
158 * received, 0 when we have received everything, a
159 * negative value on error.
161 ret
= lttng_live_get_one_metadata_packet(trace
, fp
);
168 * Consider metadata closed as soon as we get an error reading
169 * it (e.g. cannot be found).
172 if (!metadata
->closed
) {
173 metadata
->closed
= true;
175 * Release our reference on the trace as soon as
176 * we know the metadata stream is not available
177 * anymore. This won't necessarily teardown the
178 * metadata objects immediately, but only when
179 * the data streams are done.
181 metadata
->trace
= NULL
;
183 if (errno
== EINTR
) {
184 if (lttng_live_is_canceled(lttng_live
)) {
185 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
191 if (bt_close_memstream(&metadata_buf
, &size
, fp
)) {
192 BT_LOGE("bt_close_memstream: %s", strerror(errno
));
199 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
202 trace
->new_metadata_needed
= false;
206 fp
= bt_fmemopen(metadata_buf
, len_read
, "rb");
208 BT_LOGE("Cannot memory-open metadata buffer: %s",
214 * The call to ctf_metadata_decoder_decode will append new metadata to
215 * our current trace class.
217 decoder_status
= ctf_metadata_decoder_decode(metadata
->decoder
, fp
);
218 switch (decoder_status
) {
219 case CTF_METADATA_DECODER_STATUS_OK
:
220 if (!trace
->trace_class
) {
222 ctf_metadata_decoder_get_ir_trace_class(
224 trace
->trace
= bt_trace_create(trace
->trace_class
);
225 if (!stream_classes_all_have_default_clock_class(
226 trace
->trace_class
)) {
227 /* Error logged in function. */
231 borrow_any_clock_class(trace
->trace_class
);
233 trace
->new_metadata_needed
= false;
236 case CTF_METADATA_DECODER_STATUS_INCOMPLETE
:
237 status
= LTTNG_LIVE_ITERATOR_STATUS_AGAIN
;
239 case CTF_METADATA_DECODER_STATUS_ERROR
:
240 case CTF_METADATA_DECODER_STATUS_INVAL_VERSION
:
241 case CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
:
247 status
= LTTNG_LIVE_ITERATOR_STATUS_ERROR
;
252 closeret
= fclose(fp
);
254 BT_LOGE("Error on fclose");
262 int lttng_live_metadata_create_stream(struct lttng_live_session
*session
,
263 uint64_t ctf_trace_id
,
265 const char *trace_name
)
267 struct lttng_live_component
*lttng_live
=
268 session
->lttng_live_msg_iter
->lttng_live_comp
;
269 struct lttng_live_metadata
*metadata
= NULL
;
270 struct lttng_live_trace
*trace
;
273 metadata
= g_new0(struct lttng_live_metadata
, 1);
277 metadata
->stream_id
= stream_id
;
279 match
= strstr(trace_name
, session
->session_name
->str
);
284 metadata
->decoder
= ctf_metadata_decoder_create(
285 lttng_live
->self_comp
, NULL
);
286 if (!metadata
->decoder
) {
289 trace
= lttng_live_borrow_trace(session
, ctf_trace_id
);
293 metadata
->trace
= trace
;
294 trace
->metadata
= metadata
;
298 ctf_metadata_decoder_destroy(metadata
->decoder
);
304 void lttng_live_metadata_fini(struct lttng_live_trace
*trace
)
306 struct lttng_live_metadata
*metadata
= trace
->metadata
;
311 ctf_metadata_decoder_destroy(metadata
->decoder
);
312 trace
->metadata
= NULL
;