2 * SPDX-License-Identifier: MIT
4 * Copyright 2016-2017 Philippe Proulx <pproulx@efficios.com>
7 #define BT_COMP_LOG_SELF_COMP (mdec->config.self_comp)
8 #define BT_COMP_LOG_SELF_COMP_CLASS (mdec->config.self_comp_class)
9 #define BT_LOG_OUTPUT_LEVEL (mdec->config.log_level)
10 #define BT_LOG_TAG "PLUGIN/CTF/META/DECODER"
11 #include "logging/comp-logging.h"
18 #include "common/assert.h"
19 #include "common/uuid.h"
20 #include "compat/memstream.h"
21 #include <babeltrace2/babeltrace.h>
29 #include "parser-wrap.h"
30 #include "decoder-packetized-file-stream-to-buf.h"
32 #define TSDL_MAGIC 0x75d11d57
34 struct ctf_metadata_decoder
{
35 struct ctf_scanner
*scanner
;
37 struct ctf_visitor_generate_ir
*visitor
;
41 struct ctf_metadata_decoder_config config
;
42 struct meta_log_config log_cfg
;
45 struct packet_header
{
49 uint32_t content_size
;
51 uint8_t compression_scheme
;
52 uint8_t encryption_scheme
;
53 uint8_t checksum_scheme
;
56 } __attribute__((__packed__
));
59 int ctf_metadata_decoder_is_packetized(FILE *fp
, bool *is_packetized
,
60 int *byte_order
, bt_logging_level log_level
,
61 bt_self_component
*self_comp
)
67 *is_packetized
= false;
68 len
= fread(&magic
, sizeof(magic
), 1, fp
);
70 BT_COMP_LOG_CUR_LVL(BT_LOG_INFO
, log_level
, self_comp
,
71 "Cannot read first metadata packet header: assuming the stream is not packetized.");
77 if (magic
== TSDL_MAGIC
) {
78 *is_packetized
= true;
79 *byte_order
= BYTE_ORDER
;
80 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
81 *is_packetized
= true;
82 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
?
83 LITTLE_ENDIAN
: BIG_ENDIAN
;
94 struct ctf_metadata_decoder
*ctf_metadata_decoder_create(
95 const struct ctf_metadata_decoder_config
*config
)
97 struct ctf_metadata_decoder
*mdec
=
98 g_new0(struct ctf_metadata_decoder
, 1);
101 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, config
->log_level
, config
->self_comp
,
102 "Creating CTF metadata decoder: "
103 "clock-class-offset-s=%" PRId64
", "
104 "clock-class-offset-ns=%" PRId64
,
105 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
108 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, config
->log_level
,
110 "Failed to allocate one CTF metadata decoder.");
114 mdec
->log_cfg
.log_level
= config
->log_level
;
115 mdec
->log_cfg
.self_comp
= config
->self_comp
;
116 mdec
->log_cfg
.self_comp_class
= config
->self_comp_class
;
117 mdec
->scanner
= ctf_scanner_alloc();
118 if (!mdec
->scanner
) {
119 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot allocate a metadata lexical scanner: "
120 "mdec-addr=%p", mdec
);
124 mdec
->text
= g_string_new(NULL
);
126 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to allocate one GString: "
127 "mdec-addr=%p", mdec
);
132 mdec
->config
= *config
;
133 mdec
->visitor
= ctf_visitor_generate_ir_create(config
);
134 if (!mdec
->visitor
) {
135 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to create a CTF IR metadata AST visitor: "
136 "mdec-addr=%p", mdec
);
140 BT_COMP_LOGD("Creating CTF metadata decoder: "
141 "clock-class-offset-s=%" PRId64
", "
142 "clock-class-offset-ns=%" PRId64
", addr=%p",
143 config
->clock_class_offset_s
, config
->clock_class_offset_ns
,
148 ctf_metadata_decoder_destroy(mdec
);
156 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
163 ctf_scanner_free(mdec
->scanner
);
167 g_string_free(mdec
->text
, TRUE
);
170 BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
171 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
176 enum ctf_metadata_decoder_status
ctf_metadata_decoder_append_content(
177 struct ctf_metadata_decoder
*mdec
, FILE *fp
)
179 enum ctf_metadata_decoder_status status
=
180 CTF_METADATA_DECODER_STATUS_OK
;
183 bool close_fp
= false;
188 ret
= ctf_metadata_decoder_is_packetized(fp
, &is_packetized
, &mdec
->bo
,
189 mdec
->config
.log_level
, mdec
->config
.self_comp
);
191 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
196 BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec
);
197 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(fp
,
198 &buf
, mdec
->bo
, &mdec
->is_uuid_set
,
199 mdec
->uuid
, mdec
->config
.log_level
,
200 mdec
->config
.self_comp
,
201 mdec
->config
.self_comp_class
);
203 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot decode packetized metadata packets to metadata text: "
204 "mdec-addr=%p, ret=%d", mdec
, ret
);
205 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
209 if (strlen(buf
) == 0) {
210 /* An empty metadata packet is OK. */
214 /* Convert the real file pointer to a memory file pointer */
215 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
218 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot memory-open metadata buffer: %s: "
219 "mdec-addr=%p", strerror(errno
), mdec
);
220 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
224 unsigned int major
, minor
;
226 const long init_pos
= ftell(fp
);
228 BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec
);
231 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
232 "Failed to get current file position", ".");
233 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
237 /* Check text-only metadata header and version */
238 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
240 BT_COMP_LOGW("Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
241 "mdec-addr=%p", mdec
);
244 BT_COMP_LOGI("Found metadata stream version in signature: version=%u.%u", major
, minor
);
246 if (!ctf_metadata_decoder_is_packet_version_valid(major
,
248 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid metadata version found in plain text signature: "
249 "version=%u.%u, mdec-addr=%p", major
, minor
,
251 status
= CTF_METADATA_DECODER_STATUS_INVAL_VERSION
;
255 if (fseek(fp
, init_pos
, SEEK_SET
)) {
256 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot seek metadata file stream to initial position: %s: "
257 "mdec-addr=%p", strerror(errno
), mdec
);
258 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
264 if (BT_LOG_ON_TRACE
) {
269 /* Save the file's position: we'll seek back to append the plain text */
272 if (mdec
->config
.keep_plain_text
) {
273 start_pos
= ftell(fp
);
276 /* Append the metadata text content */
277 ret
= ctf_scanner_append_ast(mdec
->scanner
, fp
);
279 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot create the metadata AST out of the metadata text: "
280 "mdec-addr=%p", mdec
);
281 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
285 /* We know it's complete: append plain text */
286 if (mdec
->config
.keep_plain_text
) {
287 BT_ASSERT(start_pos
!= -1);
288 ret
= fseek(fp
, start_pos
, SEEK_SET
);
290 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to seek file: ret=%d, mdec-addr=%p",
292 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
296 ret
= bt_common_append_file_content_to_g_string(mdec
->text
, fp
);
298 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to append to current plain text: "
299 "ret=%d, mdec-addr=%p", ret
, mdec
);
300 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
305 ret
= ctf_visitor_semantic_check(0, &mdec
->scanner
->ast
->root
,
308 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Validation of the metadata semantics failed: "
309 "mdec-addr=%p", mdec
);
310 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
314 if (mdec
->config
.create_trace_class
) {
315 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
,
316 &mdec
->scanner
->ast
->root
);
322 BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
323 "mdec-addr=%p", mdec
);
324 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
327 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to visit AST node to create CTF IR objects: "
328 "mdec-addr=%p, ret=%d", mdec
, ret
);
329 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
339 if (fp
&& close_fp
) {
341 BT_COMP_LOGE("Cannot close metadata file stream: "
342 "mdec-addr=%p", mdec
);
352 bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(
353 struct ctf_metadata_decoder
*mdec
)
356 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
357 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
361 struct ctf_trace_class
*ctf_metadata_decoder_borrow_ctf_trace_class(
362 struct ctf_metadata_decoder
*mdec
)
365 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
366 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);
370 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder
*mdec
)
373 BT_ASSERT_DBG(mdec
->config
.keep_plain_text
);
374 return mdec
->text
->str
;
378 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder
*mdec
)
385 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder
*mdec
,
392 if (!mdec
->is_uuid_set
) {
397 bt_uuid_copy(uuid
, mdec
->uuid
);
404 enum ctf_metadata_decoder_status
find_uuid_in_trace_decl(
405 struct ctf_metadata_decoder
*mdec
, struct ctf_node
*trace_node
,
408 enum ctf_metadata_decoder_status status
=
409 CTF_METADATA_DECODER_STATUS_OK
;
410 struct ctf_node
*entry_node
;
411 struct bt_list_head
*decl_list
= &trace_node
->u
.trace
.declaration_list
;
414 bt_list_for_each_entry(entry_node
, decl_list
, siblings
) {
415 if (entry_node
->type
== NODE_CTF_EXPRESSION
) {
418 left
= ctf_ast_concatenate_unary_strings(
419 &entry_node
->u
.ctf_expression
.left
);
421 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot concatenate unary strings.");
422 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
426 if (strcmp(left
, "uuid") == 0) {
427 ret
= ctf_ast_get_unary_uuid(
428 &entry_node
->u
.ctf_expression
.right
,
429 uuid
, mdec
->config
.log_level
,
430 mdec
->config
.self_comp
);
432 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid trace's `uuid` attribute.");
433 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
445 status
= CTF_METADATA_DECODER_STATUS_NONE
;
453 enum ctf_metadata_decoder_status
ctf_metadata_decoder_get_trace_class_uuid(
454 struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
456 enum ctf_metadata_decoder_status status
=
457 CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
458 struct ctf_node
*root_node
= &mdec
->scanner
->ast
->root
;
459 struct ctf_node
*trace_node
;
462 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
467 bt_list_entry(root_node
->u
.root
.trace
.next
,
468 struct ctf_node
, siblings
);
470 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
474 status
= find_uuid_in_trace_decl(mdec
, trace_node
, uuid
);