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>
26 #include "decoder.hpp"
27 #include "scanner.hpp"
28 #include "logging.hpp"
29 #include "parser-wrap.hpp"
30 #include "decoder-packetized-file-stream-to-buf.hpp"
32 #define TSDL_MAGIC 0x75d11d57
34 struct ctf_metadata_decoder
36 struct ctf_scanner
*scanner
;
38 struct ctf_visitor_generate_ir
*visitor
;
42 struct ctf_metadata_decoder_config config
;
43 struct meta_log_config log_cfg
;
44 bool has_checked_plaintext_signature
;
52 uint32_t content_size
;
54 uint8_t compression_scheme
;
55 uint8_t encryption_scheme
;
56 uint8_t checksum_scheme
;
59 } __attribute__((__packed__
));
61 int ctf_metadata_decoder_is_packetized(FILE *fp
, bool *is_packetized
, int *byte_order
,
62 bt_logging_level log_level
, bt_self_component
*self_comp
)
68 *is_packetized
= false;
69 len
= fread(&magic
, sizeof(magic
), 1, fp
);
72 BT_LOG_INFO
, log_level
, self_comp
,
73 "Cannot read first metadata packet header: assuming the stream is not packetized.");
79 if (magic
== TSDL_MAGIC
) {
80 *is_packetized
= true;
81 *byte_order
= BYTE_ORDER
;
82 } else if (magic
== GUINT32_SWAP_LE_BE(TSDL_MAGIC
)) {
83 *is_packetized
= true;
84 *byte_order
= BYTE_ORDER
== BIG_ENDIAN
? LITTLE_ENDIAN
: BIG_ENDIAN
;
94 struct ctf_metadata_decoder
*
95 ctf_metadata_decoder_create(const struct ctf_metadata_decoder_config
*config
)
97 struct ctf_metadata_decoder
*mdec
= g_new0(struct ctf_metadata_decoder
, 1);
100 BT_COMP_LOG_CUR_LVL(BT_LOG_DEBUG
, config
->log_level
, config
->self_comp
,
101 "Creating CTF metadata decoder: "
102 "clock-class-offset-s=%" PRId64
", "
103 "clock-class-offset-ns=%" PRId64
,
104 config
->clock_class_offset_s
, config
->clock_class_offset_ns
);
107 BT_COMP_LOG_CUR_LVL(BT_LOG_ERROR
, config
->log_level
, config
->self_comp
,
108 "Failed to allocate one CTF metadata decoder.");
112 mdec
->log_cfg
.log_level
= config
->log_level
;
113 mdec
->log_cfg
.self_comp
= config
->self_comp
;
114 mdec
->log_cfg
.self_comp_class
= config
->self_comp_class
;
115 mdec
->scanner
= ctf_scanner_alloc();
116 if (!mdec
->scanner
) {
117 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot allocate a metadata lexical scanner: "
123 mdec
->text
= g_string_new(NULL
);
125 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to allocate one GString: "
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: "
141 BT_COMP_LOGD("Creating CTF metadata decoder: "
142 "clock-class-offset-s=%" PRId64
", "
143 "clock-class-offset-ns=%" PRId64
", addr=%p",
144 config
->clock_class_offset_s
, config
->clock_class_offset_ns
, mdec
);
148 ctf_metadata_decoder_destroy(mdec
);
155 void ctf_metadata_decoder_destroy(struct ctf_metadata_decoder
*mdec
)
162 ctf_scanner_free(mdec
->scanner
);
166 g_string_free(mdec
->text
, TRUE
);
169 BT_COMP_LOGD("Destroying CTF metadata decoder: addr=%p", mdec
);
170 ctf_visitor_generate_ir_destroy(mdec
->visitor
);
174 enum ctf_metadata_decoder_status
175 ctf_metadata_decoder_append_content(struct ctf_metadata_decoder
*mdec
, FILE *fp
)
177 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
180 bool close_fp
= false;
185 ret
= ctf_metadata_decoder_is_packetized(fp
, &is_packetized
, &mdec
->bo
, mdec
->config
.log_level
,
186 mdec
->config
.self_comp
);
188 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
193 BT_COMP_LOGI("Metadata stream is packetized: mdec-addr=%p", mdec
);
194 ret
= ctf_metadata_decoder_packetized_file_stream_to_buf(
195 fp
, &buf
, mdec
->bo
, &mdec
->is_uuid_set
, mdec
->uuid
, mdec
->config
.log_level
,
196 mdec
->config
.self_comp
, mdec
->config
.self_comp_class
);
198 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
199 "Cannot decode packetized metadata packets to metadata text: "
200 "mdec-addr=%p, ret=%d",
202 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
206 if (strlen(buf
) == 0) {
207 /* An empty metadata packet is OK. */
211 /* Convert the real file pointer to a memory file pointer */
212 fp
= bt_fmemopen(buf
, strlen(buf
), "rb");
215 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Cannot memory-open metadata buffer: %s: "
217 strerror(errno
), mdec
);
218 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
221 } else if (!mdec
->has_checked_plaintext_signature
) {
222 unsigned int major
, minor
;
224 const long init_pos
= ftell(fp
);
226 BT_COMP_LOGI("Metadata stream is plain text: mdec-addr=%p", mdec
);
229 BT_COMP_LOGE_APPEND_CAUSE_ERRNO(BT_COMP_LOG_SELF_COMP
,
230 "Failed to get current file position", ".");
231 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
235 /* Check text-only metadata header and version */
236 nr_items
= fscanf(fp
, "/* CTF %10u.%10u", &major
, &minor
);
239 "Missing \"/* CTF major.minor\" signature in plain text metadata file stream: "
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
, minor
)) {
247 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
248 "Invalid metadata version found in plain text signature: "
249 "version=%u.%u, mdec-addr=%p",
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(
257 "Cannot seek metadata file stream to initial position: %s: "
259 strerror(errno
), mdec
);
260 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
264 mdec
->has_checked_plaintext_signature
= true;
268 if (BT_LOG_ON_TRACE
) {
273 /* Save the file's position: we'll seek back to append the plain text */
276 if (mdec
->config
.keep_plain_text
) {
277 start_pos
= ftell(fp
);
280 /* Append the metadata text content */
281 ret
= ctf_scanner_append_ast(mdec
->scanner
, fp
);
283 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
284 "Cannot create the metadata AST out of the metadata text: "
287 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
291 /* We know it's complete: append plain text */
292 if (mdec
->config
.keep_plain_text
) {
293 BT_ASSERT(start_pos
!= -1);
294 ret
= fseek(fp
, start_pos
, SEEK_SET
);
296 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to seek file: ret=%d, mdec-addr=%p",
298 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
302 ret
= bt_common_append_file_content_to_g_string(mdec
->text
, fp
);
304 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Failed to append to current plain text: "
305 "ret=%d, mdec-addr=%p",
307 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
312 ret
= ctf_visitor_semantic_check(0, &mdec
->scanner
->ast
->root
, &mdec
->log_cfg
);
314 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Validation of the metadata semantics failed: "
317 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
321 if (mdec
->config
.create_trace_class
) {
322 ret
= ctf_visitor_generate_ir_visit_node(mdec
->visitor
, &mdec
->scanner
->ast
->root
);
328 BT_COMP_LOGD("While visiting metadata AST: incomplete data: "
331 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
334 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE(
335 "Failed to visit AST node to create CTF IR objects: "
336 "mdec-addr=%p, ret=%d",
338 status
= CTF_METADATA_DECODER_STATUS_IR_VISITOR_ERROR
;
348 if (fp
&& close_fp
) {
350 BT_COMP_LOGE("Cannot close metadata file stream: "
361 bt_trace_class
*ctf_metadata_decoder_get_ir_trace_class(struct ctf_metadata_decoder
*mdec
)
364 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
365 return ctf_visitor_generate_ir_get_ir_trace_class(mdec
->visitor
);
368 struct ctf_trace_class
*
369 ctf_metadata_decoder_borrow_ctf_trace_class(struct ctf_metadata_decoder
*mdec
)
372 BT_ASSERT_DBG(mdec
->config
.create_trace_class
);
373 return ctf_visitor_generate_ir_borrow_ctf_trace_class(mdec
->visitor
);
376 const char *ctf_metadata_decoder_get_text(struct ctf_metadata_decoder
*mdec
)
379 BT_ASSERT_DBG(mdec
->config
.keep_plain_text
);
380 return mdec
->text
->str
;
383 int ctf_metadata_decoder_get_byte_order(struct ctf_metadata_decoder
*mdec
)
389 int ctf_metadata_decoder_get_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
395 if (!mdec
->is_uuid_set
) {
400 bt_uuid_copy(uuid
, mdec
->uuid
);
406 static enum ctf_metadata_decoder_status
find_uuid_in_trace_decl(struct ctf_metadata_decoder
*mdec
,
407 struct ctf_node
*trace_node
,
410 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_OK
;
411 struct ctf_node
*entry_node
;
412 struct bt_list_head
*decl_list
= &trace_node
->u
.trace
.declaration_list
;
415 bt_list_for_each_entry (entry_node
, decl_list
, siblings
) {
416 if (entry_node
->type
== NODE_CTF_EXPRESSION
) {
419 left
= ctf_ast_concatenate_unary_strings(&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(&entry_node
->u
.ctf_expression
.right
, uuid
,
428 mdec
->config
.log_level
, mdec
->config
.self_comp
);
430 _BT_COMP_OR_COMP_CLASS_LOGE_APPEND_CAUSE("Invalid trace's `uuid` attribute.");
431 status
= CTF_METADATA_DECODER_STATUS_ERROR
;
443 status
= CTF_METADATA_DECODER_STATUS_NONE
;
450 enum ctf_metadata_decoder_status
451 ctf_metadata_decoder_get_trace_class_uuid(struct ctf_metadata_decoder
*mdec
, bt_uuid_t uuid
)
453 enum ctf_metadata_decoder_status status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
454 struct ctf_node
*root_node
= &mdec
->scanner
->ast
->root
;
455 struct ctf_node
*trace_node
;
458 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
462 trace_node
= bt_list_entry(root_node
->u
.root
.trace
.next
, struct ctf_node
, siblings
);
464 status
= CTF_METADATA_DECODER_STATUS_INCOMPLETE
;
468 status
= find_uuid_in_trace_decl(mdec
, trace_node
, uuid
);